diff --git a/config/_default/config.toml b/config/_default/config.toml index d9796641b..cde9733ee 100644 --- a/config/_default/config.toml +++ b/config/_default/config.toml @@ -33,6 +33,7 @@ ignorefiles = [ ".*/_custom" ] ks_product_right = "KubeSphere " ks_product_both = " KubeSphere " ks_product_full = "KubeSphere" + ks_product-en = "KubeSphere" ks_product_ver = "v4.1" [security] @@ -157,7 +158,13 @@ name = "Documentation" hasChildren = true [[languages.en.menu.main]] parent = "Documentation" - name = "v3.4 star" + name = "v4.1 star" + URL = "/docs/v4.1" + weight = 42 + + [[languages.en.menu.main]] + parent = "Documentation" + name = "v3.4" URL = "/docs/v3.4" weight = 43 diff --git a/content/en/_ks_components-en/admonitions/admonEnd.adoc b/content/en/_ks_components-en/admonitions/admonEnd.adoc new file mode 100644 index 000000000..89cd94105 --- /dev/null +++ b/content/en/_ks_components-en/admonitions/admonEnd.adoc @@ -0,0 +1 @@ +|=== diff --git a/content/en/_ks_components-en/admonitions/note.adoc b/content/en/_ks_components-en/admonitions/note.adoc new file mode 100644 index 000000000..59a40555e --- /dev/null +++ b/content/en/_ks_components-en/admonitions/note.adoc @@ -0,0 +1,5 @@ +[.admon.note,cols="a"] +|=== +|Note + +| diff --git a/content/en/_ks_components-en/admonitions/tip.adoc b/content/en/_ks_components-en/admonitions/tip.adoc new file mode 100644 index 000000000..f88013035 --- /dev/null +++ b/content/en/_ks_components-en/admonitions/tip.adoc @@ -0,0 +1,5 @@ +[.admon.tip,cols="a"] +|=== +|Tip + +| \ No newline at end of file diff --git a/content/en/_ks_components-en/admonitions/warning.adoc b/content/en/_ks_components-en/admonitions/warning.adoc new file mode 100644 index 000000000..0159fcbe2 --- /dev/null +++ b/content/en/_ks_components-en/admonitions/warning.adoc @@ -0,0 +1,5 @@ +[.admon.warning,cols="a"] +|=== +|Warning + +| \ No newline at end of file diff --git a/content/en/_ks_components-en/bloc-ClusterManagementGuideGlossary.adoc b/content/en/_ks_components-en/bloc-ClusterManagementGuideGlossary.adoc new file mode 100755 index 000000000..1d94f013d --- /dev/null +++ b/content/en/_ks_components-en/bloc-ClusterManagementGuideGlossary.adoc @@ -0,0 +1,59 @@ +// :ks_include_id: b8d5e1c74e4a446384a0cc915298e456 + += 术语和缩略语link:[id=9b8564b2818b4de5b00fb81c1989a9e9] + +[role="glossary",cols="1a,5a,5a"] +|=== + +|API +|Application Programming Interface +|应用程序编程接口 + +|CPU +|Central Processing Unit +|中央处理器 + +|DNS +|Domain Name System +|域名系统 + +|GPU +|Graphics Processing Unit +|图形处理器 + +|gRPC +|gRPC Remote Procedure Calls +|gRPC 远端程序呼叫协议 + +|HTTP +|Hypertext Transfer Protocol +|超文本传输协议 + +|HTTPS +|Hypertext Transfer Protocol Secure +|超文本传输安全协议 + +|ID +|Identifier +|标识符 + +|IOPS +|Input/Output Operations Per Second +|每秒输入输出操作数 + +|IP +|Internet Protocol +|互联网协议 + +|QoS +|Quality of Service +|服务质量 + +|TLS +|Transport Layer Security +|传输层安全协议 + +|WAL +|Write Ahead Log +|预写日志 +|=== diff --git a/content/en/_ks_components-en/bloc-InstallationGuideGlossary.adoc b/content/en/_ks_components-en/bloc-InstallationGuideGlossary.adoc new file mode 100644 index 000000000..a6ca92be7 --- /dev/null +++ b/content/en/_ks_components-en/bloc-InstallationGuideGlossary.adoc @@ -0,0 +1,55 @@ +// :ks_include_id: 97d118168300404498cba8389b3a7499 + += 术语和缩略语link:[id=e7d3a8242fc340318d7c62a4b31260fc] + +[role="glossary",cols="1a,5a,5a"] +|=== + +|API +|Application Programming Interface +|应用程序编程接口 + +|CSI +|Container Storage Interface +|容器存储接口 + +|ID +|Identifier +|标识符 + +|IP +|Internet Protocol +|互联网协议 + +|NFS +|Network File System +|网络文件系统 + +|NIC +|Network Interface Card +|网络接口卡 + +|RBD +|Rados Block Device +|Rados 块设备 + +|SSH +|Secure Shell +|安全外壳协议 + +|TCP +|Transmission Control Protocol +|传输控制协议 + +|UDP +|User Datagram Protocol +|用户数据报协议 + +|URL +|Uniform Resource Locator +|统一资源定位符 + +|VIP +|Virtual Internet Protocol Address +|虚拟 IP 地址 +|=== diff --git a/content/en/_ks_components-en/bloc-ProjectManagementGuideGlossary.adoc b/content/en/_ks_components-en/bloc-ProjectManagementGuideGlossary.adoc new file mode 100755 index 000000000..19ca77587 --- /dev/null +++ b/content/en/_ks_components-en/bloc-ProjectManagementGuideGlossary.adoc @@ -0,0 +1,32 @@ +// :ks_include_id: c6c90ffe51d64b43a2d6226fdeda8dd3 + += 术语和缩略语link:[id=59c65fc0d22a405f8a01aee13b88b437] + +[role='glossary',cols='1a,5a,5a'] +|=== + +|CPU +|Central Processing Unit +|中央处理器 + +|HTTP +|Hypertext Transfer Protocol +|超文本传输协议 + +|IP +|Internet Protocol +|互联网协议 + +|JAR +|Java Archive +|Java 归档 + +|URL +|Uniform Resource Locator +|统一资源定位符 + +|WAR +|Web Application Archive +|Web 应用程序归档 +|=== + diff --git a/content/en/_ks_components-en/bloc-WorkspaceManagementGuideGlossary.adoc b/content/en/_ks_components-en/bloc-WorkspaceManagementGuideGlossary.adoc new file mode 100644 index 000000000..3db69195b --- /dev/null +++ b/content/en/_ks_components-en/bloc-WorkspaceManagementGuideGlossary.adoc @@ -0,0 +1,15 @@ +// :ks_include_id: c2039f04a78f4459a928dc18dd6833c8 + += 术语和缩略语link:[id=3472972bef064e318fd5269270643e79] + +[role='glossary',cols='1a,5a,5a'] +|=== + +|CPU +|Central Processing Unit +|中央处理器 + +|URL +|Uniform Resource Locator +|统一资源定位符 +|=== diff --git a/content/en/_ks_components-en/bloc-devopsManagementGuideGlossary.adoc b/content/en/_ks_components-en/bloc-devopsManagementGuideGlossary.adoc new file mode 100644 index 000000000..45727f84d --- /dev/null +++ b/content/en/_ks_components-en/bloc-devopsManagementGuideGlossary.adoc @@ -0,0 +1,55 @@ +// :ks_include_id: f74b6e7ec2b54e58893c8ba9fee38eb8 + += 术语和缩略语link:[id=429ec86a5f354f008e4a72c1dac37ef9] + +[role='glossary',cols='1a,5a,5a'] +|=== +|CD +|Continuous Deployment +|持续部署 + +|CI +|Continuous Integration +|持续集成 + +|ID +|Identifier +|标识符 + +|IP +|Internet Protocol +|互联网协议 + +|JAR +|Java Archive +|Java 归档 + +|JDK +|Java Development Kit +|Java 开发套件 + +|PR +|Pull Request +|拉取请求 + +|SCM +|Source Code Management +|源代码管理 + +|SMTP +|Simple Mail Transfer Protocol +|简单邮件传输协议 + +|SSH +|Secure Shell +|安全外壳协议 + +|SSL +|Secure Socket Layer +|安全套接层协议 + +|URL +|Uniform Resource Locator +|统一资源定位符 +|=== + diff --git a/content/en/_ks_components-en/bloc-pdfFrontMatter.adoc b/content/en/_ks_components-en/bloc-pdfFrontMatter.adoc new file mode 100644 index 000000000..6e2f84c02 --- /dev/null +++ b/content/en/_ks_components-en/bloc-pdfFrontMatter.adoc @@ -0,0 +1,81 @@ +// :ks_include_id: 38b33a724ea748e79d4810f7d9fed6dd + +:toc: macro +:toc-title: 目录 +:toclevels: 5 +:figure-caption!: +:sectnums: +:sectnumlevels: 5 + += {empty} + +[.top_left] +{ks_product_right}{ks_doc_type} + +[.bottom_left] +文档版本 01 + +[.bottom_center] +版权所有 © 北京青云科技股份有限公司 + +[.cover_product_logo] +-- +ifeval::["{ks_output_type}" == "md"] +image::/images/ks-qkcp/pdf/kubesphere-logo.svg[] +endif::[] +ifeval::["{ks_output_type}" == "pdf"] +image::/images/ks-qkcp/pdf/kubesphere-enterprise-logo.svg[] +endif::[] +-- + +[.cover_doc_image] +image::/images/ks-qkcp/pdf/cover_doc_image.svg[] + +[.cover_doc_name] +{ks_product} + +{ks_doc_type} + +[.cover_footer,cols="2a,1a"] +|=== + +| +[.cover_qc_logo] +image::/images/ks-qkcp/pdf/qingcloud-logo-color.png[] + +北京青云科技股份有限公司 + +| +文档版本：01 + +发布日期：{ks_release_date} + +|=== + +[.legal_info] +-- +版权所有 © 北京青云科技股份有限公司 {ks_year}。保留所有权利。 + +非经本公司书面许可，任何单位和个人不得摘抄、复制或以任何形式传播本文档的部分或全部内容。 + +{empty} + + +**商标声明** + +image:/images/ks-qkcp/pdf/qingcloud-logo-icon.png[qincloud-logo-icon,18,18] 和其他青云商标均由北京青云科技股份有限公司拥有。 + +本文档提及的其他商标或注册商标，由各自的所有人拥有。 + +{empty} + + +**注意** + +本文档描述的部分产品、服务和特性可能不在您的购买或使用范围之内，您购买的产品、服务或特性应受青云公司商业合同和条款的约束。 + +本文档内容会不定期进行更新。本文档仅作为使用指导，本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保。 + +{empty} + + +北京青云科技股份有限公司 + +网址：link:https://www.qingcloud.com[] +-- \ No newline at end of file diff --git a/content/en/_ks_components-en/bloc-platformManagementGuideGlossary.adoc b/content/en/_ks_components-en/bloc-platformManagementGuideGlossary.adoc new file mode 100644 index 000000000..6a4f36c1e --- /dev/null +++ b/content/en/_ks_components-en/bloc-platformManagementGuideGlossary.adoc @@ -0,0 +1,35 @@ +// :ks_include_id: f758182e5c684e5ba39019679fb97491 + += 术语和缩略语link:[id=0ee2fad5148241d3ba54758ec260b3d5] + +[role='glossary',cols='1a,5a,5a'] +|=== + +|API +|Application Programming Interface +|应用程序编程接口 + +|ID +|Identifier +|标识符 + +|IP +|Internet Protocol +|互联网协议 + +|SMTP +|Simple Mail Transfer Protocol +|简单邮件传输协议 + +|SSL +|Secure Socket Layer +|安全套接层协议 + +|TLS +|Transport Layer Security +|传输层安全协议 + +|URL +|Uniform Resource Locator +|统一资源定位符 +|=== diff --git a/content/en/_ks_components-en/bloc-radondbClickhouseManagementGuideGlossary.adoc b/content/en/_ks_components-en/bloc-radondbClickhouseManagementGuideGlossary.adoc new file mode 100644 index 000000000..836f240c0 --- /dev/null +++ b/content/en/_ks_components-en/bloc-radondbClickhouseManagementGuideGlossary.adoc @@ -0,0 +1,22 @@ +// :ks_include_id: 7b6a4a49214d4844b4f52db200abc0b9 + += 术语和缩略语link:[id=a4986b482c4e4954965443673a2c3101] + +[role='glossary',cols='1a,5a,5a'] +|=== +|CPU +|Central Processing Unit +|中央处理器 + +|HTTP +|Hypertext Transfer Protocol +|超文本传输协议 + +|IP +|Internet Protocol +|互联网协议 + +|TCP +|Transmission Control Protocol +|传输控制协议 +|=== diff --git a/content/en/_ks_components-en/bloc-sectionFrontMatter.adoc b/content/en/_ks_components-en/bloc-sectionFrontMatter.adoc new file mode 100644 index 000000000..1a247ed9c --- /dev/null +++ b/content/en/_ks_components-en/bloc-sectionFrontMatter.adoc @@ -0,0 +1,20 @@ +// :ks_include_id: 63fbc621a65f4bf38d109b72a71cf170 + + +ifeval::["{ks_output_type}" == "md"] +[subs=attributes] +++++ +--- +title: "{ks_title}" +linkTitle: "{ks_title}" +keywords: "{ks_keywords}" +description: "{ks_description}" +weight: {ks_weight} +layout: "second" +icon: "{ks_icon}" +--- +++++ +endif::[] +ifeval::["{ks_output_type}" == "pdf"] += {ks_title}link:[id={ks_xref_id}] +endif::[] diff --git a/content/en/_ks_components-en/bloc-springcloudManagementGuideGlossary.adoc b/content/en/_ks_components-en/bloc-springcloudManagementGuideGlossary.adoc new file mode 100644 index 000000000..24fdbcf22 --- /dev/null +++ b/content/en/_ks_components-en/bloc-springcloudManagementGuideGlossary.adoc @@ -0,0 +1,31 @@ +// :ks_include_id: a01602c836d8452bad7f89c2081e09f6 + += 术语和缩略语link:[id=9dfab7e9e67a4ae9929c1ad0214772be] + +[role="glossary",cols="1a,5a,5a"] +|=== + +|CPU +|Central Processing Unit +|中央处理器 + +|GPU +|Graphics Processing Unit +|图形处理器 + +|HTTP +|Hypertext Transfer Protocol +|超文本传输协议 + +|HTTPS +|Hypertext Transfer Protocol Secure +|超文本传输安全协议 + +|ID +|Identifier +|标识符 + +|IP +|Internet Protocol +|互联网协议 +|=== diff --git a/content/en/_ks_components-en/code/bash.adoc b/content/en/_ks_components-en/code/bash.adoc new file mode 100644 index 000000000..4855f31e9 --- /dev/null +++ b/content/en/_ks_components-en/code/bash.adoc @@ -0,0 +1,2 @@ +[source,shell,subs="+attributes"] +---- diff --git a/content/en/_ks_components-en/code/go.adoc b/content/en/_ks_components-en/code/go.adoc new file mode 100644 index 000000000..3a1f905b9 --- /dev/null +++ b/content/en/_ks_components-en/code/go.adoc @@ -0,0 +1,2 @@ +[source,go,subs="+attributes"] +---- \ No newline at end of file diff --git a/content/en/_ks_components-en/code/html.adoc b/content/en/_ks_components-en/code/html.adoc new file mode 100644 index 000000000..bcfc6283e --- /dev/null +++ b/content/en/_ks_components-en/code/html.adoc @@ -0,0 +1,2 @@ +[source,html,subs="+attributes"] +---- diff --git a/content/en/_ks_components-en/code/javascript.adoc b/content/en/_ks_components-en/code/javascript.adoc new file mode 100644 index 000000000..a5c8d3bb8 --- /dev/null +++ b/content/en/_ks_components-en/code/javascript.adoc @@ -0,0 +1,2 @@ +[source,javascript,subs="+attributes"] +---- diff --git a/content/en/_ks_components-en/code/json.adoc b/content/en/_ks_components-en/code/json.adoc new file mode 100644 index 000000000..9564359b3 --- /dev/null +++ b/content/en/_ks_components-en/code/json.adoc @@ -0,0 +1,2 @@ +[source,json,subs="+attributes"] +---- diff --git a/content/en/_ks_components-en/code/yaml.adoc b/content/en/_ks_components-en/code/yaml.adoc new file mode 100644 index 000000000..c68b6e26f --- /dev/null +++ b/content/en/_ks_components-en/code/yaml.adoc @@ -0,0 +1,2 @@ +[source,yaml,subs="+attributes"] +---- diff --git a/content/en/_ks_components-en/oper-Autorefresh.adoc b/content/en/_ks_components-en/oper-Autorefresh.adoc new file mode 100644 index 000000000..2f6c9bf31 --- /dev/null +++ b/content/en/_ks_components-en/oper-Autorefresh.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: ec0f4321f3a8496cb29e4a605d5d28bc +* Click image:/images/ks-qkcp/zh/icons/start-dark.svg[start,18,18]/image:/images/ks-qkcp/zh/icons/pause.svg[pause,18,18] in the upper right corner to enable/disable real-time data refresh. \ No newline at end of file diff --git a/content/en/_ks_components-en/oper-clickCreate.adoc b/content/en/_ks_components-en/oper-clickCreate.adoc new file mode 100644 index 000000000..cb506fa05 --- /dev/null +++ b/content/en/_ks_components-en/oper-clickCreate.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d183e3529a4d49b0b7a05f96151355c1 +. Click **Create** on the page. \ No newline at end of file diff --git a/content/en/_ks_components-en/oper-clickInvite.adoc b/content/en/_ks_components-en/oper-clickInvite.adoc new file mode 100644 index 000000000..e58fb1986 --- /dev/null +++ b/content/en/_ks_components-en/oper-clickInvite.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 09975a5d93ed49ddb6c7c3b42ec274f7 +. Click **Invite** on the right side of the page. \ No newline at end of file diff --git a/content/en/_ks_components-en/oper-customizeColumns.adoc b/content/en/_ks_components-en/oper-customizeColumns.adoc new file mode 100644 index 000000000..878598f3f --- /dev/null +++ b/content/en/_ks_components-en/oper-customizeColumns.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 42b64c64491a4e459b1d34958715d6f8 +* Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper right corner of the list to customize the information displayed in the list. diff --git a/content/en/_ks_components-en/oper-navigate.adoc b/content/en/_ks_components-en/oper-navigate.adoc new file mode 100644 index 000000000..a52ff79b9 --- /dev/null +++ b/content/en/_ks_components-en/oper-navigate.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: b773f29ad54e4ebd84187b0924c41f21 +. Click pass:a,q[{ks_navigation}] in the left navigation pane. diff --git a/content/en/_ks_components-en/oper-refreshData.adoc b/content/en/_ks_components-en/oper-refreshData.adoc new file mode 100644 index 000000000..4befb5c4d --- /dev/null +++ b/content/en/_ks_components-en/oper-refreshData.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 4bba5db43c504475853edcfabbcf5652 +* Click image:/images/ks-qkcp/zh/icons/refresh-dark.svg[refresh,18,18] in the upper right corner to refresh data manually. \ No newline at end of file diff --git a/content/en/_ks_components-en/oper-refreshListData.adoc b/content/en/_ks_components-en/oper-refreshListData.adoc new file mode 100644 index 000000000..6c57119d4 --- /dev/null +++ b/content/en/_ks_components-en/oper-refreshListData.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 28a65f11229c45f0bcd1b632d006acbb +* Click image:/images/ks-qkcp/zh/icons/refresh-light.svg[refresh,18,18] in the upper right corner of the list to refresh the list information. diff --git a/content/en/_ks_components-en/oper-selectMenu.adoc b/content/en/_ks_components-en/oper-selectMenu.adoc new file mode 100644 index 000000000..35cd3468d --- /dev/null +++ b/content/en/_ks_components-en/oper-selectMenu.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: f19343cbb46b40ed9e124afde952b084 +. Select pass:a,q[{ks_menu}] in the upper left corner of the page. \ No newline at end of file diff --git a/content/en/_ks_components-en/oper-selectTimeRange.adoc b/content/en/_ks_components-en/oper-selectTimeRange.adoc new file mode 100644 index 000000000..2ac8a0822 --- /dev/null +++ b/content/en/_ks_components-en/oper-selectTimeRange.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9a5774e5ba9d4e5d950143cba4a5111d +* Click image:/images/ks-qkcp/zh/icons/timed-task.svg[timed-task,18,18] in the upper right corner to set the time range. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/alerts/alerts-desc-viewAnAlertingMessageList.adoc b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-desc-viewAnAlertingMessageList.adoc new file mode 100644 index 000000000..e4c3a15f3 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-desc-viewAnAlertingMessageList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 7a00832787eb484492170688816b225c +本节介绍如何查看告警列表。 diff --git a/content/en/docs/_custom-en/clusterManagement/alerts/alerts-oper-openListPage.adoc b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-oper-openListPage.adoc new file mode 100644 index 000000000..d5e42f5ee --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: a11cb13f4c4d44e59332bb4fe44859c0 +. 在**告警**页面点击**来源于自定义规则**或**来源于内置规则**打开告警列表。 diff --git a/content/en/docs/_custom-en/clusterManagement/alerts/alerts-oper-searchForAlertingMessages.adoc b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-oper-searchForAlertingMessages.adoc new file mode 100644 index 000000000..c6d692274 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-oper-searchForAlertingMessages.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c6a3057001e24f3d85a69f8429cf509c +* 在列表上方点击搜索框并设置搜索条件，可按告警状态、告警级别和规则名称搜索告警。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/alerts/alerts-oper-searchForAlertingMessages_new.adoc b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-oper-searchForAlertingMessages_new.adoc new file mode 100644 index 000000000..1a61ccc82 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-oper-searchForAlertingMessages_new.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c6a3057001e24f3d85a69f8429cf509c +* 在列表上方点击搜索框并设置搜索条件，可按告警内容、告警状态、告警级别和规则名称搜索告警。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/alerts/alerts-para-alertingMessageList.adoc b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-para-alertingMessageList.adoc new file mode 100644 index 000000000..f0c465342 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-para-alertingMessageList.adoc @@ -0,0 +1,36 @@ +// :ks_include_id: 9bb30ff8148c403aa266fbe96dcaa2a8 +* 告警列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|消息 +| +include::../ruleGroups/ruleGroups-para-message.adoc[] + +|状态 +| +告警当前的状态。 + +include::alerts-para-alertingStatus.adoc[] + +|告警级别 +| +include::../ruleGroups/ruleGroups-para-alertLevel.adoc[] + +|规则名称 +|告警规则的名称。 + +|规则组 +|告警规则组的名称。 + +|监控目标 +|生成告警的监控目标的类型和名称。 + +|触发时间 +| +include::../ruleGroups/ruleGroups-para-activationTime.adoc[] +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/alerts/alerts-para-alertingStatus.adoc b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-para-alertingStatus.adoc new file mode 100644 index 000000000..6ecb50241 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/alerts/alerts-para-alertingStatus.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: eb9742b579e948b29be0240b89d9335b +* **验证中**：监控指标满足预设的条件，但未满足预设的持续时间。 + +* **已触发**：监控指标满足预设的条件，并且满足预设的持续时间。 diff --git a/content/en/docs/_custom-en/clusterManagement/clusterManagement-desc-configuration.adoc b/content/en/docs/_custom-en/clusterManagement/clusterManagement-desc-configuration.adoc new file mode 100644 index 000000000..085a4992c --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/clusterManagement-desc-configuration.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 156b3180d19240238f9195fd4cc024c5 +This section explains how to manage configuration resources. + +KubeSphere supports managing the following three types of configuration resources: + +* Secret: Contains Base64-encoded key-value pairs, used to store sensitive data such as passwords, tokens, and keys. + +* ConfigMap: Contains plain-text key-value pairs, used to store regular configuration data. + +* Service Account: Stores access information for the current KubeSphere cluster, used to provide access to the KubeSphere cluster for applications. diff --git a/content/en/docs/_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc b/content/en/docs/_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc new file mode 100644 index 000000000..dae2eb081 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: ac11303d404249078087f1c605445e15 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission, and access your cluster. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/clusterManagement-para-eventsTab.adoc b/content/en/docs/_custom-en/clusterManagement/clusterManagement-para-eventsTab.adoc new file mode 100644 index 000000000..786b46170 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/clusterManagement-para-eventsTab.adoc @@ -0,0 +1,20 @@ +// :ks_include_id: 28089246770746498a85c468382fdb76 +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Type +|The type of the event, including **Normal** and **Warning**. + +|Reason +|The reason for the event. + +|Occurred +|The time when the event occurred. + +|Source +|The component that reported the event. + +|Message +|The content of the event message. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc b/content/en/docs/_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc new file mode 100644 index 000000000..c3af2cb9a --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc @@ -0,0 +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 diff --git a/content/en/docs/_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc b/content/en/docs/_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc new file mode 100644 index 000000000..29bd14fb4 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: f3341457c4584e59b799240a35ca496d +You should join a cluster and have the pass:a,q[{ks_permission}] permission within the cluster. For more information, refer to "Cluster Members" and "Cluster Roles". diff --git a/content/en/docs/_custom-en/clusterManagement/clusterMembers/clusterMembers-desc-initialClusterAdmin.adoc b/content/en/docs/_custom-en/clusterManagement/clusterMembers/clusterMembers-desc-initialClusterAdmin.adoc new file mode 100644 index 000000000..ddb6224f8 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/clusterMembers/clusterMembers-desc-initialClusterAdmin.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 498ec63e8fb645ccab190e0595b053f8 +In a multi-cluster environment, the user who adds a cluster is automatically designated as the cluster administrator. Additionally, the **admin** user by default has full permissions in all clusters. In the initial state of a cluster, the aforementioned users can invite other users to join the cluster and set the roles for these users within the cluster. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/clusterMembers/clusterMembers-para-presetClusterRoles.adoc b/content/en/docs/_custom-en/clusterManagement/clusterMembers/clusterMembers-para-presetClusterRoles.adoc new file mode 100644 index 000000000..b7d5783f4 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/clusterMembers/clusterMembers-para-presetClusterRoles.adoc @@ -0,0 +1,13 @@ +// :ks_include_id: 8fa15cb04f8048cfa5479d1a77ddf099 +KubeSphere provides the following built-in cluster roles: + +[%header,cols="1a,4a"] +|=== +| Role | Description + +| cluster-admin +| Cluster administrator with all permissions within the cluster except creating and deleting clusters. + +| cluster-viewer +| Cluster viewer with permissions to view all resources within the cluster. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/clusterMembers/clusterMembers-para-userStatus.adoc b/content/en/docs/_custom-en/clusterManagement/clusterMembers/clusterMembers-para-userStatus.adoc new file mode 100644 index 000000000..fcdf51985 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/clusterMembers/clusterMembers-para-userStatus.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 431b5c3a6af541aa9bf2e1607c05789d +* **Active**: The user's current status is normal. + +* **Waiting**: The system is creating the user. + +* **Disabled**: The user is disabled by the platform administrator and cannot log in to the {ks_product-en} web console. + +* **Restricted**: The user has failed to log in 10 times in 10 minutes and is blocked from logging in to the {ks_product-en} web console for 10 minutes. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/clusterRoles/clusterRoles-para-authorizedUsers.adoc b/content/en/docs/_custom-en/clusterManagement/clusterRoles/clusterRoles-para-authorizedUsers.adoc new file mode 100644 index 000000000..b5ab35ab5 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/clusterRoles/clusterRoles-para-authorizedUsers.adoc @@ -0,0 +1,16 @@ +// :ks_include_id: 532573492da34fcbb954ea832aa9fcd5 +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Username +|Name of the user who has been authorized. + +|Status +|Current status of the user who has been authorized. + +include::../clusterMembers/clusterMembers-para-userStatus.adoc[] + +|Last Login +|The user's last login time on the {ks_product-en} platform. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/clusterStatus/clusterStatus-oper-exportJsonData.adoc b/content/en/docs/_custom-en/clusterManagement/clusterStatus/clusterStatus-oper-exportJsonData.adoc new file mode 100644 index 000000000..eb3bd32d2 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/clusterStatus/clusterStatus-oper-exportJsonData.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c545dcba1c5d46908a87e91f9fc37f77 +* 在列表右上角点击**导出**可下载 JSON 格式的资源用量数据。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/clusterStatus/clusterStatus-oper-sortAscendingDescending.adoc b/content/en/docs/_custom-en/clusterManagement/clusterStatus/clusterStatus-oper-sortAscendingDescending.adoc new file mode 100644 index 000000000..67e6651f1 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/clusterStatus/clusterStatus-oper-sortAscendingDescending.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 3a85d5dfa0a2462c87c54f9779cfbdc6 +* 在列表左上角点击image:/images/ks-qkcp/zh/icons/sort-ascending.svg[sort-ascending,18,18]/image:/images/ks-qkcp/zh/icons/sort-descending.svg[sort-descending,18,18]可按升序/降序排序。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-configmaps.adoc b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-configmaps.adoc new file mode 100644 index 000000000..be1c1d87b --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-configmaps.adoc @@ -0,0 +1,3 @@ +This section explains how to manage ConfigMaps. + +ConfigMaps store non-sensitive data, such as environment variables, command-line parameters, and configuration files, in key-value pairs. ConfigMaps allow users to separate containers from configuration data, making it easier to manage configurations and ensure the portability of applications. diff --git a/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-createAConfigmap.adoc b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-createAConfigmap.adoc new file mode 100644 index 000000000..7d27c2908 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-createAConfigmap.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9207e2fe36e84eb6bffadb973c32ac47 +This section explains how to create ConfigMaps. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-deleteConfigmaps.adoc b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-deleteConfigmaps.adoc new file mode 100644 index 000000000..1923d66ba --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-deleteConfigmaps.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 7758d91595c844e4b4614bb148e72c76 +This section explains how to delete a ConfigMap. + +// Warning +include::../../../../_ks_components-en/admonitions/warning.adoc[] + +Once a ConfigMap is deleted, it cannot be recovered. Please proceed with caution when performing this operation. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-editConfigmapInformation.adoc b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-editConfigmapInformation.adoc new file mode 100644 index 000000000..ad07165d0 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-editConfigmapInformation.adoc @@ -0,0 +1,3 @@ +This section explains how to edit ConfigMap information. + +You can edit the alias and description of the ConfigMap. KubeSphere does not support editing the name of an already created ConfigMap. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-editConfigmapSettings.adoc b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-editConfigmapSettings.adoc new file mode 100644 index 000000000..c78445c3a --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-editConfigmapSettings.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 1c55971dc47241c0916ca8bb7a0877b2 +This section explains how to edit the data of a ConfigMap. diff --git a/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-viewAConfigmapList.adoc b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-viewAConfigmapList.adoc new file mode 100644 index 000000000..f31899ad5 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-viewAConfigmapList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 25de9a77f93843dfb3408a738abd70c2 +This section explains how to view the list of ConfigMaps. diff --git a/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-viewConfigmapDetails.adoc b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-viewConfigmapDetails.adoc new file mode 100644 index 000000000..40637d6f7 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-desc-viewConfigmapDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 1ca4dafa438c4ae7850540566a7de0e5 +This section explains how to view ConfigMap details. diff --git a/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-createAConfigmap.adoc b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-createAConfigmap.adoc new file mode 100644 index 000000000..2a0ea6869 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-createAConfigmap.adoc @@ -0,0 +1,28 @@ +. On the **Basic Information** tab, set the basic information for the ConfigMap, and then click **Next**. ++ +-- +[%header,cols="1,4"] +|=== +| Parameter | Description + +| Name +| The name of the ConfigMap. The name can only contain lowercase letters, numbers, and hyphens (-), must start and end with a lowercase letter or number, and can be up to 63 characters long. + +| Alias +| The alias of the ConfigMap. Aliases can be the same for different ConfigMaps. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), cannot start or end with a hyphen (-), and can be up to 63 characters long. + +| Project +| The project to which the ConfigMap belongs. + +| Description +| The description of the ConfigMap. The description can contain any characters and can be up to 256 characters long. +|=== +-- + +. On the **Data Settings** tab, set the key-value pair data for the ConfigMap, then click **Create**. ++ +-- +include::../secrets/secrets-para-data.adoc[] + +Once created, the ConfigMap will be displayed in the ConfigMap list. +-- diff --git a/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-deleteASingleConfigmap.adoc b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-deleteASingleConfigmap.adoc new file mode 100644 index 000000000..8c62119e7 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-deleteASingleConfigmap.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 971bac7a7fb84650bc6d4d9712a6b6b3 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the ConfigMap you want to delete, then choose **Delete** from the dropdown list. + +. In the **Delete ConfigMap** dialog, enter the name of the ConfigMap, then click **OK**. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-deleteMultipleConfigmaps.adoc b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-deleteMultipleConfigmaps.adoc new file mode 100644 index 000000000..ea9deec68 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-deleteMultipleConfigmaps.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 7120cca5f1fc4d69be0d4be24670e48b +. Select the checkbox on the left of the ConfigMaps you want to delete, then click **Delete** above the ConfigMap list. + +. In the **Delete Multiple ConfigMaps** dialog, enter the name of the ConfigMaps, then click **OK**. ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-editConfigmapInformation.adoc b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-editConfigmapInformation.adoc new file mode 100644 index 000000000..0061fdb4c --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-editConfigmapInformation.adoc @@ -0,0 +1,16 @@ +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the ConfigMap you want to edit, then choose **Edit Information** from the dropdown list. + +. In the **Edit Information** dialog, set the alias and description for the ConfigMap, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Alias +| The alias of the ConfigMap. Aliases can be the same for different ConfigMaps. An alias can only contain Chinese characters, letters, numbers, and hyphens (-). It cannot start or end with a hyphen (-) and has a maximum length of 63 characters. + +| Description +| The description of the ConfigMap. The description can contain any characters, with a maximum length of 256 characters. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-editConfigmapSettings.adoc b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-editConfigmapSettings.adoc new file mode 100644 index 000000000..6f663c213 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-editConfigmapSettings.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 713230cd132746e194d0cad61dade1d9 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the ConfigMap you want to edit, then choose **Edit Settings** from the dropdown list. + +. In the **Edit Settings** dialog, set the data for the ConfigMap, then click **OK**. ++ +-- +include::../secrets/secrets-para-data.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-openDetailsPage.adoc new file mode 100644 index 000000000..bce27596d --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 4b348a728ca04df6ae2deda14d323b4c +. Click the name of a ConfigMap in the list to open its details page. diff --git a/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-searchForConfigmaps.adoc b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-searchForConfigmaps.adoc new file mode 100644 index 000000000..e98d6f0ba --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-searchForConfigmaps.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: cb26ec7cf74d406f97f87eb302012018 +* Click the search box at the top of the list to search for ConfigMaps by name. diff --git a/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-viewConfigmapDetails.adoc b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-viewConfigmapDetails.adoc new file mode 100644 index 000000000..824b6ce72 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-oper-viewConfigmapDetails.adoc @@ -0,0 +1,22 @@ +. View the resource attributes of the ConfigMap in the **Attributes** area on the left side of the ConfigMap details page. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Cluster +| The cluster to which the ConfigMap belongs. + +| Project +| The project to which the ConfigMap belongs. + +| Creation Time +| The creation time of the ConfigMap. + +| Creator +| The user who created the ConfigMap. +|=== +-- + +. On the **Data** tab on the right side of the ConfigMap details page, view the key-value pair data stored in the ConfigMap. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-para-configmapList.adoc b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-para-configmapList.adoc new file mode 100644 index 000000000..0a5054eb6 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-para-configmapList.adoc @@ -0,0 +1,20 @@ +* The ConfigMaps list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Name +| The name and description of the ConfigMap. + +| Project +| The project to which the ConfigMap belongs. + +| Fields +|The key name of the key-value pair data stored in the ConfigMap. Different keys are separated by a comma (,). + +| Creation Time +|The creation time of the ConfigMap. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-para-configmapList_new.adoc b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-para-configmapList_new.adoc new file mode 100644 index 000000000..fa69e3af2 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/configmaps/configmaps-para-configmapList_new.adoc @@ -0,0 +1,20 @@ +* The ConfigMaps list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Name +| The name and description of the ConfigMap. + +// | Project +// | The project to which the ConfigMap belongs. + +| Fields +|The key name of the key-value pair data stored in the ConfigMap. Different keys are separated by a comma (,). + +| Creation Time +|The creation time of the ConfigMap. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/crds/crds-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/clusterManagement/crds/crds-oper-openDetailsPage.adoc new file mode 100644 index 000000000..e94d3eb7a --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/crds/crds-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 58f8c216756e41e8976edccd0d0fe3be +. Click the name of a custom resource definition in the list to open its details page. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/crds/crds-para-scope.adoc b/content/en/docs/_custom-en/clusterManagement/crds/crds-para-scope.adoc new file mode 100644 index 000000000..5196e5467 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/crds/crds-para-scope.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 6c86123b72d442d2af494a87b1b826cf +The scope of custom resources created by custom resource definitions: + +* **Namespaced**: Custom resources created by custom resource definitions belong to a specific project. + +* **Cluster**: Custom resources created by custom resource definitions belong to the entire cluster. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-createACustomMonitoringDashboard.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-createACustomMonitoringDashboard.adoc new file mode 100644 index 000000000..0ced96155 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-createACustomMonitoringDashboard.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 09ffce0603e5476d9b35342407c90402 +本节介绍如何创建自定义监控面板。 diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-customMonitoringDashboards.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-customMonitoringDashboards.adoc new file mode 100644 index 000000000..62f06c64f --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-customMonitoringDashboards.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 3f3c9d810bbb43449843917a945b0d18 +本节介绍如何使用自定义监控面板。 diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-deleteCustomMonitoringDashboards.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-deleteCustomMonitoringDashboards.adoc new file mode 100644 index 000000000..43d197b4f --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-deleteCustomMonitoringDashboards.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: ebf1355e06284d8a8c1f0d1c6ae2dcdf +本节介绍如何删除自定义监控面板。 + +// Warning +include::../../../../_ks_components-en/admonitions/warning.adoc[] + +自定义监控面板删除后无法恢复，请谨慎执行此操作。 + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-editACustomMonitoringDashboard.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-editACustomMonitoringDashboard.adoc new file mode 100644 index 000000000..bf95ed4c1 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-editACustomMonitoringDashboard.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 0a4f15a804bd4a04b35fa4baec7bca69 +本节介绍如何编辑自定义监控面板。 diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-exposeMetrics.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-exposeMetrics.adoc new file mode 100644 index 000000000..bb4ddd2d5 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-exposeMetrics.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: fb5da34edef1455388ca60e23308095f +. 配置运行在容器中的应用程序，将符合 Prometheus 规范的监控指标暴露在某个服务端路径下。有关更多信息，请参阅 link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus 官方文档]。 + +. 在 KubeSphere Web 控制台，在用于暴露工作负载的服务上设置监控导出器，以声明提供应用程序监控指标的路径。KubeSphere 将根据监控导出器的相关参数获取应用程序的监控指标。 diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-howToUse.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-howToUse.adoc new file mode 100644 index 000000000..466ca8c63 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-howToUse.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 86dce4cf97db45baa0af638a00a5a435 +KubeSphere 支持通过自定义监控面板对应用程序的运行状态进行监控。您可以通过以下方式使用自定义监控面板： diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-viewACustomMonitoringDashboard.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-viewACustomMonitoringDashboard.adoc new file mode 100644 index 000000000..f3255c3d1 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-viewACustomMonitoringDashboard.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 459d38d3365247858833ed44c54b075d +本节介绍如何查看自定义监控面板。 diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-createACustomMonitoringDashboard.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-createACustomMonitoringDashboard.adoc new file mode 100644 index 000000000..1b2743aae --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-createACustomMonitoringDashboard.adoc @@ -0,0 +1,42 @@ +// :ks_include_id: 5b3a15eedffe4ef39e6a46e6adc2b335 +. 在**创建自定义监控面板**对话框，设置监控面板的名称、描述和模板，然后点击**下一步**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|自定义监控面板的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 + +|描述 +|自定义监控面板的描述信息。描述可包含任意字符，最长 256 个字符。 + +|模板 +|自定义监控面板的模板。 + +* KubeSphere 提供预置了 Elasticsearch、MySQL、Redis、Jenkins 和 GPU 自定义监控面板的模板。每个模板都提供了一些预置的监控指标和监控图，您可以在模板的基础上进行定制以减少操作。 + +* 如需使用 Grafana 监控面板，您需要上传 Grafana 监控面板配置文件。 + +* 您也可以使用选择**自定义**使用空模板。 +|=== +-- + +. 在自定义监控面板编辑页面，根据需要设置监控图和以文本显示的监控指标。 ++ +==== +* 在页面左侧点击image:/images/ks-qkcp/zh/icons/add-dark.svg[add-dark,18,18]，设置指标参数，然后点击image:/images/ks-qkcp/zh/icons/check-dark.svg[check-dark,18,18]可创建以文本显示的监控指标。 ++ +-- +include::customMonitoringDashboards-para-textMetric.adoc[] +-- + +* 在页面右下角点击**添加监控项**，选择**折线图**或**柱状图**，设置图表参数，然后点击image:/images/ks-qkcp/zh/icons/check-dark.svg[check-dark,18,18]可创建监控图。 ++ +-- +include::customMonitoringDashboards-para-monitoringChart.adoc[] +-- +==== + +. 在页面右上角点击**保存模板**。监控面板创建完成后将显示在自定义监控面板列表中。 diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteASingleCustomMonitoringDashboard.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteASingleCustomMonitoringDashboard.adoc new file mode 100644 index 000000000..b8b84215a --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteASingleCustomMonitoringDashboard.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 91f54871ad6f447eaca67f6b1853872e +. 在需要删除的自定义监控面板右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除自定义监控面板**对话框，输入自定义监控面板的名称，然后点击**确定**。 diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteMultipleCustomMonitoringDashboards.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteMultipleCustomMonitoringDashboards.adoc new file mode 100644 index 000000000..091db3ab2 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteMultipleCustomMonitoringDashboards.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: da77b27e5b9840dab0503615aec625a4 +. 选择需要删除的自定义监控面板左侧的复选框，然后在自定义监控面板列表上方点击**删除**。 + +. 在**批量删除自定义监控面板**对话框，输入自定义监控面板的名称，然后点击**确定**。 ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editACustomMonitoringDashboard.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editACustomMonitoringDashboard.adoc new file mode 100644 index 000000000..d495236aa --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editACustomMonitoringDashboard.adoc @@ -0,0 +1,32 @@ +// :ks_include_id: 1762c0ce44e445d89cd9f2e5b34055fa +. 在列表中点击一个自定义监控面板的名称打开自定义监控面板，然后在页面右上角点击**编辑模板**。 + +. 在页面左侧设置以文本显示的监控指标。 ++ +==== +* 点击image:/images/ks-qkcp/zh/icons/add-dark.svg[add-dark,18,18]可添加监控指标。 ++ +-- +include::customMonitoringDashboards-para-textMetric.adoc[] +-- + +* 将光标悬停在监控指标上，然后点击image:/images/ks-qkcp/zh/icons/trash-dark.svg[trash-dark,18,18]可删除监控指标。 + +* 将光标悬停在监控指标上，然后点击image:/images/ks-qkcp/zh/icons/pen-dark.svg[pen-dark,18,18]可编辑监控指标。 +==== + +. 在页面右侧的监控图列表设置监控图。 ++ +==== +* 点击**添加监控项**可添加监控图。 ++ +-- +include::customMonitoringDashboards-para-monitoringChart.adoc[] +-- + +* 将光标悬停在监控图名称上，然后点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除监控图。 + +* 将光标悬停在监控图名称上，然后点击image:/images/ks-qkcp/zh/icons/pen-light.svg[pen-light,18,18]可编辑监控图。 +==== + +. 在页面右上角点击**保存模板**完成编辑。 diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editCustomMonitoringDashboardInformation.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editCustomMonitoringDashboardInformation.adoc new file mode 100644 index 000000000..e2748e99f --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editCustomMonitoringDashboardInformation.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: f41b68cc492640acadc07b371d665ebb +. 在需要操作的自定义监控面板右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置自定义监控面板的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|自定义监控面板的别名。不同自定义监控面板的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|自定义监控面板的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-useCustomMonitoringDashboard.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-useCustomMonitoringDashboard.adoc new file mode 100644 index 000000000..e788a4297 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-useCustomMonitoringDashboard.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: b79841529a1d49a19e7e17eac5decf19 +. 在 KubeSphere Web 控制台，使用监控指标创建自定义监控面板，从而对应用程序的运行状况进行监控。 diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-viewACustomMonitoringDashboard.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-viewACustomMonitoringDashboard.adoc new file mode 100644 index 000000000..528242561 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-viewACustomMonitoringDashboard.adoc @@ -0,0 +1,18 @@ +// :ks_include_id: d52d25b1598e4adb94ab8b79c98a1e00 +. 在列表中点击一个自定义监控面板的名称打开监控面板。 ++ +-- +* 在页面左侧区域可查看以文本显示的监控指标。 + +* 在页面中间区域可查看监控指标折线图或柱状图。 + +* 在页面右侧点击image:/images/ks-qkcp/zh/icons/chevron-right.svg[chevron-right,18,18]可查看每个监控指标的子指标及其在指定时间范围内的最大值、最小值、平均值和最后采样值。 + +* 在页面上方点击image:/images/ks-qkcp/zh/icons/theme.svg[theme,18,18]可切换浅色和深色主题。 + +* 在页面上方点击image:/images/ks-qkcp/zh/icons/calendar-dark.svg[calendar-dark,18,18]可设置数据的时间范围。 + +* 在页面上方点击image:/images/ks-qkcp/zh/icons/refresh-dark.svg[refresh-dark,18,18]可设置数据的刷新间隔。 + +* 在页面右上角点击image:/images/ks-qkcp/zh/icons/close-dark.svg[close,18,18]可返回自定义监控面板列表。 +-- diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-monitoringChart.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-monitoringChart.adoc new file mode 100644 index 000000000..aa4f845fc --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-monitoringChart.adoc @@ -0,0 +1,30 @@ +// :ks_include_id: 02c275a851594f868957a3c32ff9f5cd +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|图例类型 +|监控图的纵向数据展示方式，可选类型包括**基础图**和**堆叠图**。 + +|图表配色 +|监控图的配色风格，可选类型包括**默认配色**、**冷色调**和**暖色调**。 + +|基本信息 +|用户自定义的监控图名称和描述信息。 + +|数据 +|监控图中显示的监控指标。 + +* **图例名称**：用户自定义的监控指标名称。 + +* **间隔**：监控图中数据的时间间隔，取值为 <数值><单位>，例如 **1m** 表示数据时间间隔为 1 分钟。 + +* **监控指标**：应用程序暴露的监控指标。您可以点击**监控指标**然后在下拉列表中选择监控指标，也可以手动输入 PromQL 语句。请确保您已配置应用程序暴露监控指标，并已配置监控导出器。有关 PromQL 表达式的更多信息，请参阅 link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus 官方文档]。 + +|Y 轴 +|监控图的纵坐标轴设置。 + +* **单位**：纵坐标轴的数据单位。 + +* **精确位**：纵坐标轴数据的有效小数位数。 +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-monitoringMetric.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-monitoringMetric.adoc new file mode 100644 index 000000000..045cceba7 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-monitoringMetric.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 5ed9a5c35fa945bc84988f238d7ab69a +应用程序暴露的监控指标。您可以点击**监控指标**然后在下拉列表中选择监控指标，也可以手动输入 PromQL 语句。请确保您已配置应用程序暴露监控指标，并已配置监控导出器。有关 PromQL 表达式的更多信息，请参阅 link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus 官方文档]。 diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-textMetric.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-textMetric.adoc new file mode 100644 index 000000000..25ad7e064 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-textMetric.adoc @@ -0,0 +1,19 @@ +// :ks_include_id: 6d474f2ff06e43c7bc9003aaa10e29c2 +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|图表名称 +|监控指标的名称。 + +|单位 +|指标数据的单位。 + +|精确位 +|指标数据的有效小数位数。 + +|监控指标 +| +include::customMonitoringDashboards-para-monitoringMetric.adoc[] + +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-prer-exposeMetrics.adoc b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-prer-exposeMetrics.adoc new file mode 100644 index 000000000..93d7118da --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-prer-exposeMetrics.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 385623699d0d48bda614b5a8de5c062d +* 您需要配置运行在容器中的应用程序将符合 Prometheus 规范的监控指标暴露在某个服务端路径下。有关更多信息，请参阅 link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus 官方文档]。 diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-desc-gateway.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-desc-gateway.adoc new file mode 100644 index 000000000..7fd43c5c2 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-desc-gateway.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 854355fa9af44f41886ade72f0ee39da +网关为 KubeSphere 平台上的服务提供反向代理。网关需要根据应用路由工作，来自客户端的业务流量先通过域名解析先发送给网关，网关再根据应用路由中定义的规则将业务流量转发给不同的服务。网关本身也是通过服务暴露的工作负载，因而网关也支持 NodePort 和 LoadBalancer 两种外部访问模式。 diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-disableGateway.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-disableGateway.adoc new file mode 100644 index 000000000..c77050ceb --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-disableGateway.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 7ea2a84e80b6439cb0d2da5db17f8e35 +. 在页面右侧选择**管理 > 禁用**。 + +. 在弹出的对话框点击**确定**。 diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings.adoc new file mode 100644 index 000000000..2151178f7 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 17ab622bc96f45e68b3581c076cb1223 +. 在页面右侧选择**管理 > 编辑**。 + +. 在弹出的对话框，修改网关的参数，然后点击**确定**。 ++ +-- +include::gatewaySettings-para-enableGateway.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings_v4.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings_v4.adoc new file mode 100644 index 000000000..49062a84f --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings_v4.adoc @@ -0,0 +1,34 @@ +// :ks_include_id: 17ab622bc96f45e68b3581c076cb1223 +. 在页面右侧选择**管理 > 编辑**。 + +. 在弹出的对话框，修改网关的参数，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|IngressClassName +|IngressClass 的名称。 + +|容器组副本数量 +|期望的容器组副本数量。 + +|访问模式 +|网关服务的外部访问模式。 + +include::../services/services-para-externalAccess.adoc[tag=bullets] + +|链路追踪 +|是否对网关启用链路追踪功能。如需使用链路追踪功能，KubeSphere 平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 + +|配置选项 +|网关的配置选项。KubeSphere 的网关功能底层基于 Nginx Ingress Controller 实现，您可以设置网关的配置选项控制网关的行为。有关更多信息，请参阅 link:https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/[Nginx Ingress Controller 官方文档]。 + +|负载均衡器提供商 +|网关的负载均衡器提供商。网关的外部访问模式为 LoadBalancer 时，您需要根据负载均衡器插件和基础设施环境设置网关服务的注解以创建所需的负载均衡器。选择负载均衡器提供商后，设置网关服务注解时系统将提供注解提示。仅在网关服务的外部访问模式为 LoadBalancer 时可用。 + +|注解 +|网关服务的注解。如果已选择负载均衡器提供商，点击**键**文本框时系统将在下拉列表中显示注解提示。仅在网关服务的外部访问模式为 LoadBalancer 时可用。有关更多信息，请联系您的基础设施环境提供商。 +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails.adoc new file mode 100644 index 000000000..e372119c1 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails.adoc @@ -0,0 +1,109 @@ +// :ks_include_id: 2603654cc618449f9ae430c3041a361f +. 在页面右侧选择**管理 > 查看详情**打开网关详情页面。 + +. 在网关详情页面左侧的**属性**区域查看网关的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群 +|网关所属的集群。 + +|创建时间 +|网关的创建时间。 + +|更新时间 +|网关的更新时间 + +|创建者 +|启用网关的用户。 +|=== +-- + +. 在页面右侧的**监控**页签查看网关的请求数据。 ++ +==== +* **概览**区域提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|总请求数量 +|指定时间范围内网关接收的请求总数。 + +|请求数量 +|指定时间范围内响应状态码为 4XX 或 5XX 的请求数量。点击下拉列表可分别查看 4XX 请求和 5XX 请求的数量。 + +|成功请求 +|指定时间范围内成功请求的百分比。 + +|平均延迟 +|指定时间范围内所有请求的平均延迟。 + +|P50 延迟 +|指定时间范围内所有请求延迟的中位数。 + +|P95 延迟 +|指定时间范围内所有请求的 95% 分位延迟，即 95% 的请求的延迟小于或等于该数值。 + +|P99 延迟 +|指定时间范围内所有请求的 99% 分位延迟，即 99% 的请求的延迟小于或等于该数量。 +|=== +-- + +* 页面下方以折线图显示动态的请求数据。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|请求数量 +|指定时间范围内网关接收的每秒请求数量。 + +|连接数量 +|指定时间范围内网关接收的每秒连接数量。 + +|请求延迟 +|指定时间范围内所有请求的延迟中位数、95% 分位延迟、99% 分位延迟和平均延迟。 + +|失败请求数量 +|指定时间范围内网关接收的失败请求的数量。 + +|网络流量 +|指定时间范围内网关的每秒入站流量。 +|=== +-- + +include::../../../../_ks_components-en/oper-selectTimeRange.adoc[] + +include::../../../../_ks_components-en/oper-Autorefresh.adoc[] + +include::../../../../_ks_components-en/oper-refreshData.adoc[] +==== + +. 在网关详情页面右侧点击**配置选项**查看网关的配置选项。KubeSphere 的网关功能底层基于 Nginx Ingress Controller 实现，有关网关配置选项的更多信息，请参阅 link:https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/[Nginx Ingress Controller 官方文档]。 + +. 在网关详情页面右侧点击**网关日志**查看网关的日志。 ++ +-- +* 在**网关日志**页签上方点击搜索框并设置搜索条件，可按关键字、容器组或时间范围搜索日志数据。 + +* 在**网关日志**页签上方点击image:/images/ks-qkcp/zh/icons/start-dark.svg[start-dark,18,18]/image:/images/ks-qkcp/zh/icons/stop-dark-white.svg[stop-dark-white,18,18]可开启/停止实时数据刷新。 + +* 在**网关日志**页签上方点击**刷新间隔**可设置数据刷新间隔为 5s、10s 或 20s。 + +* 在**网关日志**页签上方点击image:/images/ks-qkcp/zh/icons/export.svg[export,18,18]可将日志文件下载到本地。 +-- + +. 在网关详情页面右侧点击**资源状态**页签查看网关工作负载的容器组副本数、容器端口和容器组。 ++ +-- +include::../../para-replicasPortsPods.adoc[] +-- + +. 在网关详情页面右侧点击**元数据**页签查看网关服务的注解。 diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails_v4.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails_v4.adoc new file mode 100644 index 000000000..961b23345 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails_v4.adoc @@ -0,0 +1,125 @@ +// :ks_include_id: 2603654cc618449f9ae430c3041a361f +. 在页面右侧选择**管理 > 查看详情**打开网关详情页面。 + +. 在网关详情页面左侧的**属性**区域查看网关的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群 +|网关所属的集群。 + +|创建时间 +|网关的创建时间。 + +|更新时间 +|网关的更新时间 + +|创建者 +|启用网关的用户。 +|=== +-- + +. 在网关详情页面右侧点击**配置选项**查看网关的配置选项。KubeSphere 的网关功能底层基于 Nginx Ingress Controller 实现，有关网关配置选项的更多信息，请参阅 link:https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/[Nginx Ingress Controller 官方文档]。 + +. 在页面右侧的**监控**页签查看网关的请求数据。 ++ +==== +[.admon.note,cols="a"] +|=== +|说明 + +| +如需使用网关监控功能，KubeSphere 平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 +|=== + +* **概览**区域提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|总请求数量 +|指定时间范围内网关接收的请求总数。 + +|请求数量 +|指定时间范围内响应状态码为 4XX 或 5XX 的请求数量。点击下拉列表可分别查看 4XX 请求和 5XX 请求的数量。 + +|成功请求 +|指定时间范围内成功请求的百分比。 + +|平均延迟 +|指定时间范围内所有请求的平均延迟。 + +|P50 延迟 +|指定时间范围内所有请求延迟的中位数。 + +|P95 延迟 +|指定时间范围内所有请求的 95% 分位延迟，即 95% 的请求的延迟小于或等于该数值。 + +|P99 延迟 +|指定时间范围内所有请求的 99% 分位延迟，即 99% 的请求的延迟小于或等于该数量。 +|=== +-- + +* 页面下方以折线图显示动态的请求数据。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|请求数量 +|指定时间范围内网关接收的每秒请求数量。 + +|连接数量 +|指定时间范围内网关接收的每秒连接数量。 + +|请求延迟 +|指定时间范围内所有请求的延迟中位数、95% 分位延迟、99% 分位延迟和平均延迟。 + +|失败请求数量 +|指定时间范围内网关接收的失败请求的数量。 + +|网络流量 +|指定时间范围内网关的每秒入站流量。 +|=== +-- + +include::../../../../_ks_components-en/oper-selectTimeRange.adoc[] + +include::../../../../_ks_components-en/oper-Autorefresh.adoc[] + +include::../../../../_ks_components-en/oper-refreshData.adoc[] +==== + +. 在网关详情页面右侧点击**网关日志**查看网关的日志。 ++ +-- +[.admon.note,cols="a"] +|=== +|说明 + +| +如需使用网关日志搜索功能，KubeSphere 平台需要安装并启用 **WhizardTelemetry 日志管理**扩展组件。 +|=== + +* 在**网关日志**页签上方点击搜索框并设置搜索条件，可按关键字、容器组或时间范围搜索日志数据。 + +* 在**网关日志**页签上方点击image:/images/ks-qkcp/zh/icons/start-dark.svg[start-dark,18,18]/image:/images/ks-qkcp/zh/icons/stop-dark-white.svg[stop-dark-white,18,18]可开启/停止实时数据刷新。 + +* 在**网关日志**页签上方点击**刷新间隔**可设置数据刷新间隔为 5s、10s 或 20s。 + +* 在**网关日志**页签上方点击image:/images/ks-qkcp/zh/icons/export.svg[export,18,18]可将日志文件下载到本地。 +-- + +. 在网关详情页面右侧点击**资源状态**页签查看网关工作负载的容器组副本数、容器端口和容器组。 ++ +-- +include::../../para-replicasPortsPods.adoc[] +-- + +. 在网关详情页面右侧点击**元数据**页签查看网关服务的注解。 diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-address.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-address.adoc new file mode 100644 index 000000000..eb71cc9cf --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-address.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 09fe14af1fd747b8aad60c34a228e54e +集群网关或项目网关的 IP 地址。 + +// tag::bullets[] +* 如果网关的外部访问模式为 NodePort，**网关地址**为某一个集群节点的 IP 地址。客户端可以通过任意集群节点的 IP 地址和端口访问应用路由的后端服务。 + +* 如果网关的外部访问模式为 LoadBalancer，**网关地址**为负载均衡器的地址。 + +// * 如果网关地址未显示，可能是因为集群节点缺少 **node-role.kubernetes.io/master** 标签。点击**集群节点**页面，点击控制平面节点，选择**更多操作 > 编辑标签**添加 **node-role.kubernetes.io/master** 标签。v4.1 删除该行 +// end::bullets[] diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway.adoc new file mode 100644 index 000000000..66356f372 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway.adoc @@ -0,0 +1,22 @@ +// :ks_include_id: 70d685391e6d449cbdfb8a7f5e6e5dfa +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|访问模式 +|网关服务的外部访问模式。 + +include::../services/services-para-externalAccess.adoc[tag=bullets] + +|链路追踪 +|是否对网关启用链路追踪功能。 + +|配置选项 +|网关的配置选项。{ks_product-en}的网关功能底层基于 Nginx Ingress Controller 实现，您可以设置网关的配置选项控制网关的行为。有关更多信息，请参阅 link:https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/[Nginx Ingress Controller 官方文档]。 + +|负载均衡器提供商 +|网关的负载均衡器提供商。网关的外部访问模式为 LoadBalancer 时，您需要根据负载均衡器插件和基础设施环境设置网关服务的注解以创建所需的负载均衡器。选择负载均衡器提供商后，设置网关服务注解时系统将提供注解提示。仅在网关服务的外部访问模式为 LoadBalancer 时可用。 + +|注解 +|网关服务的注解。如果已选择负载均衡器提供商，点击**键**文本框时系统将在下拉列表中显示注解提示。仅在网关服务的外部访问模式为 LoadBalancer 时可用。有关更多信息，请联系您的基础设施环境提供商。 +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway_v4.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway_v4.adoc new file mode 100644 index 000000000..e85d0a307 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway_v4.adoc @@ -0,0 +1,31 @@ +// :ks_include_id: 70d685391e6d449cbdfb8a7f5e6e5dfa +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|Nginx Ingress 版本 +|Nginx Ingress 的版本。KubeSphere 网关扩展组件基于 Nginx Ingress 提供网关管理功能。 + +|IngressClassName +|IngressClass 的名称。 + +|容器组副本数量 +|期望的容器组副本数量。 + +|访问模式 +|网关服务的外部访问模式。 + +include::../services/services-para-externalAccess.adoc[tag=bullets] + +|链路追踪 +|是否对网关启用链路追踪功能。如需使用链路追踪功能，{ks_product-en}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 + +|配置选项 +|网关的配置选项。{ks_product-en}的网关功能底层基于 Nginx Ingress Controller 实现，您可以设置网关的配置选项控制网关的行为。有关更多信息，请参阅 link:https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/[Nginx Ingress Controller 官方文档]。 + +|负载均衡器提供商 +|网关的负载均衡器提供商。网关的外部访问模式为 LoadBalancer 时，您需要根据负载均衡器插件和基础设施环境设置网关服务的注解以创建所需的负载均衡器。选择负载均衡器提供商后，设置网关服务注解时系统将提供注解提示。仅在网关服务的外部访问模式为 LoadBalancer 时可用。 + +|注解 +|网关服务的注解。如果已选择负载均衡器提供商，点击**键**文本框时系统将在下拉列表中显示注解提示。仅在网关服务的外部访问模式为 LoadBalancer 时可用。有关更多信息，请联系您的基础设施环境提供商。 +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-gatewayCard.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-gatewayCard.adoc new file mode 100644 index 000000000..04e199499 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-para-gatewayCard.adoc @@ -0,0 +1,37 @@ +// :ks_include_id: 6fca3db90bdf4fd8bb61eb771c1a7308 +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|类型 +|网关的类型。 + +|创建者 +|启用网关的用户。 + +|创建时间 +|网关的启用时间。 + +|访问模式 +|网关服务的外部访问模式。 + +include::../services/services-para-externalAccess.adoc[tag=bullets] + +|网关地址 +| +网关的外部访问地址。 + +include::gatewaySettings-para-address.adoc[tag=bullets] + +|节点端口 +|网关服务的 HTTP 和 HTTPS 节点端口。仅在网关的外部访问模式为 NodePort 时显示。 + +|副本 +|网关工作负载的副本数。 + +|链路追踪 +|网关是否已启用链路追踪功能。 + +|注解 +|网关服务的注解。网关的外部访问模式为 LoadBalancer 时，您需要根据负载均衡器插件和基础设施环境设置网关服务的注解以创建所需的负载均衡器。有关更多信息，请联系您的基础设施环境提供商。仅在网关的外部访问模式为 LoadBalancer 时显示。 +|=== diff --git a/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-warn-disableGateway.adoc b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-warn-disableGateway.adoc new file mode 100644 index 000000000..5ad3dd00e --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/gatewaySettings/gatewaySettings-warn-disableGateway.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: fbcc6577f08345e9a2b32a571da90898 +// Warning +include::../../../../_ks_components-en/admonitions/warning.adoc[] + +网关禁用后客户端将无法访问由网关反向代理的服务，相关业务可能会中断，请谨慎执行此操作。 + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-createAJob.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-createAJob.adoc new file mode 100644 index 000000000..390463e32 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-createAJob.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 7f14023bc6974772b201bc6c0b92e13b +This section explains how to create jobs. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-deleteJobs.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-deleteJobs.adoc new file mode 100644 index 000000000..4b6b74276 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-deleteJobs.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: 53cddf67368844919fec7ab2ca897ef6 +This section explains how to delete a job. + +//warning +[.admon.warning,cols="a"] +|=== +| Warning + +| +This operation will delete the job and all pods managed by it. If the job is running, the business running in it will be interrupted. Please proceed with caution. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-editJobInformation.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-editJobInformation.adoc new file mode 100644 index 000000000..2fb59477a --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-editJobInformation.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: b4a8007c076840f1aaef0251117dd232 +This section explains how to edit job information. + +You can edit the alias and description of the job. KubeSphere does not support editing the name of an already created job. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-jobs.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-jobs.adoc new file mode 100644 index 000000000..396231657 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-jobs.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 3965f0c407e24d6dae5c945b45abbd6e +This section explains how to manage jobs. + +In KubeSphere, applications run in pods. Jobs are used to manage pods that run either once or periodically. KubeSphere supports the following types of jobs: + +* Jobs: Used to manage pods that run only once. If a pod runs failed, the system will restart the pod according to the policies set in the job until specific conditions are met. + +* CronJobs: Used to manage pods that run periodically. The system creates regular jobs based on the schedule set in the CronJob and runs them accordingly. Each time when the pod runs, if it fails, the CronJob will restart the pod according to the policies set by the user until specific conditions are met. diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-pauseACronjob.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-pauseACronjob.adoc new file mode 100644 index 000000000..4ccf0251b --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-pauseACronjob.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: a773823d564e4c93b67e89f11ac3bc64 +This section explains how to pause a CronJob. + +After pausing a CronJob, the system will not create and run jobs at the scheduled time in the future. Running jobs are not affected. This operation is only available for CronJobs. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-rerunAJob.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-rerunAJob.adoc new file mode 100644 index 000000000..c2be8fa7c --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-rerunAJob.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: 81c337c82d7743cba51347779b603d00 +This section explains how to re-run a job. This operation is only available for regular jobs. + +//note +[.admon.note,cols="a"] +|=== +|Note + +| +KubeSphere only supports re-running jobs that have already completed, rather than jobs that are currently running. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-setJobMetadata.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-setJobMetadata.adoc new file mode 100644 index 000000000..31109cd15 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-setJobMetadata.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 941b85f6a2d149249751ac5843925f97 +Configure labels and annotations for the job. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-viewAJobList.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-viewAJobList.adoc new file mode 100644 index 000000000..217808611 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-viewAJobList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d134e4938b2447beadf1dfb8261c70a1 +This section explains how to view the job list. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-viewJobDetails.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-viewJobDetails.adoc new file mode 100644 index 000000000..182a085ed --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-desc-viewJobDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 3d8cf6ff7e434f25b6e0854742aaf84d +This section explains how to view job details. diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-createAJob.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-createAJob.adoc new file mode 100644 index 000000000..77352289f --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-createAJob.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: ade6d86d1f0d4f1db635fb9dd96b2348 +. On the **Basic Information** tab, configure the basic information of the job, as well as the scheduling strategy for a CronJob. Then click **Next**. + +. On the **Strategy Settings** tab, configure the strategy for a one-time job, and then click **Next**. + +. On the **Pod Settings** tab, set restart policies and containers for the pods managed by the job. Then click **Next**. + +. On the **Storage Settings** tab, mount volumes for the containers managed by the job. Then click **Next**. + +. On the **Advanced Settings** tab, specify nodes for the pods managed by the job, and set metadata for the job. Then click **Create**. ++ +Once the job is created, it will be displayed in the job list. diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-deleteASingleJob.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-deleteASingleJob.adoc new file mode 100644 index 000000000..c0f7446a7 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-deleteASingleJob.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 3e648f1c3f8d41a0a4ff221ad9efd72d +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the job you want to delete, then choose **Delete** from the dropdown list. + +. In the **Delete Job** dialog, enter the name of the job, then click **OK**. diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-deleteMultipleJobs.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-deleteMultipleJobs.adoc new file mode 100644 index 000000000..9e1db49ed --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-deleteMultipleJobs.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: ae8fc7f6ef7a43999d61c74c6fa39fe5 +. Select the checkbox on the left of the jobs you want to delete, then click **Delete** above the job list. + +. In the **Delete Multiple Jobs** dialog, enter the name of the jobs, then click **OK**. ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-editJobInformation.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-editJobInformation.adoc new file mode 100644 index 000000000..1a362c9c8 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-editJobInformation.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: 71ed2df8398646ea982d8084536b45d9 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the job you want to edit, then choose **Edit Information** from the dropdown list. + +. In the **Edit Information** dialog, set the alias and description for the job, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Alias +| The alias of the job. Aliases can be the same for different jobs. An alias can only contain Chinese characters, letters, numbers, and hyphens (-). It cannot start or end with a hyphen (-) and has a maximum length of 63 characters. + +| Description +| The description for the job. The description can contain any characters, with a maximum length of 256 characters. +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-openDetailsPage.adoc new file mode 100644 index 000000000..51308ebef --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: ca11e2b37deb4d04aa5fa7241ff673c9 +. On the **Job** page, click either **Job** or **CronJob**, then click the name of a job in the list to open its details page. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-openListPage.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-openListPage.adoc new file mode 100644 index 000000000..3520143ff --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 8619d925ec5a486cae57b4b228b668b2 +. On the **Jobs** page, click either **Jobs** or **CronJobs** to open the list of jobs. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-pauseACronjob.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-pauseACronjob.adoc new file mode 100644 index 000000000..3180876ac --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-pauseACronjob.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: eae4a035080a4f1bb09cb87fc6034aed +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the CronJob you want to pause, then choose **Pause** from the dropdown list. + +. To resume the CronJob, click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the CronJob you want to start, then choose **Start** from the dropdown list. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-rerunAJob.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-rerunAJob.adoc new file mode 100644 index 000000000..9f429f924 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-rerunAJob.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 24f7afe576124e6396922b7bd7234929 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the job you want to re-run, then choose **Rerun** from the dropdown list. The job will restart according to the defined policy. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-searchForJobs.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-searchForJobs.adoc new file mode 100644 index 000000000..32d97bb24 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-searchForJobs.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: cc4f326315a24232ba3df5a314ef63f3 +* Click the search box at the top of the list and search for jobs by name or status. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-viewJobDetails_new.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-viewJobDetails_new.adoc new file mode 100644 index 000000000..63222e005 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-oper-viewJobDetails_new.adoc @@ -0,0 +1,141 @@ +// :ks_include_id: ae48f9c2af1e46bca4bede49d4447413 +. In the left **Attributes** area on the job details page, view the resource attributes of the job. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Cluster +| The cluster to which the job belongs. + +| Project +| The project to which the job belongs. + +| Status +| +The current status of the job. + +include::jobs-para-jobStatus.adoc[] + +| Maximum Retries +| The maximum number of times the pods in the job can be restarted. If the maximum retries is reached but the job completion conditions are still not met, the job will be marked as failed. Available only for Jobs. + +| Complete Pods +| The number of completed pods required to mark the job as completed. Available only for Jobs. + +| Parallel Pods +| The number of pods that run in parallel in the job. Available only for Jobs. + +| Maximum Duration +| The maximum running time for the job, in seconds. If the maximum duration is reached but the job completion conditions are still not met, the job will be terminated and marked as failed. Available only for Jobs. + +| Schedule +| The CRON expression specifying the runtime cycle for a CronJob. KubeSphere defaults to UTC time, and you may need to adjust it based on your time zone. Available only for CronJobs. + +| Maximum Startup Delay +| The maximum delay before starting a job when it fails to start according to the schedule. Available only for CronJobs. + +| Successful Jobs Retention +| The number of successful jobs allowed to be retained, with a default value of **3**. Each time a CronJob runs, it creates a job, and you can specify the number of jobs to retain as a historical record. Available only for CronJobs. + +| Failed Jobs Retention +| The number of failed jobs allowed to be retained, with a default value of **1**. Each time a CronJob runs, it creates a job, and you can specify the number of jobs to retain as a historical record. Available only for CronJobs. + +| Concurrency Policy +| The policy the system adopts when multiple jobs created by a CronJob overlap. Available only for CronJobs. It includes the following polices: + +* **Run jobs concurrently**: New and old jobs run concurrently. + +* **Skip new job**: Do not run new jobs. + +* **Skip old job**: Immediately terminates old jobs and then runs new jobs. + +| Creation Time +| The creation time of the job. + +| Creator +| The user who created the job. +|=== +-- + +. On the right **Run Records** tab on the job details page, view the run records of the job. ++ +-- +When users re-run a Job manually or run a CronJob according to the schedule, the system generates run records. + +For Jobs, the **Run Records** tab displays the following information: + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| No. +| The serial number of the job, indicating the sequence of each run. + +| Status +| The status result of each run of the job. + +include::jobs-para-jobStatus.adoc[] + +* **Incomplete**: Manually rerun the job during the job running. + +| Message +| The message returned by the run. + +| Start Time +| The time the run started. + +| End Time +| The time the run ended. +|=== + +For CronJobs, the **Run Records** tab displays the following information: + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Job +| The name of the job created by the CronJob. + +| Status +| The status of the job created by the CronJob. + +include::jobs-para-jobStatus.adoc[] + +| Start Time +| The start time of the job created by the CronJob. + +| End Time +| The time the run ended. +|=== +-- + +. For Jobs, Click the **Resource Status** tab on the right of the job details page to view the number of pod replicas and pods in the job. ++ +-- + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Replicas +| The number of pod replicas in the job. + +| Pods +| The pods running for the job. + +include::../nodes/nodes-para-podList.adoc[] +|=== +-- + +. Click the **Metadata** tab on the right of the job details page to view the labels and annotations of the job. + +. For Jobs, Click the **Environment Variables** tab on the right of the job details page to view the environment variables of all containers in the job. + +. Click the **Events** tab on the right of the job details page to view events related to the job. ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-para-basicInformation.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-para-basicInformation.adoc new file mode 100644 index 000000000..9e85a46ca --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-para-basicInformation.adoc @@ -0,0 +1,41 @@ +* Basic Information ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Name +| The name of the job. The name can only contain lowercase letters, numbers, and hyphens (-). It must start and end with a lowercase letter or number, with a maximum length of 63 characters. + +| Alias +| The alias of the job. Aliases can be the same for different jobs. The alias can only contain Chinese characters, letters, numbers, and hyphens (-). It must not start or end with a hyphen (-), with a maximum length of 63 characters. + +| Project +| The project to which the job belongs. It is recommended to choose a user project, as system projects are typically used for managing system resources. + +| Description +| The description of the job. The description can contain any characters, with a maximum length of 256 characters. + +| Schedule +| The CRON expression specifying the runtime cycle for a CronJob. KubeSphere defaults to UTC time, and you may need to adjust it based on your time zone. Available only for CronJobs. + +| Maximum Startup Delay +| The maximum delay before starting a job when it fails to start according to the schedule. Available only for CronJobs. + +| Successful Jobs Retention +| The number of successful jobs allowed to be retained, with a default value of **3**. Each time a CronJob runs, it creates a job, and you can specify the number of jobs to retain as a historical record. Available only for CronJobs. + +| Failed Jobs Retention +| The number of failed jobs allowed to be retained, with a default value of **1**. Each time a CronJob runs, it creates a job, and you can specify the number of jobs to retain as a historical record. Available only for CronJobs. + +| Concurrency Policy +| The policy the system adopts when multiple jobs created by a CronJob overlap. Available only for CronJobs. It includes the following policies: + +* **Run jobs concurrently**: New and old jobs run concurrently. + +* **Skip new job**: Do not run new jobs. + +* **Skip old job**: Immediately terminates old jobs and then runs new jobs. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-para-jobList.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-para-jobList.adoc new file mode 100644 index 000000000..ccc127752 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-para-jobList.adoc @@ -0,0 +1,27 @@ +* The job list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Name +| The name and description of the job. + +| Status +| +The current status of the job. + +* **Running**: The job is running. + +* **Completed**: The job has run successfully and is completed. + +* **Failed**: The job has failed. + +| Project +| The project to which the job belongs. + +| Last Run Time +| The time of the last run for the job. +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-para-jobStatus.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-para-jobStatus.adoc new file mode 100644 index 000000000..a8a01b5bb --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-para-jobStatus.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 88bc02980e93473eaec099d0e0f6b2c4 +* **Running**: The job is running. + +* **Completed**: The job has run successfully and is completed. + +* **Failed**: The job has failed. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-para-restartPolicy.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-para-restartPolicy.adoc new file mode 100644 index 000000000..f9250e17b --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-para-restartPolicy.adoc @@ -0,0 +1,16 @@ +* Pod Settings > Restart Policy ++ +-- +Select the policy the system adopts when a container in the pod fails to run. + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Re-create pod +| The system will recreate the entire pod. + +| Restart container +| The system will restart the container. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/jobs/jobs-para-strategySettings.adoc b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-para-strategySettings.adoc new file mode 100644 index 000000000..ddc4caedb --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/jobs/jobs-para-strategySettings.adoc @@ -0,0 +1,22 @@ +* Strategy Settings ++ +-- +Configure the strategy for each job. + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Maximum Retries +| The maximum number of times the pods in the job can be restarted. If the maximum retries is reached but the job completion conditions are still not met, the job will be marked as failed. + +| Complete Pods +| The number of completed pods required to mark the job as completed. + +| Parallel Pods +| The number of pods that run in parallel in the job. + +| Maximum Duration +| The maximum running time for the job, in seconds. If the maximum duration is reached but the job completion conditions are still not met, the job will be terminated and marked as failed. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-desc-logTypes.adoc b/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-desc-logTypes.adoc new file mode 100644 index 000000000..09d3ab322 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-desc-logTypes.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 3b493272487d4c41acba72e256f15c2e +* 容器日志：从容器标准输出获取的日志。容器日志的内容由容器中运行的应用程序决定。 + +* 资源事件：工作负载、任务、容器组、服务、应用路由等各类资源的事件。 + +* 审计日志：{ks_product-en} API 服务器接收请求的记录。 diff --git a/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-oper-openDetailsPage.adoc new file mode 100644 index 000000000..fce00206e --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 5dbadd4f7bcf45adbae22159fa533a09 +. 在**日志接收器**页面，点击**容器日志**、**资源事件**或**审计日志**，然后在列表中点击一个日志接收器的名称打开其详情页面。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-oper-openListPage.adoc b/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-oper-openListPage.adoc new file mode 100644 index 000000000..5078e1b7c --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 4165043cdef34a04aabf44d19b27f0b4 +. 在**日志接收器**页面，点击**容器日志**、**资源事件**或**审计日志**打开日志接收器列表。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-para-addLogReceiver.adoc b/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-para-addLogReceiver.adoc new file mode 100644 index 000000000..8e101380d --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-para-addLogReceiver.adoc @@ -0,0 +1,15 @@ +// :ks_include_id: 66ed1f4913ff42b5b26a407b2ce28c78 +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|服务地址 +| +include::logReceivers-para-address.adoc[] + +|索引前缀 +|日志数据的索引前缀，用于区分不同类型的日志。仅对 Elasticsearch 和 OpenSearch 可用。 + +|主题 +|日志数据的主题，用于区分不同类型的日志。仅对 Kafka 可用。 +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-para-address.adoc b/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-para-address.adoc new file mode 100644 index 000000000..1de1ed725 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/logReceivers/logReceivers-para-address.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 52e9e8100b4444ebb9fbb42175d917f3 +日志接收器的服务地址和服务端口。{ks_product-en}会将日志发送给该地址和端口。{ks_product-en}默认使用的 OpenSearch 的服务地址和服务端口为 **opensearch-cluster-data.kubesphere-logging-system.svc:9200**。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/networkPolicies/networkPolicies-para-information.adoc b/content/en/docs/_custom-en/clusterManagement/networkPolicies/networkPolicies-para-information.adoc new file mode 100644 index 000000000..3fb6387f6 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/networkPolicies/networkPolicies-para-information.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 9f53c0bd64274d80baa502171017a705 +|名称 +|网络策略的名称。 + +|项目 +|网络策略所属的项目。 + +|创建时间 +|网络策略的创建时间。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/networkPolicies/networkPolicies-para-target.adoc b/content/en/docs/_custom-en/clusterManagement/networkPolicies/networkPolicies-para-target.adoc new file mode 100644 index 000000000..1ec586e59 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/networkPolicies/networkPolicies-para-target.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: ff94c103e4f841cfa4bed82610aac7a6 +规则适用的容器组的信息。 + +* **项目**：规则所属的项目。网络策略中的规则仅适用于网络策略所属项目中的容器组。 + +* **标签**：规则适用的容器组所具有的标签。如果未设置标签，则规则适用于网络策略所属的项目中的所有容器组。 diff --git a/content/en/docs/_custom-en/clusterManagement/networkPolicies/networkPolicies-prer-enableNetworkPolicy.adoc b/content/en/docs/_custom-en/clusterManagement/networkPolicies/networkPolicies-prer-enableNetworkPolicy.adoc new file mode 100644 index 000000000..c29201541 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/networkPolicies/networkPolicies-prer-enableNetworkPolicy.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: c68e65ce33ae49d898727cd2c7e06306 +ifeval::["{file_output_type}" == "html"] +* {ks_product-en}平台需要启用网络策略扩展组件。 +endif::[] +ifeval::["{file_output_type}" == "pdf"] +* {ks_product-en}平台需要启用网络策略扩展组件。有关更多信息，请参阅《{ks_product-en}平台管理指南》的“扩展组件管理”章节。 +endif::[] diff --git a/content/en/docs/_custom-en/clusterManagement/nodes/nodes-oper-openListPage.adoc b/content/en/docs/_custom-en/clusterManagement/nodes/nodes-oper-openListPage.adoc new file mode 100644 index 000000000..d0c0180d9 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/nodes/nodes-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 18321be0ac1a40aca5c8142bce4195c6 +. 在左侧导航栏选择**节点 > 集群节点**或**节点 > 边缘节点**打开节点列表。 diff --git a/content/en/docs/_custom-en/clusterManagement/nodes/nodes-oper-openListPage_new.adoc b/content/en/docs/_custom-en/clusterManagement/nodes/nodes-oper-openListPage_new.adoc new file mode 100644 index 000000000..d70daee26 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/nodes/nodes-oper-openListPage_new.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 18321be0ac1a40aca5c8142bce4195c6 +. In the left navigation pane, select **Nodes > Cluster Nodes** to open the node list. diff --git a/content/en/docs/_custom-en/clusterManagement/nodes/nodes-para-nodeRole.adoc b/content/en/docs/_custom-en/clusterManagement/nodes/nodes-para-nodeRole.adoc new file mode 100644 index 000000000..1e871ee51 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/nodes/nodes-para-nodeRole.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: aa9a7a75dbc34278bbd88723c93fcca5 +各节点在集群中的角色，取值为**控制平面节点**、**工作节点**或**边缘节点**。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/nodes/nodes-para-nodeRole_new.adoc b/content/en/docs/_custom-en/clusterManagement/nodes/nodes-para-nodeRole_new.adoc new file mode 100644 index 000000000..707fd749f --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/nodes/nodes-para-nodeRole_new.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: aa9a7a75dbc34278bbd88723c93fcca5 +The roles of each node in the cluster, it can be **Control Plane** or **Worker**. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/nodes/nodes-para-nodeStatus.adoc b/content/en/docs/_custom-en/clusterManagement/nodes/nodes-para-nodeStatus.adoc new file mode 100644 index 000000000..842cc5e71 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/nodes/nodes-para-nodeStatus.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 0724df9ec5f247dcbf50e5ed6abcdf40 +各节点的运行状态。 + +* **运行中**：节点运行正常。 + +* **无法调度**：节点被用户手动设置为不可调度。如果节点处在此状态，容器组将不能被调度到该节点。 + +* **告警**：节点上存在告警。您可以在节点详情页面的**运行状态 > 健康状态** 区域查看节点的告警类型。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/nodes/nodes-para-nodeStatus_new.adoc b/content/en/docs/_custom-en/clusterManagement/nodes/nodes-para-nodeStatus_new.adoc new file mode 100644 index 000000000..341926c72 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/nodes/nodes-para-nodeStatus_new.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 0724df9ec5f247dcbf50e5ed6abcdf40 +The running status of each node. + +* **Running**: The node is running normally. + +* **Unschedulable**: The node is marked by the user as unschedulable. If a node is in this state, pods cannot be scheduled to this node. + +// * **Warning**: There are warnings on the node. You can view the warning types of the node under the **Running Status > Health Status** tab on the node details page. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/nodes/nodes-para-podList.adoc b/content/en/docs/_custom-en/clusterManagement/nodes/nodes-para-podList.adoc new file mode 100644 index 000000000..cff934feb --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/nodes/nodes-para-podList.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 5fa3835b046e429ca339319d7a09aefe +* Click image:/images/ks-qkcp/zh/icons/chevron-down.svg["chevron-down",18,18] to view information about the containers running in the pod. + +* Click the name of the pod to view container details. + +* Enter keywords in the search box above the pod list to search for pods whose names contain specific keywords. + +* Click image:/images/ks-qkcp/zh/icons/refresh-light.svg[Refresh,18,18] in the upper-right corner of the pod list to refresh the information. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-cloneAPersistentVolume.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-cloneAPersistentVolume.adoc new file mode 100644 index 000000000..2e649851d --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-cloneAPersistentVolume.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 19d9bf1ea982422ea0b931f92715f227 +This section explains how to clone a Persistent Volume. + +After creating a Persistent Volume Claim and Persistent Volume, you can create identical copies by cloning them. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAPersistentVolumeClaim.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAPersistentVolumeClaim.adoc new file mode 100644 index 000000000..a57d4904f --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAPersistentVolumeClaim.adoc @@ -0,0 +1 @@ +This section explains how to create a Persistent Volume Claim. diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAVolumeSnapshot.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAVolumeSnapshot.adoc new file mode 100644 index 000000000..d8bdac5a7 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAVolumeSnapshot.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 10cd1bc2be6f48dd994fe2be6c747e10 +本节介绍如何创建卷快照。 diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-deletePersistentVolumeClaims.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-deletePersistentVolumeClaims.adoc new file mode 100644 index 000000000..ede970d87 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-deletePersistentVolumeClaims.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: f294119a3b1a45a49ff83ed852f8fadd +This section explains how to delete a Persistent Volume Claim. + +//warning +[.admon.warning,cols="a"] +|=== +| Warning + +| +Deleting a Persistent Volume Claim is irreversible, and by default, the Persistent Volume associated with the Persistent Volume Claim will also be deleted. Please proceed with caution to avoid data loss. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-editPersistentVolumeClaimInformation.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-editPersistentVolumeClaimInformation.adoc new file mode 100644 index 000000000..e00a1dae5 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-editPersistentVolumeClaimInformation.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: e8b3859a8e1d48b4afe313a86d58a9f3 +This section explains how to edit Persistent Volume Claim information. + +You can edit the alias and description of the Persistent Volume Claim. KubeSphere does not support editing the name of an already created Persistent Volume Claim. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-expandAPersistentVolumeClaim.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-expandAPersistentVolumeClaim.adoc new file mode 100644 index 000000000..019e0cd1e --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-expandAPersistentVolumeClaim.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 733b66fafb0d4f2cbc99a4d8dbd20458 +This section describes how to expand the capacity of a Persistent Volume. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-viewPersistentVolumeClaimDetails.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-viewPersistentVolumeClaimDetails.adoc new file mode 100644 index 000000000..a222d4735 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-viewPersistentVolumeClaimDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 3b30b4276d1c44d894011e368b54291d +This section explains how to view details of a Persistent Volume Claim. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-cloneAPersistentVolume.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-cloneAPersistentVolume.adoc new file mode 100644 index 000000000..3c0cf04bc --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-cloneAPersistentVolume.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 63eda24d0c774987bc1076d5c1cc20c4 +. In the top-left corner of the details page, select **More > Clone**. + +. In the **Clone Volume** dialog, set the name for the new Persistent Volume Claim, and then click **OK**. ++ +-- +The system will create identical copies for the Persistent Volume Claim and the corresponding Persistent Volume. +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim-for-kubefed.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim-for-kubefed.adoc new file mode 100644 index 000000000..a084ccf62 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim-for-kubefed.adoc @@ -0,0 +1,76 @@ +// :ks_include_id: 4527bd133db04495b10cf1930a58d5f9 +. 在**基本信息**页签，设置持久卷声明的基本信息，然后点击**下一步**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|持久卷声明的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 253 个字符。 + +|别名 +|持久卷声明的别名。不同持久卷声明的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|持久卷声明的描述信息。描述可包含任意字符，最长 256 个字符。 +|=== +-- + +. 在**存储设置**页签，设置存储空间需求，然后点击**下一步**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// |创建方式 +// |持久卷声明的创建方式。 + +// * **通过存储类创建**：选择当前项目中的存储类来创建持久卷声明。 + +// * **通过卷快照创建**：选择当前项目中的卷快照来创建持久卷声明。 + +// |存储类 +// |用于创建持久卷声明的存储类。仅在持久卷声明创建方式为**通过存储类创建**时可用。 + +// |卷快照 +// |用于创建持久卷声明的卷快照。仅在持久卷声明创建方式为**通过卷快照创建**时可用。 + +|访问模式 +| +include::persistentVolumeClaims-para-accessMode.adoc[] + +取决于后端的存储系统，某些访问模式类型可能不可用。 + +|卷容量 +|持久卷声明的对应的卷容量大小。 +|=== +-- + +. 在**高级设置**页签，设置持久卷声明的标签和注解，然后点击**创建**。 ++ +-- +include::../workloads/createWorkload/workloads-para-Metadata.adoc[] +-- + +. 在**集群差异设置**页签，为不同集群中的持久卷声明使用不同的存储设置。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|存储类 +|用于创建持久卷声明的存储类。 + +|访问模式 +| +include::persistentVolumeClaims-para-accessMode.adoc[] + +|卷容量 +|通过持久卷声明模板创建的每个持久卷的容量。 +|=== + +持久卷声明创建完成后将显示在持久卷声明列表中。 +-- diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim.adoc new file mode 100644 index 000000000..e71c61354 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim.adoc @@ -0,0 +1,57 @@ +// :ks_include_id: 4527bd133db04495b10cf1930a58d5f9 +. 在**基本信息**页签，设置持久卷声明的基本信息，然后点击**下一步**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|持久卷声明的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 253 个字符。 + +|别名 +|持久卷声明的别名。不同持久卷声明的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|持久卷声明的描述信息。描述可包含任意字符，最长 256 个字符。 +|=== +-- + +. 在**存储设置**页签，设置存储空间需求，然后点击**下一步**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|创建方式 +|持久卷声明的创建方式。 + +* **通过存储类创建**：选择当前项目中的存储类来创建持久卷声明。 + +* **通过卷快照创建**：选择当前项目中的卷快照来创建持久卷声明。 + +|存储类 +|用于创建持久卷声明的存储类。仅在持久卷声明创建方式为**通过存储类创建**时可用。 + +|卷快照 +|用于创建持久卷声明的卷快照。仅在持久卷声明创建方式为**通过卷快照创建**时可用。 + +|访问模式 +| +include::persistentVolumeClaims-para-accessMode.adoc[] + +取决于后端的存储系统，某些访问模式类型可能不可用。 + +|卷容量 +|持久卷声明的对应的卷容量大小。 +|=== +-- + +. 在**高级设置**页签，设置持久卷声明的标签和注解，然后点击**创建**。 ++ +-- +include::../workloads/createWorkload/workloads-para-Metadata.adoc[] + +持久卷声明创建完成后将显示在持久卷声明列表中。 +-- diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim_new.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim_new.adoc new file mode 100644 index 000000000..35ea67395 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim_new.adoc @@ -0,0 +1,49 @@ +. On the **Basic Information** tab, set the basic information for the Persistent Volume Claim, and then click **Next**. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +|Name +|The name of the Persistent Volume Claim. The name can only contain lowercase letters, numbers, and hyphens (-). It must start and end with a lowercase letter or number and can be up to 253 characters long. + +|Alias +|The alias of the Persistent Volume Claim. The aliases of different Persistent Volume Claims can be the same. The alias can only contain Chinese characters, letters, numbers, and hyphens (-). It must not start or end with a hyphen (-) and can be up to 63 characters long. + +|Description +|The description of the Persistent Volume Claim. The description can contain any characters and can be up to 256 characters long. +|=== +-- + +. On the **Storage Settings** tab, set the storage space requirements, and then click **Next**. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +|Creation Method +|**From Storage Class**: Choose a storage class in the current project to create the Persistent Volume Claim. + +|Storage Class +|The storage class used to create the Persistent Volume Claim. + +|Access Mode +| +include::persistentVolumeClaims-para-accessMode.adoc[] + +Certain access mode may not be available depending on the backend storage system. + +|Volume Capacity +|The corresponding volume capacity of the Persistent Volume Claim. +|=== +-- + +. On the **Advanced Settings** tab, set the labels and annotations for the Persistent Volume Claim, and then click **Create**. ++ +-- +include::../workloads/createWorkload/workloads-para-Metadata.adoc[] + +The Persistent Volume Claim will be displayed in the list after creation. +-- diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAVolumeSnapshot.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAVolumeSnapshot.adoc new file mode 100644 index 000000000..38a862684 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAVolumeSnapshot.adoc @@ -0,0 +1,20 @@ +// :ks_include_id: f523ebef727d479488a3ad33a373f462 +. 在持久卷声明详情页面的左上角，选择**更多操作 > 创建快照**。 + +. 在**创建快照**对话框，设置卷快照的名称和卷快照类，然后点击**确定**。 ++ +-- +[%header,cols="1,4"] +|=== +|参数 |描述 + +|名称 +|卷快照的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 253 个字符。 + +|卷快照类 +| +include::persistentVolumeClaims-para-volumeSnapshotClass.adoc[] +|=== + +卷快照创建后将显示在**卷快照**页面的卷快照列表中。 +-- diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteASinglePersistentVolumeClaim.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteASinglePersistentVolumeClaim.adoc new file mode 100644 index 000000000..2acd0da01 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteASinglePersistentVolumeClaim.adoc @@ -0,0 +1,3 @@ +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the Persistent Volume Claim you want to delete, then choose **Delete** from the dropdown list. + +. In the **Delete Persistent Volume Claim** dialog, enter the name of the Persistent Volume Claim, then click **OK**. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteMultiplePersistentVolumeClaims.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteMultiplePersistentVolumeClaims.adoc new file mode 100644 index 000000000..8b9e8fcc0 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteMultiplePersistentVolumeClaims.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 20ff9a5d22c94e289133c37037d461e6 +. Select the checkbox on the left of the Persistent Volume Claims you want to delete, then click **Delete** above the Persistent Volume Claim list. + +. In the **Delete Multiple Persistent Volume Claims** dialog, enter the name of the Persistent Volume Claims, then click **OK**. ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-editPersistentVolumeClaimInformation.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-editPersistentVolumeClaimInformation.adoc new file mode 100644 index 000000000..ecb2f35ac --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-editPersistentVolumeClaimInformation.adoc @@ -0,0 +1,16 @@ +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the Persistent Volume Claim you want to edit, then choose **Edit Information** from the dropdown list. + +. In the **Edit Information** dialog, set the alias and description for the Persistent Volume Claim, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Alias +| The alias of the Persistent Volume Claim. Aliases can be the same for different Persistent Volume Claims. An alias can only contain Chinese characters, letters, numbers, and hyphens (-). It cannot start or end with a hyphen (-) and has a maximum length of 63 characters. + +| Description +| The description of the Persistent Volume Claim. The description can contain any characters, with a maximum length of 256 characters. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-expandAPersistentVolume.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-expandAPersistentVolume.adoc new file mode 100644 index 000000000..9ba7f8488 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-expandAPersistentVolume.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: b1b90c0bbcf94434a5daecc86d546c03 +. In the top-left corner of the details page, select **More > Expand**. + +. In the **Expand Volume** dialog, set the volume capacity, and then click **OK**. ++ +-- +//warning +[.admon.warning,cols="a"] +|=== +| Warning + +| +* If the Persistent Volume is already mounted to a workload, expanding the capacity will result in the restart of the workload, causing a interruption in the business. + +* Persistent volume capacity can only be increased and cannot be reduced. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc new file mode 100644 index 000000000..c4c365b18 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: fd9a9a3e2e00439cb6d91dd990d83b23 +. Click the name of a Persistent Volume Claim in the list to open its details page. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-searchForPersistentVolumeClaims.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-searchForPersistentVolumeClaims.adoc new file mode 100644 index 000000000..046dc5279 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-searchForPersistentVolumeClaims.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 8f4761e6cc6f4d4e92304c70275e7b0a +* Click the search box at the top of the list to search for Persistent Volume Claims by name or status. diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails-for-kubefed.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails-for-kubefed.adoc new file mode 100644 index 000000000..0906ee060 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails-for-kubefed.adoc @@ -0,0 +1,101 @@ +// :ks_include_id: e06b7d959620413ebfcc3bfe526b03d1 +. 在持久卷声明详情页面左侧的**属性**区域查看持久卷声明的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|项目 +|持久卷声明所属的项目。 + +// |状态 +// | +// include::persistentVolumeClaims-para-status.adoc[] + +|容量 +|持久卷声明请求的存储容量大小。 + +|访问模式 +| +include::persistentVolumeClaims-para-accessMode.adoc[] + +|存储类 +|持久卷声明请求的存储类。 + +|供应者 +| +include::../persistentVolumes/persistentVolumes-para-provisioner.adoc[] + +// |持久卷 +// |与持久卷声明绑定的持久卷。 + +|创建时间 +|持久卷声明的创建时间。 + +|创建者 +|创建持久卷声明的用户。如果该字段的值为空，则表明持久卷声明由系统自动创建。 +|=== +-- + +. 在持久卷声明详情页面右侧的**资源状态**页签查看持久卷声明对应持久卷的资源用量。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|持久卷 +|显示持久卷的已使用容量百分比、剩余容量大小和总容量大小。 + +|Inode 用量 +|显示指定时间范围内的集群 Inode 使用量百分比。 + +|=== +-- + +. 在持久卷声明详情页面右侧的**挂载信息**页签查看持久卷声明对应持久卷的已挂载容器组。 ++ +-- +// include::../nodes/nodes-para-podList.adoc[] + +点击image:/images/ks-qkcp/zh/icons/chevron-down.svg["chevron-down",18,18]可查看容器组中运行的容器的信息。 +-- + +. 在持久卷声明详情页面右侧点击**元数据**页签查看持久卷声明的标签和注解。 + +. 在持久卷声明详情页面右侧点击**事件**页签查看持久卷声明的事件。 ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- + +// . 在持久卷声明详情页面右侧的**快照**页签查看持久卷声明对应持久卷的快照。 +// + +// -- + +// [%header,cols="1a,4a"] +// |=== +// |参数 |描述 + +// |名称 +// |快照的名称、别名和快照类。 + +// |状态 +// |快照的状态。 + +// * **创建中**：快照正在创建中。 + +// * **创建失败**：快照创建失败。 + +// * **创建成功**：快照创建成功。 + +// * **删除中**：正在删除快照。 + +// |容量 +// |快照的容量大小。 + +// |创建时间 +// |快照的创建时间。 +// |=== +// -- diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails.adoc new file mode 100644 index 000000000..7447bb06d --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails.adoc @@ -0,0 +1,95 @@ +// :ks_include_id: e06b7d959620413ebfcc3bfe526b03d1 +. 在持久卷声明详情页面左侧的**属性**区域查看持久卷声明的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|项目 +|持久卷声明所属的项目。 + +|状态 +| +include::persistentVolumeClaims-para-status.adoc[] + +|容量 +|持久卷声明请求的存储容量大小。 + +|访问模式 +| +include::persistentVolumeClaims-para-accessMode.adoc[] + +|存储类 +|持久卷声明请求的存储类。 + +|供应者 +| +include::../persistentVolumes/persistentVolumes-para-provisioner.adoc[] + +|持久卷 +|与持久卷声明绑定的持久卷。 + +|创建时间 +|持久卷声明的创建时间。 + +|创建者 +|创建持久卷声明的用户。如果该字段的值为空，则表明持久卷声明由系统自动创建。 +|=== +-- + +. 在持久卷声明详情页面右侧的**资源状态**页签查看持久卷声明对应持久卷的资源用量和已挂载的容器组。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|持久卷 +|显示持久卷的已使用容量百分比、剩余容量大小和总容量大小。 + +|已挂载容器组 +| +显示已挂载持久卷声明对应持久卷的容器组。 + +include::../nodes/nodes-para-podList.adoc[] +|=== +-- + +. 在持久卷声明详情页面右侧点击**元数据**页签查看持久卷声明的标签和注解。 + +. 在持久卷声明详情页面右侧点击**事件**页签查看持久卷声明的事件。 ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- + +. 在持久卷声明详情页面右侧的**快照**页签查看持久卷声明对应持久卷的快照。 ++ +-- + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|快照的名称、别名和快照类。 + +|状态 +|快照的状态。 + +* **创建中**：快照正在创建中。 + +* **创建失败**：快照创建失败。 + +* **创建成功**：快照创建成功。 + +* **删除中**：正在删除快照。 + +|容量 +|快照的容量大小。 + +|创建时间 +|快照的创建时间。 +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails_new.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails_new.adoc new file mode 100644 index 000000000..d19082e64 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails_new.adoc @@ -0,0 +1,63 @@ +// :ks_include_id: e06b7d959620413ebfcc3bfe526b03d1 +. In the **Attributes** section on the left side of the details page, view the resource attributes of the Persistent Volume Claim. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +|Project +|The project to which the Persistent Volume Claim belongs. + +|Status +| +include::persistentVolumeClaims-para-status.adoc[] + +|Capacity +|The requested storage capacity of the Persistent Volume Claim. + +|Access Mode +| +include::persistentVolumeClaims-para-accessMode.adoc[] + +|Storage Class +|The storage class requested by the Persistent Volume Claim. + +|Provisioner +| +include::../persistentVolumes/persistentVolumes-para-provisioner.adoc[] + +|Persistent Volume +|The Persistent Volume bound to the Persistent Volume Claim. + +|Creation Time +|The creation time of the Persistent Volume Claim. + +|Creator +|The user who created the Persistent Volume Claim. If the value of this field is empty, it means the Persistent Volume Claim was created automatically by the system. +|=== +-- + +. On the right side of the details page, click the **Resource Status** tab to view the mounted pods of the Persistent Volume bound to the Persistent Volume Claim. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +|Mounted Pods +| +Displays the pods that are mounted to the Persistent Volume bound to the Persistent Volume Claim. + +include::../nodes/nodes-para-podList.adoc[] +|=== +-- + +. Click the **Metadata** tab on the right side of the details page to view the labels and annotations of the Persistent Volume Claim. + +. Click the **Events** tab on the right side of the details page to view the events of the Persistent Volume Claim. ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- + diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-accessMode.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-accessMode.adoc new file mode 100644 index 000000000..d0840810b --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-accessMode.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 03868826ceca4baea8a9365de6974f02 +The access modes of Persistent Volumes. + +* **RWO** (ReadWriteOnce): Allows a single node to read from and write to the Persistent Volume. + +* **ROX** (ReadOnlyMany): Allows multiple nodes to read from the Persistent Volume. + +* **RWX** (ReadWriteMany): Allows multiple nodes to read from and write to the Persistent Volume. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-persistentVolumeClaimList.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-persistentVolumeClaimList.adoc new file mode 100644 index 000000000..c0f550b6b --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-persistentVolumeClaimList.adoc @@ -0,0 +1,31 @@ +// :ks_include_id: 3406d7c02c52477bb228c5d190bee2a3 +* The Persistent Volume Claim list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +|Name +|The name, alias, and storage class of the Persistent Volume Claim. + +|Status +| +include::persistentVolumeClaims-para-status.adoc[] + +ifndef::kubefed[] +|Persistent Volume +|The Persistent Volume bound to the Persistent Volume Claim. +endif::[] + +|Access Mode +| +include::persistentVolumeClaims-para-accessMode.adoc[] + +|Mount Status +|Whether the Persistent Volume associated with the Persistent Volume Claim is already mounted to a container. + +|Creation Time +|The creation time of the Persistent Volume Claim. +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-status.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-status.adoc new file mode 100644 index 000000000..064e00808 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-status.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: 3728661e623d44fcaae41fd16cf87c08 +Current status of the Persistent Volume Claim: + +* **Bound**: The system has created a Persistent Volume based on the Persistent Volume Claim, and the Persistent Volume Claim is bound to the Persistent Volume. + +* **Pending**: The system has created the Persistent Volume Claim, but the corresponding Persistent Volume has not been created yet. + +* **Updating**: The settings of the Persistent Volume Claim have changed, and the system is updating the Persistent Volume Claim. + +* **Deleting**: The system is deleting the Persistent Volume Claim. + +* **Lost**: The system has bound the Persistent Volume Claim to a Persistent Volume, but the corresponding Persistent Volume cannot be found. In this state, the Persistent Volume may have been deleted. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshot.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshot.adoc new file mode 100644 index 000000000..be293769e --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshot.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 7d428de9ff3a4f0fbd1cd48e49749f27 +卷快照保存了存储卷的当前数据，可用于创建持久卷声明以及对应的持久卷。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshotClass.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshotClass.adoc new file mode 100644 index 000000000..da6b9ba1c --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshotClass.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 308d3cded9ea45a5a0a4475b02e53d57 +用于创建卷快照的卷快照类。请确保卷快照类的供应者与持久卷对应的存储类的供应者一致，否则卷快照将创建失败。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-backData.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-backData.adoc new file mode 100644 index 000000000..ee82795ee --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-backData.adoc @@ -0,0 +1 @@ +* Please backup data in the backend storage area in advance to avoid data loss. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc new file mode 100644 index 000000000..c9ce67720 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: e7ab0deee8b44daabe6f1a91f7893150 +* Ensure that the system has created a Persistent Volume for the Persistent Volume Claim. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-snapshotCreationEnabled.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-snapshotCreationEnabled.adoc new file mode 100644 index 000000000..b5ba48d7a --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-snapshotCreationEnabled.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 6e98039952c7493b968ee5210f15b6e2 +* 请确保后端存储系统支持卷快照功能，并已在持久卷声明对应的存储类上启用卷快照功能。有关更多信息，请参阅xref:05-cluster-management/10-storage/02-storage-classes/05-enable-and-disable-volume-operations.adoc[启用和禁用卷操作]。 diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-snapshotCreationEnabled_new.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-snapshotCreationEnabled_new.adoc new file mode 100644 index 000000000..4d3cc7023 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-snapshotCreationEnabled_new.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 6e98039952c7493b968ee5210f15b6e2 +* 请确保后端存储系统支持卷快照功能，并已在持久卷声明对应的存储类上启用卷快照功能。有关更多信息，请参阅xref:07-cluster-management/08-storage/02-storage-classes/05-enable-and-disable-volume-operations.adoc[启用和禁用卷操作]。 diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistent-volume-status.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistent-volume-status.adoc new file mode 100644 index 000000000..73e72a025 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistent-volume-status.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: f3350225a1bf47a3872722fd47af4d1d +The current status of the Persistent Volume. + +* **Available**: The Persistent Volume is not bound to any Persistent Volume claim. The {ks_product-en} web console currently does not support the direct creation of Persistent Volumes. If you create Persistent Volumes directly using backend command-line tools, the Persistent Volumes will have a status of **Available**. For more information, refer to the link:https://kubernetes.io/docs/concepts/storage/persistent-volumes/[Kubernetes Documentation]. + +* **Bound**: The Persistent Volume is already bound to a Persistent Volume claim. + +* **Released**: The Persistent Volume claim bound to the Persistent Volume has been deleted while the Persistent Volume itself has not been deleted. + +* **Failed**: The Persistent Volume encountered an unknown error. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-oper-openListPage.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-oper-openListPage.adoc new file mode 100644 index 000000000..fc9d4eb6f --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 1883d4e9bde042c4b93fa773d65ab3bb +. On the **Persistent Volume Claims** page, click **Persistent Volume** to open the list of Persistent Volumes. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-deletionPolicy.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-deletionPolicy.adoc new file mode 100644 index 000000000..cebc20d6b --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-deletionPolicy.adoc @@ -0,0 +1 @@ +// :ks_include_id: 12ad770d75ab40c4aae388e788227746 diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-provisioner.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-provisioner.adoc new file mode 100644 index 000000000..f25f6d4e7 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-provisioner.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 5134b15835954a9abac8672f75fbc92f +The storage plugin used by the storage class. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-pvcInformation.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-pvcInformation.adoc new file mode 100644 index 000000000..0b1cb1485 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-pvcInformation.adoc @@ -0,0 +1,27 @@ +// :ks_include_id: 97165dd8a39e4251913b19385f46901d +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Name +|The name of the persistent volume claim. + +|Storage Class +| +include::persistentVolumes-para-storageClass.adoc[] + +|Creation Time +|The creation time of the persistent volume claim. + +|Provisioner +| +include::persistentVolumes-para-provisioner.adoc[] + +|Access Mode +| +include::../persistentVolumeClaims/persistentVolumeClaims-para-accessMode.adoc[] + +|Capacity +| +include::persistentVolumes-para-volumeSize.adoc[] +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-reclaimPolicy.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-reclaimPolicy.adoc new file mode 100644 index 000000000..b2c396d01 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-reclaimPolicy.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 05055fc19ca74178ac595789b0863f6f +The reclaim policy of the Persistent Volume. KubeSphere defaults to the **Delete** reclaim policy, which means that when the Persistent Volume claim is deleted, the Persistent Volume is also deleted. For more information, refer to the link:https://kubernetes.io/docs/concepts/storage/storage-classes/[Kubernetes Documentation]. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-storageClass.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-storageClass.adoc new file mode 100644 index 000000000..30d084b17 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-storageClass.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 3fb3e081dbcf4e6ba9164671a38aa755 +The storage class requested by the Persistent Volume Claim. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-volumeSize.adoc b/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-volumeSize.adoc new file mode 100644 index 000000000..2f9489f3c --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-volumeSize.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d70b04812502488cacd1e6b813dcc70d +The capacity of the backend storage area. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/podIpPools/podIpPools-prer-enablePodIpPool.adoc b/content/en/docs/_custom-en/clusterManagement/podIpPools/podIpPools-prer-enablePodIpPool.adoc new file mode 100644 index 000000000..1a9898459 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/podIpPools/podIpPools-prer-enablePodIpPool.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 07a04c60e8c342db9bc6ec8108be9412 +ifeval::["{file_output_type}" == "html"] +* {ks_product-en}平台需要启用容器组 IP 池扩展组件。 +有关更多信息，请参阅 xref:04-platform-management/01-extension-management/_index.adoc[启用可插拔组件]。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +有关更多信息，请参阅《{ks_product-en}平台管理指南》的“扩展组件管理”章节。 +endif::[] \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/podIpPools/podIpPools-prer-notUsed.adoc b/content/en/docs/_custom-en/clusterManagement/podIpPools/podIpPools-prer-notUsed.adoc new file mode 100644 index 000000000..087801f5b --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/podIpPools/podIpPools-prer-notUsed.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 46eb4a2a26af4ed48dea4d01cf866136 +* 容器组 IP 池未被任何容器组使用。如果存在正在使用容器组 IP 池的容器组，您需要为容器组指定其他容器组 IP 池或删除容器组。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-accessAContainerTerminal.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-accessAContainerTerminal.adoc new file mode 100644 index 000000000..9e8cedf20 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-accessAContainerTerminal.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: 3bb6ac8d7b114854992775f89ab8debb +This section introduces how to access the container terminal. + +//note +[.admon.note,cols="a"] +|=== +|Note + +| +KubeSphere only supports accessing the terminal of running containers. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-deletePods.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-deletePods.adoc new file mode 100644 index 000000000..c44bcab15 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-deletePods.adoc @@ -0,0 +1,22 @@ +// :ks_include_id: 12077b1940064dbc91b46df1bb4d2390 +This section explains how to delete a pod. + +//note +[.admon.note,cols="a"] +|=== +|Note + +| +* It is recommended to delete a pod by removing its managing resources (e.g., workloads or jobs) rather than directly deleting the pod. + +* If you directly delete the pod, depending on the policy of the managing resources, the system may recreate the pod. +|=== + +//warning +[.admon.warning,cols="a"] +|=== +|Warning + +| +Deleting a running pod may cause a service interruption. Please proceed with caution. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-pods.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-pods.adoc new file mode 100644 index 000000000..282065ce0 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-pods.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 6a773c6c880441b0b453c3426a19cc8e +This section explains how to manage pods. + +In KubeSphere, a pod is the smallest management unit of an application. Each pod contains one or more containers. Multiple containers within the same pod are tightly coupled, scheduled, and share the same network. A pod is equivalent to the logical host of an application. + +The {ks_product-en} web console does not support creating pods directly, but you can indirectly create pods and manage pod replicas by creating workloads or jobs. diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-viewAPersistentVolumeList.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-viewAPersistentVolumeList.adoc new file mode 100644 index 000000000..d138ac1d2 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-viewAPersistentVolumeList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: e493355923a646c2aeb3e6de095c8aa0 +This section explains how to view the list of Persistent Volume Claims. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-viewAPodList.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-viewAPodList.adoc new file mode 100644 index 000000000..6c3227ee1 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-viewAPodList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 28a0c6fdb89548bb9027842de7697721 +This section explains how to view the list of pods. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-viewContainerDetails.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-viewContainerDetails.adoc new file mode 100644 index 000000000..fcde90a69 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-viewContainerDetails.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: 25f413cc757b4a79b6dd8d953602f1e9 +This section explains how to view container details. + +//note +[.admon.note,cols="a"] +|=== +|Note + +| +KubeSphere only supports viewing details of running containers, rather than containers that have already stopped running. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-viewPodDetails.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-viewPodDetails.adoc new file mode 100644 index 000000000..acc4b23d3 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-desc-viewPodDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 48b9b884c6114c8d9481866c41eda79c +This section explains how to view pod details. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-accessAContainerTerminal.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-accessAContainerTerminal.adoc new file mode 100644 index 000000000..2a50c1226 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-accessAContainerTerminal.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 1d8e328225714a61970419e6ff20593a +. On the **Resource Status** tab, in the **Containers** section, click image:/images/ks-qkcp/zh/icons/terminal.svg[terminal,18,18] on the right side of the container name to open the container terminal . You can use the terminal to run commands inside the container. + +. In the dropdown list at the top right corner of the container terminal page, select a container to quickly access the terminal of other containers in the same pod. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-deleteASinglePod.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-deleteASinglePod.adoc new file mode 100644 index 000000000..3cf65ae3c --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-deleteASinglePod.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 2a8675daa13541ae83846c5eb87d5ed7 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the pod you want to delete, then choose **Delete** from the dropdown list. + +. In the **Delete Pod** dialog, enter the name of the pod, then click **OK**. diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-deleteMultiplePods.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-deleteMultiplePods.adoc new file mode 100644 index 000000000..480b305db --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-deleteMultiplePods.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: c221a68eab6c49a89248bbc09f41a6f6 +. Select the checkbox on the left of the pods you want to delete, then click **Delete** above the pod list. + +. In the **Delete Multiple Pods** dialog, enter the name of the pods, then click **OK**. ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-openDetails.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-openDetails.adoc new file mode 100644 index 000000000..b92c344e2 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-openDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 30ad6c73ec764c0bab8d3e7638696a4a +. Click the name of a pod in the list to open its details page. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-searchForPods.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-searchForPods.adoc new file mode 100644 index 000000000..6d7273eae --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-searchForPods.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 991e787c19f9470cbc29655c78ddda5d +* Click the search box at the top of the list and search for pods by name, status or pod IP address. diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-viewContainerDetails.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-viewContainerDetails.adoc new file mode 100644 index 000000000..bd62eaae7 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-viewContainerDetails.adoc @@ -0,0 +1,88 @@ +// :ks_include_id: 8517e102a81e4402a8f9784a7931ff0c +. 在容器组详情页面右侧的**资源状态**页签，在**容器**区域点击一个容器的名称打开容器详情页面。 + +. 在容器详情页面左侧的**属性**区域查看容器的资源属性。 ++ +-- + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群 +|容器所属的集群。 + +|项目 +|容器所属的项目。 + +|应用 +|容器所属的应用。 + +|状态 +|容器的状态。 + +include::../workloads/workloads-para-containerStatus.adoc[] + +|镜像 ID +|容器使用的镜像的 ID。 + +|端口 +|容器的端口。 + +|命令 +|容器启动时在容器内部执行的命令。 + +|资源预留 +|系统为容器预留的 CPU 和内存资源。 + +|资源上限 +|容器可以使用的 CPU 和内存资源上限。 + +|镜像拉取策略 +|容器的镜像拉取策略。 + +* **优先使用本地镜像**：容器组创建或更新时，优先使用容器运行时存储在节点的镜像文件。 + +* **每次都拉取镜像**：容器组创建或更新时，每次都尝试从镜像服务拉取镜像。 + +* **仅使用本地镜像**：容器组创建或更新时，仅使用容器运行时存储在节点的镜像。如果本地不存在所需的镜像，容器创建将出现异常。 + +|重启次数 +|容器组的重启次数。 +|=== +-- + +. 在容器详情页面右侧的**资源状态**页签查看容器中挂载卷、卷的挂载路径和访问模式。 + +. 在容器详情页面右侧点击**监控**页签查看容器的实时资源使用情况。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|CPU 用量 +|容器的实时 CPU 用量。 + +|内存用量 +|容器的实时内存用量。 +|=== + +include::../../../../_ks_components-en/oper-selectTimeRange.adoc[] + +include::../../../../_ks_components-en/oper-Autorefresh.adoc[] + +include::../../../../_ks_components-en/oper-refreshData.adoc[] +-- + +. 在容器详情页面右侧点击**环境变量**页签查看容器的环境变量。 + +. 在容器详情页面右侧点击**容器日志**页签查看容器的标准输出日志。 ++ +-- +* 在右上角点击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/refresh-dark-white.svg[refresh-dark-white,18,18]可手动刷新数据。 + +* 在右上角点击image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download-dark-white,18,18]可下载日志文件。 +-- diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-viewContainerDetails_new.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-viewContainerDetails_new.adoc new file mode 100644 index 000000000..e73f6fb3c --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-viewContainerDetails_new.adoc @@ -0,0 +1,59 @@ +// :ks_include_id: 8517e102a81e4402a8f9784a7931ff0c +. On the right side of the pod details page, click the **Resource Status** tab, and in the **Containers** section, click the name of a container to open the container details page. + +. On the left side of the container details page, in the **Attributes** section, view the container's resource attributes. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Cluster +|The cluster to which the container belongs. + +|Project +|The project to which the container belongs. + +|Application +|The application to which the container belongs. + +|Status +|The status of the container. + +include::../workloads/workloads-para-containerStatus.adoc[] + +|Image +|The image used by the container. + +|Image ID +|The ID of the image used by the container. + +|Ports +|The ports of the container. + +|Command +|The command executed within the container at startup. + +|Resource Requests +|CPU and memory resources reserved by the system for the container. + +|Resource Limits +|The upper limits of CPU and memory resources that the container can use. + +|Image Pull Policy +|The image pull policy for the container. + +* **Use Local Image First**: When creating or updating a pod, prioritize using the images stored by the container runtime on the node. + +* **Pull Image Always**: When creating or updating a pod, pull the image from the image registry every time. + +* **Use Local Image Only**: When creating or updating a pod, only use the images stored by the container runtime on the node. If the required image is not available locally, the pod may be created with an exception. + +|Restarts +|The restart times of the container. +|=== +-- + +. On the right side of the container details page, click the **Resource Status** tab to view mounted volumes, the mount paths of volumes, and their access modes. + +. On the right side of the container details page, click the **Environment Variables** tab to view the environment variables of the container. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-viewPodDetails.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-viewPodDetails.adoc new file mode 100644 index 000000000..aaad67cbb --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-viewPodDetails.adoc @@ -0,0 +1,126 @@ +// :ks_include_id: cb41056b42b540b999804717abfd497a +. 在容器组详情页面左侧的**属性**区域查看容器组的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群 +|容器组所属的集群。 + +|项目 +|容器组所属的项目。 + +|应用 +|容器组所属的应用。 + +|状态 +|容器组的状态。 + +include::pods-para-podStatus.adoc[] + +include::pods-para-podIpPool.adoc[] + +|节点名称 +|容器组所在节点的名称。 + +|节点 IP 地址 +|容器组所在节点的 IP 地址。 + +|重启次数 +|容器组的重启次数。 + +|QoS 类型 +|容器组的服务质量类型（Quality of Service），由用户设置的容器内存上限、内存请求、CPU 上限和 CPU 请求决定。 + +include::pods-para-qosTypes.adoc[] + +|创建时间 +|容器组的创建时间。 + +|创建者 +|容器组的创建者。 +|=== +-- + +. 在容器组详情页面右侧的**资源状态**页签查看容器组中的容器和卷。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|容器 +|显示容器组运行的容器的名称、状态、重启次数和容器端口。容器状态类型包括： + +include::../workloads/workloads-para-containerStatus.adoc[] + +在容器名称右侧点击image:/images/ks-qkcp/zh/icons/log.svg[log,18,18]可查看容器日志。将光标悬停在**探针**可查看容器上配置的探针。 + +|卷 +|显示容器组中所有卷的名称、已挂载卷的容器以及卷在容器上的挂载路径。 +|=== +-- + +. 在容器组详情页面右侧点击**调度信息**页签查看容器组的调度结果和状态信息。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|调度结果 +|显示接收容器组的节点的名称。 + +|状态信息 +|显示容器组是否成功完成所有启动步骤。如果显示image:/images/ks-qkcp/zh/icons/success.svg[success,18,18]，则表明容器组已完成启动步骤，如果显示image:/images/ks-qkcp/zh/icons/error.svg[error,18,18]，则表明尚未完成启动步骤。 + +* **运行中**：容器组当前的状态是否为**运行中**。 + +* **容器组调度完成**：容器组是否已调度到节点。 + +* **容器组初始化完成**：容器组中的所有初始化容器是否已启动完成。 + +* **所有容器就绪**：容器组中的所有容器是否已启动完成。 + +* **容器组就绪**：容器组是否已就绪。 +|=== +-- + +. 在容器组详情页面右侧点击**元数据**页签查看容器组的标签和注解。 + +. 在容器组详情页面右侧点击**监控**页签查看容器组的实时资源使用情况。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|CPU 用量 +|容器组的实时 CPU 用量。 + +|内存用量 +|容器组的实时内存用量。 + +|出站流量 +|容器组的出站流量。 + +|入站流量 +|容器组的入站流量。 +|=== + +include::../../../../_ks_components-en/oper-selectTimeRange.adoc[] + +include::../../../../_ks_components-en/oper-Autorefresh.adoc[] + +include::../../../../_ks_components-en/oper-refreshData.adoc[] +-- + +. 在容器组详情页面右侧点击**环境变量**页签查看容器组中的所有容器的环境变量。 + +. 在容器组详情页面右侧点击**事件**页签查看容器组相关的事件。 ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-viewPodDetails_new.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-viewPodDetails_new.adoc new file mode 100644 index 000000000..8eb8c7f02 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-oper-viewPodDetails_new.adoc @@ -0,0 +1,99 @@ +// :ks_include_id: cb41056b42b540b999804717abfd497a +. View the resource attributes of the pod in the **Attributes** section on the left side of the pod details page. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Cluster +|The cluster to which the pod belongs. + +|Project +|The project to which the pod belongs. + +|Application +|The application to which the pod belongs. + +|Status +|The status of the pod. + +include::pods-para-podStatus.adoc[] + +include::pods-para-podIpPool.adoc[] + +|Node Name +|The name of the node where the pod is located. + +|Node IP Address +|The IP address of the node where the pod is located. + +|Restarts +|The number of times the pod has been restarted. + +|QoS Type +|The Quality of Service (QoS) type of the pod, determined by user-defined memory limits, memory requests, CPU limits, and CPU requests. + +include::pods-para-qosTypes.adoc[] + +|Creation Time +|The creation time of the pod. + +|Creator +|The creator of the pod. +|=== +-- + +. On the right side of the pod details page, click the **Resource Status** tab to view the containers and volumes in the pod. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Containers +|Displays the names, status, restarts, and container ports of the containers running in the pod. Container statuses include: + +include::../workloads/workloads-para-containerStatus.adoc[] + +Click image:/images/ks-qkcp/zh/icons/log.svg[log,18,18] next to the container name to view the container logs. Hover over **Probes** to view the configured probes in the container. + +|Volumes +|Displays the names of all volumes for the pod, the containers to which volumes are mounted, and the mount paths of volumes on containers. +|=== +-- + +. On the right side of the pod details page, click the **Scheduling Information** tab to view the scheduling results and status information of the pod. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Scheduling Result +|Displays the name of node that accepted the pod. + +|Status Information +|Shows whether the pod has successfully completed all startup steps. If image:/images/ks-qkcp/zh/icons/success.svg[success,18,18] is displayed, the pod has completed the startup steps; if image:/images/ks-qkcp/zh/icons/error.svg[error,18,18] is displayed, the startup steps are not yet completed. + +* **Running**: Whether the pod is in the **Running** state. + +* **Pod Scheduled**: Whether the pod has been scheduled to a node. + +* **Initialized**: Whether all init containers in the pod have started. + +* **Containers Ready**: Whether all containers in the pod have started. + +* **Pod Ready**: Whether the pod is ready. +|=== +-- + +. On the right side of the pod details page, click the **Metadata** tab to view the labels and annotations of the pod. + +. On the right side of the pod details page, click the **Environment Variables** tab to view the environment variables of all containers in the pod. + +. On the right side of the pod details page, click the **Events** tab to view events related to the pod. ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-para-podIpPool.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-para-podIpPool.adoc new file mode 100644 index 000000000..e155a46c0 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-para-podIpPool.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 279e5268acd74e4bb37c530cc08cc373 +| Pod IP Address +| The virtual IP address of the pod within the cluster. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-para-podList.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-para-podList.adoc new file mode 100644 index 000000000..e27d6c6c9 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-para-podList.adoc @@ -0,0 +1,28 @@ +// :ks_include_id: 9b12ede280884331985685925cf5dfc4 +* The pod list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Name +| The name of the pod. + +| Status +| The status of the pod. + +include::pods-para-podStatus.adoc[] + +| Node +| The node where the pod is located and the IP address of the node. + +include::pods-para-podIpPool.adoc[] + +| Application +| The application to which the pod belongs. + +| Update Time +| The update time of the pod. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-para-podStatus.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-para-podStatus.adoc new file mode 100644 index 000000000..870878c42 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-para-podStatus.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 8cc83a9c58b8460cbcf369b1a07288b1 +* **Running**: The pod has been assigned to a node, all containers in the pod have been created, and at least one container is running, starting, or restarting. + +* **Waiting**: The pod has been accepted by the system, but at least one container has not been created or is not running. In this state, the pod may be waiting for scheduling or waiting for the container image to finish downloading. + +* **Completed**: All containers in the pod have successfully terminated (terminated with an exit code of 0), and no longer restart. + +* **Failed**: All containers in the pod have terminated, and at least one container terminated with a non-zero exit code. + +* **Unknown**: The system cannot retrieve the pod's status, which usually occurs when communication fails between the system and the host where the pod is located. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/pods/pods-para-qosTypes.adoc b/content/en/docs/_custom-en/clusterManagement/pods/pods-para-qosTypes.adoc new file mode 100644 index 000000000..362cfaae4 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/pods/pods-para-qosTypes.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 6dc8492ff19d4f1bb83db24a36e18f07 +* **Guaranteed**: Each container in the pod has memory limits, memory requests, CPU limits, and CPU requests, and the memory limit is equal to the memory request, and the CPU limit is equal to the CPU request. + +* **Burstable**: At least one container in the pod does not meet the requirements of the **Guaranteed** type. + +* **BestEffort**: Containers in the pod do not configured with any memory limits, memory requests, CPU limits, or CPU requests. + +The QoS type of the pod determines the running priority of the pod. When resources in the system is insufficient to run all pods, the system gives priority to running pods of QoS type **Guaranteed** first, followed by pods of QoS type **Burstable**, and finally, pods of QoS type **BestEffort**. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/projects/projects-desc-deleteProjects.adoc b/content/en/docs/_custom-en/clusterManagement/projects/projects-desc-deleteProjects.adoc new file mode 100644 index 000000000..995bf23d0 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/projects/projects-desc-deleteProjects.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 375914907c6948b08ccff616aa99831d +This section explains how to delete projects. + +//warning +[.admon.warning,cols="a"] +|=== +|Warning + +|Once a project is deleted, it cannot be recovered, and all resources within the project will be deleted. Please proceed with caution. +|=== diff --git a/content/en/docs/_custom-en/clusterManagement/projects/projects-desc-editDefaultContainerQuotas.adoc b/content/en/docs/_custom-en/clusterManagement/projects/projects-desc-editDefaultContainerQuotas.adoc new file mode 100644 index 000000000..91277f710 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/projects/projects-desc-editDefaultContainerQuotas.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 61bf4ea84b3d4363b5a4ebfacd921138 +This section explains how to edit default container quotas. + +Default container quotas are the default values for resource request and resource limit for containers in the project. When creating containers in the project, if users do not specify resource request and limit, the containers will automatically use the default container quotas. + +Default container quotas include two types of settings: + +* Resource Request: Resources reserved by the system for containers. + +* Resource Limit: The upper limit of resources that containers can use. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/projects/projects-desc-editInformation.adoc b/content/en/docs/_custom-en/clusterManagement/projects/projects-desc-editInformation.adoc new file mode 100644 index 000000000..2343b4407 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/projects/projects-desc-editInformation.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 3b10cc989bca4453829299e49cd5a026 +This section explains how to edit project information. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/projects/projects-desc-editQuotas.adoc b/content/en/docs/_custom-en/clusterManagement/projects/projects-desc-editQuotas.adoc new file mode 100644 index 000000000..b8affe0bf --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/projects/projects-desc-editQuotas.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: c47c51f776564c1bba3cf7decf79a67d +This section explains how to edit project quotas. + +Project quotas include the following settings: + +* Resource Request: Container resource request is the system's reserved resources for a single container, and project resource request is the maximum value of the sum of all container resource requests in the project. KubeSphere currently supports setting CPU request and memory request for the project. + +* Resource Limit: Container resource limit is the upper limit of resources that a single container can use, and project resource limit is the maximum value of the sum of all container resource limits in the project. KubeSphere currently supports setting CPU limit, memory limit, and GPU limit for the project. + +* Storage Resource Quota: Limitations on the total amount of storage resources in the project, including the total amount of storage resources and associated resources with storage classes. + +* Application Resource Quota: Upper limits on the quantity of Pods, Deployments, StatefulSets, DaemonSets, Jobs, CronJobs, Persistent Volume Claims, Services, Ingresses, Secrets, and ConfigMaps that can be created in the project. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/projects/projects-note-editInformation.adoc b/content/en/docs/_custom-en/clusterManagement/projects/projects-note-editInformation.adoc new file mode 100644 index 000000000..f17379858 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/projects/projects-note-editInformation.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: be828c992784487d9adf58c381e48b5a +You can edit the alias and description of the project. KubeSphere does not support editing the name of an already created project. diff --git a/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-deleteASingleProject.adoc b/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-deleteASingleProject.adoc new file mode 100644 index 000000000..7ec5bf7d0 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-deleteASingleProject.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 6f57a346768f432a9a776a26c0ab55b4 +. On the right side of the project you want to delete, click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18], and then select **Delete** from the drop-down list. + +. In the **Delete Project** dialog, enter the name of the project, then click **OK**. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-deleteMultipleProjects.adoc b/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-deleteMultipleProjects.adoc new file mode 100644 index 000000000..3dbee3d34 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-deleteMultipleProjects.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: c31e22ed93ad4f3fa0500c5bb67c80e3 +. Select the checkbox on the left of the projects you want to delete, then click **Delete** above the project list. + +. In the **Delete Multiple Projects** dialog, enter the name of the projects, then click **OK**. ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-editDefaultContainerQuotas.adoc b/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-editDefaultContainerQuotas.adoc new file mode 100644 index 000000000..f20ee32c3 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-editDefaultContainerQuotas.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: eae1dea548f94792b303903d436d1b25 +. In the **Edit Default Container Quotas** dialog, set the default resource request and resource limit for containers, then click **OK**. ++ +-- +[options="header",cols="1a,4a"] +|=== +|Parameter |Description + +include::projects-para-containerQuotas.adoc[] +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-editInformation.adoc b/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-editInformation.adoc new file mode 100644 index 000000000..b3aac8682 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-editInformation.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: a1b9b1a5e4b74f6083a9dbf399919ea3 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the project you want to edit, then choose **Edit Information** from the dropdown list. + +. In the **Edit Information** dialog, set the alias and description for the project, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Alias +| The alias of the project. Aliases can be the same for different projects. An alias can only contain Chinese characters, letters, numbers, and hyphens (-). It cannot start or end with a hyphen (-) and has a maximum length of 63 characters. + +| Description +| The description for the project. The description can contain any characters, with a maximum length of 256 characters. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-editProjectQuotas-for-kubefed.adoc b/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-editProjectQuotas-for-kubefed.adoc new file mode 100644 index 000000000..461eb64a2 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-editProjectQuotas-for-kubefed.adoc @@ -0,0 +1,38 @@ +// :ks_include_id: 5e0c07e44f1440999412a1ec7581f173 +. 在**编辑项目配额**对话框，设置项目资源预留和资源上限。 ++ +-- + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|CPU 预留 +|项目中所有容器 CPU 预留总和的最大值，单位为核。 + +|CPU 上限 +|项目中所有容器 CPU 上限总和的最大值，单位为核。 + +|内存预留 +|项目中所有容器内存预留总和的最大值，单位为 GiB。 + +|内存上限 +|项目中所有容器内存上限总和的最大值，单位为 GiB。 + +|GPU 类型 +|项目中容器所能使用的 GPU 类型。目前仅支持设置 NVIDIA GPU。 + +|GPU 上限 +|项目中所有容器可以使用的 GPU 数量上限，单位为 GPU。 +|=== +-- + +. 在**编辑项目配额**对话框的**存储资源配额**区域，设置存储资源总量和存储类关联资源。 + +. 在**编辑项目配额**对话框的**应用资源配额**区域，设置项目的应用资源数量上限，然后点击**确定**。 ++ +-- +* 您可以设置项目中容器组、部署、有状态副本集、持久卷声明、服务、应用路由、保密字典和配置字典的数量上限。 + +* 点击**添加**可以设置多种应用资源的数量上限。 +-- diff --git a/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-editProjectQuotas.adoc b/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-editProjectQuotas.adoc new file mode 100644 index 000000000..37c0f264b --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-editProjectQuotas.adoc @@ -0,0 +1,36 @@ +. In the **Edit Project Quotas** dialog, set the project resource request and resource limit. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|CPU Request +|The maximum value of the sum of all container CPU requests in the project, measured in cores. + +|CPU Limit +|The maximum value of the sum of all container CPU limits in the project, measured in cores. + +|Memory Request +|The maximum value of the sum of all container memory requests in the project, measured in GiB. + +|Memory Limit +|The maximum value of the sum of all container memory limits in the project, measured in GiB. + +|GPU Type +|The GPU type that containers in the project can use. Currently, only NVIDIA GPU is supported. + +|GPU Limit +|The maximum number of GPUs that all containers in the project can use, measured in GPUs. +|=== +-- + +. In the **Storage Resource Quota** section of the **Edit Project Quotas** dialog, set the total storage resource quota and associated resource quota with storage classes. + +. In the **Application Resource Quotas** section of the **Edit Project Quotas** dialog, set the upper limits on the quantity of application resources in the project, then click **OK**. ++ +-- +* You can set upper limits on the quantity of Pods, Deployments, StatefulSets, DaemonSets, Jobs, CronJobs, Persistent Volume Claims, Services, Ingresses, Secrets, and ConfigMaps in the project. + +* Click **Add** to set upper limits on the quantity of more application resources. +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-openDetailsPage.adoc new file mode 100644 index 000000000..7e8b88993 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9758f6b782ed465d85796e1e69cd0d24 +. In the project list, click the name of a project to open its details page. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-openListPage.adoc b/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-openListPage.adoc new file mode 100644 index 000000000..df73314ff --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/projects/projects-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9bb9485dfa1c46809ddf90db983f76a1 +. On the **Projects** page, click **User Projects** or **System Projects** to open the user project list or system project list. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/projects/projects-para-aliasDescription.adoc b/content/en/docs/_custom-en/clusterManagement/projects/projects-para-aliasDescription.adoc new file mode 100644 index 000000000..f552faa55 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/projects/projects-para-aliasDescription.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 33f27ee37c1e4b36a0fb2c4e22a65e3f +|Alias +|The alias of the project. Aliases can be the same for different projects. Aliases can only contain Chinese characters, letters, numbers, and hyphens (-). They must not start or end with a hyphen (-) and have a maximum length of 63 characters. + +|Description +|The description of the project. Description can contain any characters, with a maximum length of 256 characters. diff --git a/content/en/docs/_custom-en/clusterManagement/projects/projects-para-containerQuotas.adoc b/content/en/docs/_custom-en/clusterManagement/projects/projects-para-containerQuotas.adoc new file mode 100644 index 000000000..f6ed7968b --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/projects/projects-para-containerQuotas.adoc @@ -0,0 +1,18 @@ +// :ks_include_id: ed53650f20d543ee95f0aa14ff7b5f1e +|CPU Request +|Reserved CPU resources for a container, measured in cores. + +|CPU Limit +|Upper limit of CPU resources that a container is allowed to use, measured in cores. + +|Memory Request +|Reserved memory resources for a container, measured in MiB. + +|Memory Limit +|Upper limit of memory resources that a container is allowed to use, measured in MiB. + +|GPU Type +|The GPU type that containers in the project can use. Currently, only NVIDIA GPU is supported. + +|GPU Limit +|Upper limit on the number of GPUs that a container is allowed to use, measured in GPUs. diff --git a/content/en/docs/_custom-en/clusterManagement/projects/projects-para-defaultContainerQuotas.adoc b/content/en/docs/_custom-en/clusterManagement/projects/projects-para-defaultContainerQuotas.adoc new file mode 100644 index 000000000..538268236 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/projects/projects-para-defaultContainerQuotas.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 405d1688f4c345f49660198dbd4b2728 +|Default Container Quotas +|Default CPU request, CPU limit, memory request, memory limit, GPU type, and GPU limit for containers in the project. If not specifically configured, newly created containers in the project will use the default container quotas of the project. diff --git a/content/en/docs/_custom-en/clusterManagement/projects/projects-para-name.adoc b/content/en/docs/_custom-en/clusterManagement/projects/projects-para-name.adoc new file mode 100644 index 000000000..bfac83466 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/projects/projects-para-name.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 2e7858bd5eb64ceab90c370e0337800c +|Name +|The name of the project. Project names must be unique within the same cluster. Names can only contain lowercase letters, numbers, and hyphens (-). They must start with a lowercase letter and end with a lowercase letter or number, with a maximum length of 63 characters. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/projects/projects-para-projectQuotas.adoc b/content/en/docs/_custom-en/clusterManagement/projects/projects-para-projectQuotas.adoc new file mode 100644 index 000000000..d06c3f738 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/projects/projects-para-projectQuotas.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: 73b804640f4d4157bd471a68e571e284 +|Project Quotas +| The amount of available resources in the project and their actual usage, including: + +* CPU request, CPU limit, memory request, memory limit, GPU type, and GPU limit for all containers in the project. + +* Maximum number of Deployments, StatefulSets, DaemonSets, Jobs, CronJobs, PVC, Services, Ingresses, Secrets, and ConfigMaps allowed to be created in the project. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/projects/projects-para-status.adoc b/content/en/docs/_custom-en/clusterManagement/projects/projects-para-status.adoc new file mode 100644 index 000000000..eeddb626f --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/projects/projects-para-status.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 278f7336e01e4f89b34d41a866b7acd0 +Current status of the project. + +* **Active**: The project is in normal status. + +* **Deleting**: The project is being deleted. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-accessABackendServiceOfARoute.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-accessABackendServiceOfARoute.adoc new file mode 100644 index 000000000..223817d3d --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-accessABackendServiceOfARoute.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 5bc648d25864430e9749aa0c567555f3 +本节介绍如何访问应用路由的后端服务。 + +应用路由创建完成后，您可通过任意 HTTP 或 HTTPS 客户端访问应用路由的后端服务。取决于集群网关或项目网关的外部访问模式，您可以使用以下访问方式： + +* 如果集群网关或项目网关的外部访问模式为 NodePort，您可以通过域名、路径和端口号（例如 **example.com/test:30240**）访问应用路由的后端服务。 + +* 如果集群网关或项目网关的外部访问模式为 LoadBalancer，您可以通过域名和路径（例如 **example.com/test**）访问应用路由的后端服务。 + +以下仅演示如何在{ks_product-en} Web 控制台测试应用路由是否设置正确。 diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-createARoute.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-createARoute.adoc new file mode 100644 index 000000000..1c1ac0ecf --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-createARoute.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 797c5d8830fe45bfb4452dd98086d8ed +本节介绍如何创建应用路由。 diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-deleteMultipleRoutes.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-deleteMultipleRoutes.adoc new file mode 100644 index 000000000..9319461db --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-deleteMultipleRoutes.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 4f3a812c48b342fdb0cec7f38b00ce81 +本节介绍如何删除应用路由。 + +// Warning +include::../../../../_ks_components-en/admonitions/warning.adoc[] + +删除应用路由后将无法通过应用路由访问其后端的服务，请谨慎执行此操作。 + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-editRouteAnnotations.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-editRouteAnnotations.adoc new file mode 100644 index 000000000..4624887ba --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-editRouteAnnotations.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9a1f0d5fdb294c79a6051a90fe1a17be +本节介绍如何编辑应用路由注解。 diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-editRouteInformation.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-editRouteInformation.adoc new file mode 100644 index 000000000..bc44f6f7c --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-editRouteInformation.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: ab9cb5143fe449bb900ce47e7fb62049 +本节介绍如何编辑应用路由信息。 + +您可以编辑应用路由的别名和描述。{ks_product-en}不支持编辑已创建应用路由的名称。 diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-editingRutingRules.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-editingRutingRules.adoc new file mode 100644 index 000000000..e3aa5e477 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-editingRutingRules.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: b4c404ff621146f799e720597d3aac84 +本节介绍如何编辑路由规则。 diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-routes.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-routes.adoc new file mode 100644 index 000000000..7a1918009 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-routes.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: c69900173bca4b109a4b8a178ce15e64 +本节介绍如何管理应用路由。 + +应用路由用于对服务进行聚合并提供给集群外部访问。每个应用路由包含域名及其子路径到不同服务的映射规则。来自客户端的业务流量先发送给集群网关或项目网关，集群网关或项目网关根据应用路由中定义的规则将业务流量转发给不同的服务，从而实现对多个服务的反向代理。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-viewARouteList.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-viewARouteList.adoc new file mode 100644 index 000000000..c90792cf4 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-viewARouteList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 74e87c7e7c4a42b59f6c9013b617a2f7 +本节介绍如何查看应用路由列表。 diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-viewRouteDetails.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-viewRouteDetails.adoc new file mode 100644 index 000000000..973006db1 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-desc-viewRouteDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c74f0c52dbf440a98ed71f677036f155 +本节介绍如何查看应用路由详情。 diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-note-annotations.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-note-annotations.adoc new file mode 100644 index 000000000..d4b9a91aa --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-note-annotations.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: b5b7ecc42a4f49a583613c4e211cd53f +// Note +include::../../../../_ks_components-en/admonitions/note.adoc[] + +{ks_product-en}的集群网关和项目网关底层基于 Nginx Ingress Controller 实现。您可以在应用路由上设置注解控制网关的行为。有关更多信息，请参阅 link:https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/[Nginx Ingress Controller 官方文档]。 + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-accessABackendServiceOfARoute.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-accessABackendServiceOfARoute.adoc new file mode 100644 index 000000000..12d49c42b --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-accessABackendServiceOfARoute.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: f51f45c2029a4242ad04da5a1fe817c7 +. 在**资源状态**页签，在需要访问的路由规则右侧点击**访问服务**。 ++ +-- +如果应用路由设置正确，浏览器将显示后端服务的响应信息。 +-- diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-createARoute.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-createARoute.adoc new file mode 100644 index 000000000..e76b41733 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-createARoute.adoc @@ -0,0 +1,41 @@ +// :ks_include_id: 570405898db841389a0ce7ed42a9a8e3 +. 在**基本信息**页签，设置应用路由的基本信息，然后点击**下一步**。 ++ +-- + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|应用路由的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 253 个字符。 + +|别名 +|应用路由的别名。不同应用路由的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|应用路由的描述。描述可包含任意字符，最长 256 个字符。 +|=== +-- + +. 在**路由规则**页签，点击**添加路由规则**，设置路由规则参数，然后点击**下一步**。 ++ +-- +ifdef::multicluster[] +include::../../multi-clusterProjectManagement/routes/routes-create-ClusterDiff.adoc[] +endif::[] + +include::routes-para-routingRules.adoc[] +-- + +. 在**高级设置**页签，为应用路由设置标签和注解，然后点击**创建**。 ++ +-- +* 点击**添加**可设置多条标签或注解。 + +* 在已创建的标签或注解右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除标签或注解。 + +include::routes-note-annotations.adoc[] + +应用路由创建完成后将显示在应用路由列表中。 +-- diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-createARoute_v4.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-createARoute_v4.adoc new file mode 100644 index 000000000..abfa74d5e --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-createARoute_v4.adoc @@ -0,0 +1,49 @@ +// :ks_include_id: 570405898db841389a0ce7ed42a9a8e3 +. 在**基本信息**页签，设置应用路由的基本信息，然后点击**下一步**。 ++ +-- + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|应用路由的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 253 个字符。 + +|别名 +|应用路由的别名。不同应用路由的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|应用路由的描述。描述可包含任意字符，最长 256 个字符。 +|=== +-- + +. 在**路由规则**页签，点击**添加路由规则**，设置路由规则参数，然后点击**下一步**。 ++ +-- +ifdef::multicluster[] +include::../../multi-clusterProjectManagement/routes/routes-create-ClusterDiff.adoc[] +endif::[] + +include::routes-para-routingRules.adoc[] +-- + +. 在**高级设置**页签，为应用路由设置标签和注解，然后点击**创建**。 ++ +-- +* 点击**添加**可设置多条标签或注解。 + +* 在已创建的标签或注解右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除标签或注解。 + +include::routes-note-annotations.adoc[] + +[.admon.note,cols="a"] +|=== +|说明 + +| +安装“KubeSphere 网关”扩展组件，并启用集群网关、企业空间网关、或项目网关后，创建应用路由时，需要在**高级设置**页签选择对应网关的 IngressClassName。 +|=== + +应用路由创建完成后将显示在应用路由列表中。 +-- diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-deleteASingleRoute.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-deleteASingleRoute.adoc new file mode 100644 index 000000000..09b73480f --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-deleteASingleRoute.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 1e5380a648764bae9ac650a53316501d +. 在需要删除的应用路由右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除应用路由**对话框，输入应用路由的名称，然后点击**确定**。 diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-deleteRoutes.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-deleteRoutes.adoc new file mode 100644 index 000000000..536468c05 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-deleteRoutes.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 6ec380c8bcbe4e1589334e0b050b0b6c +. 选择需要删除的应用路由左侧的复选框，然后在应用路由列表上方点击**删除**。 + +. 在**批量删除应用路由**对话框，输入应用路由的名称，然后点击**确定**。 ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-editRouteAnnotations.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-editRouteAnnotations.adoc new file mode 100644 index 000000000..bb9c9bf62 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-editRouteAnnotations.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: 2ead4c416e934d44b2a8a404251bdfe8 +. 在需要操作的应用路由右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑注解**。 + +. 在**编辑注解**对话框，设置注解键值对，然后点击**确定**。 ++ +-- +* 点击**添加**可设置多条注解。 + +* 在已创建的注解右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除注解。 + +include::routes-note-annotations.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-editRouteInformation.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-editRouteInformation.adoc new file mode 100644 index 000000000..63873270a --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-editRouteInformation.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: 9f1f9315fbc0466396a168bfa897683f +. 在需要操作的应用路由右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置应用路由的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|应用路由的别名。不同应用路由的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|应用路由的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-editRoutingRules.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-editRoutingRules.adoc new file mode 100644 index 000000000..5eb07ec8d --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-editRoutingRules.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: b0e0fbee5bf54cfda0ac0d8847b90185 +. 在需要操作的应用路由右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑路由规则**。 + +. 在**编辑路由规则**对话框，设置路由规则，然后点击**确定**。 ++ +-- +include::routes-para-routingRules.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-openDetailsPage.adoc new file mode 100644 index 000000000..0e7bcfcb7 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 01c521d890b44fab91dfa6803d6a6bb5 +. 在应用路由列表中点击一个应用路由的名称打开其详情页面。 diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-searchForRoutes.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-searchForRoutes.adoc new file mode 100644 index 000000000..1b3de39de --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-searchForRoutes.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: a3a4d6c4c46d4b8dbf054da9c20cd804 +* 在列表上方点击搜索框并设置搜索条件，可按名称搜索应用路由。 diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-viewRouteDetails-for-kubefed.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-viewRouteDetails-for-kubefed.adoc new file mode 100644 index 000000000..2b9693b76 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-viewRouteDetails-for-kubefed.adoc @@ -0,0 +1,70 @@ +// :ks_include_id: 02ac1cebc06f4893a036c2e77c21d999 +. 在应用路由详情页面左侧的**属性**区域查看应用路由的详细信息。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// |集群 +// |应用路由的所属集群。 + +|项目 +|应用路由的所属项目。 + +|应用 +|应用路由对应的应用。 + +// |网关地址 +// | +// include::../gatewaySettings/gatewaySettings-para-address.adoc[] + +|创建时间 +|应用路由的创建时间。 + +|创建者 +|创建应用路由的用户。 +|=== +-- + +. 在应用路由详情页面右侧的**资源状态**页签查看应用路由的路由规则。 ++ +-- +**资源状态**页签显示当前应用路由的所有路由规则。 +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|域名和端口 +|应用路由的域名和节点端口号。节点端口号仅在集群网关或项目网关的外部访问为 NodePort 时显示。 + +* 如果集群网关或项目网关的外部访问模式为 NodePort，客户端需要通过 DNS 服务或本地 **hosts** 文件将域名解析为集群中任意节点的 IP 地址，并通过域名、路径和端口号（例如 **example.com/test:30240**）访问应用路由。 + +* 如果集群网关或项目网关的外部访问模式为 LoadBalancer，客户端需要通过 DNS 服务或本地 **hosts** 文件将域名解析为项目网关负载均衡器的 IP 地址，并通过域名和路径（例如 **example.com/test**）访问应用路由。 + +|协议 +|应用路由支持的协议，取值为**HTTP** 或 **HTTPS**。 + +|证书 +|应用路由协议为 HTTPS 时，所使用的包含证书和私钥的保密字典的名称。仅在应用路由协议为 HTTPS 时显示。 + +|路径 +|域名的路径，每条路径对应一个服务。 + +|服务 +|域名路径所对应的服务的名称。 + +|端口 +|域名路径所对应的服务的端口号。 +|=== + +在路由规则右侧点击**访问服务**可访问应用路由的后端服务。 +-- + +. 在应用路由详情页面右侧点击**元数据**页签查看应用路由的**标签**和**注解**。 + +. 在应用路由详情页面右侧点击**事件**页签查看应用路由的事件。 ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-viewRouteDetails.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-viewRouteDetails.adoc new file mode 100644 index 000000000..b9719abb1 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-oper-viewRouteDetails.adoc @@ -0,0 +1,70 @@ +// :ks_include_id: 02ac1cebc06f4893a036c2e77c21d999 +. 在应用路由详情页面左侧的**属性**区域查看应用路由的详细信息。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群 +|应用路由的所属集群。 + +|项目 +|应用路由的所属项目。 + +|应用 +|应用路由对应的应用。 + +|网关地址 +| +include::../gatewaySettings/gatewaySettings-para-address.adoc[] + +|创建时间 +|应用路由的创建时间。 + +|创建者 +|创建应用路由的用户。 +|=== +-- + +. 在应用路由详情页面右侧的**资源状态**页签查看应用路由的路由规则。 ++ +-- +**资源状态**页签显示当前应用路由的所有路由规则。 +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|域名和端口 +|应用路由的域名和节点端口号。节点端口号仅在集群网关或项目网关的外部访问为 NodePort 时显示。 + +* 如果集群网关或项目网关的外部访问模式为 NodePort，客户端需要通过 DNS 服务或本地 **hosts** 文件将域名解析为集群中任意节点的 IP 地址，并通过域名、路径和端口号（例如 **example.com/test:30240**）访问应用路由。 + +* 如果集群网关或项目网关的外部访问模式为 LoadBalancer，客户端需要通过 DNS 服务或本地 **hosts** 文件将域名解析为项目网关负载均衡器的 IP 地址，并通过域名和路径（例如 **example.com/test**）访问应用路由。 + +|协议 +|应用路由支持的协议，取值为**HTTP** 或 **HTTPS**。 + +|证书 +|应用路由协议为 HTTPS 时，所使用的包含证书和私钥的保密字典的名称。仅在应用路由协议为 HTTPS 时显示。 + +|路径 +|域名的路径，每条路径对应一个服务。 + +|服务 +|域名路径所对应的服务的名称。 + +|端口 +|域名路径所对应的服务的端口号。 +|=== + +在路由规则右侧点击**访问服务**可访问应用路由的后端服务。 +-- + +. 在应用路由详情页面右侧点击**元数据**页签查看应用路由的**标签**和**注解**。 + +. 在应用路由详情页面右侧点击**事件**页签查看应用路由的事件。 ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-para-routeList.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-para-routeList.adoc new file mode 100644 index 000000000..f8b10f72a --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-para-routeList.adoc @@ -0,0 +1,22 @@ +// :ks_include_id: ae74df332c484c09b5ea8272c0d8193c +* 应用路由列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|应用路由的名称和描述。 + +|网关地址 +| +include::../gatewaySettings/gatewaySettings-para-address.adoc[] + +|应用 +|应用路由所对应的应用名称。 + +|创建时间 +|应用路由的创建时间。 +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-para-routingRules.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-para-routingRules.adoc new file mode 100644 index 000000000..4f97c8493 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-para-routingRules.adoc @@ -0,0 +1,27 @@ +// :ks_include_id: cd11a468685d4e6fadc53bf1c8827311 +* 点击**添加路由规则**可设置路由规则。您可以设置多条路由规则，每条规则对应一个域名。 + +* 将光标悬停在已创建的路由规则上，然后在右侧点击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]可删除路由规则。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|域名 +|用户自定义的域名。 + +|协议 +|应用路由支持的协议，参数值可以为 **HTTP** 或 **HTTPS**。 + +|保密字典 +|应用路由协议为 **HTTPS** 时，用于提供证书和密钥的保密字典。该保密字典必须包含 **tls.cert** 和 **tls.key** 字段，分别存储 Base64 编码的证书和私钥。 + +|路径 +|域名路径及其与服务端口的映射关系。 + +* 点击**添加**可设置多条路径。 + +* 在已创建的路径右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除路径。 +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/routes/routes-prer-accessABackendServiceOfARoute.adoc b/content/en/docs/_custom-en/clusterManagement/routes/routes-prer-accessABackendServiceOfARoute.adoc new file mode 100644 index 000000000..e7b5f61ac --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/routes/routes-prer-accessABackendServiceOfARoute.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: d8a06afae96b4c0bbb29c390f1fe18f5 +* 客户端必须通过本地 **hosts** 文件或 DNS 服务将域名解析为网关 IP 地址。 + +* 客户端必须与网关 IP 地址网络连通。有关更多信息，请联系您的网络环境管理员。 diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-alertingPolicies.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-alertingPolicies.adoc new file mode 100644 index 000000000..1072b10e4 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-alertingPolicies.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 1cfd19f4d02645328faf321e1d5af473 +本节介绍如何创建、编辑、启用、禁用和查看告警规则组。 + +{ks_product-en}提供了内置的规则组，同时也支持自定义规则组。通过规则组，系统可在特定监控指标满足预设条件和持续时间时生成告警。 diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-createAnAlertingPolicy.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-createAnAlertingPolicy.adoc new file mode 100644 index 000000000..02ab7cb20 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-createAnAlertingPolicy.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: e19cfac61c85491d9f631ba61f012c62 +本节介绍如何创建告警规则组。 + +{ks_product-en}的监控告警功能底层基于 Promtheus 实现，每个规则组可包含多条告警规则。您可以使用系统提供的规则模板创建告警规则，也可手动输入 PromQL 表达式创建告警规则。有关更多信息，请参阅 link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus 官方文档]。 diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-deleteAlertingPolicies.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-deleteAlertingPolicies.adoc new file mode 100644 index 000000000..fe6446f93 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-deleteAlertingPolicies.adoc @@ -0,0 +1,16 @@ +// :ks_include_id: afa42dbe50664f968d66928b7d9b75d6 +本节介绍如何删除告警规则组。 + +// Note +include::../../../../_ks_components-en/admonitions/note.adoc[] + +{ks_product-en}仅支持删除自定义规则组，不支持删除内置规则组。 + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] + +// Warning +include::../../../../_ks_components-en/admonitions/warning.adoc[] + +规则组删除后不能恢复，请谨慎执行此操作。 + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-disableAndEnablerRuleGroups.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-disableAndEnablerRuleGroups.adoc new file mode 100644 index 000000000..4969e4533 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-disableAndEnablerRuleGroups.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 43829ece490644d8ba2c2e823ad90719 +本节介绍如何启用和禁用告警规则组。规则组禁用后，系统将不再根据规则组生成告警。 diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-editAnAlertingPolicy.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-editAnAlertingPolicy.adoc new file mode 100644 index 000000000..e3bb536ca --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-editAnAlertingPolicy.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 50920b439c7f4f4e996fecec215f24ed +本节介绍如何编辑规则组中的告警规则。 + +// Note +include::../../../../_ks_components-en/admonitions/note.adoc[] + +{ks_product-en}仅支持编辑自定义规则组，不支持编辑内置规则组。 + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-editRuleGroupInformation.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-editRuleGroupInformation.adoc new file mode 100644 index 000000000..d028e0bf3 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-editRuleGroupInformation.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: d62dbb9307bf4f21a25a732737dbe531 +本节介绍如何编辑告警规则组信息。 + +您可以编辑告警规则组的别名、检查周期和描述。{ks_product-en}不支持编辑规则组的名称。 diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-viewAlertingPolicyDetails.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-viewAlertingPolicyDetails.adoc new file mode 100644 index 000000000..3e78ae8f8 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-viewAlertingPolicyDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 60f5fd04585b4a97bb5c99721f03edcb +本节介绍如何查看告警规则组详情。 diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-viewAnAlertingPolicyList.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-viewAnAlertingPolicyList.adoc new file mode 100644 index 000000000..ca6ae86b5 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-desc-viewAnAlertingPolicyList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 75e22548eee741e48e1bcf6c7499fc65 +本节介绍如何查看告警规则组列表。 diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-addAlertRule.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-addAlertRule.adoc new file mode 100644 index 000000000..a2a5defb7 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-addAlertRule.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: b8f6aaa1104a42b3a0856ce1f21e1cea +. 在**告警规则**页签，点击**添加告警规则**，根据需要选择**规则模板**或**自定义规则**设置告警规则。 diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-clickEditInformation.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-clickEditInformation.adoc new file mode 100644 index 000000000..d0c99e3b8 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-clickEditInformation.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 1f7f6ffdb0cb446689a451e85ddf8d11 +. 在需要编辑的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-clickOK.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-clickOK.adoc new file mode 100644 index 000000000..e65b60517 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-clickOK.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 513da96dc1b64eb9af9a791f349a9fce +. 完成告警规则设置后点击image:/images/ks-qkcp/zh/icons/check-dark.svg[check,18,18]保存设置，然后点击**创建**。 ++ +-- +规则组创建完成后将显示在规则组列表中。 +-- diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-deleteASingleAlertingPolicy.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-deleteASingleAlertingPolicy.adoc new file mode 100644 index 000000000..2e811a793 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-deleteASingleAlertingPolicy.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 0b6f7a63668142ce8f5d70a7f013a852 +. 在需要删除的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除规则组**对话框，输入规则组的名称，然后点击**确定**。 diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-deleteMultipleAlertingPolicies.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-deleteMultipleAlertingPolicies.adoc new file mode 100644 index 000000000..1d9f80a10 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-deleteMultipleAlertingPolicies.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: c98f892c063d4948889dcb04d2bef599 +. 勾选需要删除的规则组左侧的复选框，然后在规则组列表上方点击**删除**。 + +. 在**批量删除规则组**对话框，输入规则组的名称，然后点击**确定**。 ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableASingleRuleGroup.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableASingleRuleGroup.adoc new file mode 100644 index 000000000..d402cee96 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableASingleRuleGroup.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 8e195bed54da4a4d8f7337f34ddec2ec +. 在需要禁用的规则组右侧点击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/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableMultipleRuleGroups.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableMultipleRuleGroups.adoc new file mode 100644 index 000000000..622ae710d --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableMultipleRuleGroups.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 76fde78ac7ba4fef9a7a125fa849713d +. 勾选需要禁用的规则组左侧的复选框，然后在规则组列表上方点击**禁用**。 + +. 在**批量禁用规则组**对话框，输入规则组的名称，然后点击**确定**。 ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- + +. 勾选已禁用的规则组左侧的复选框，然后在规则组列表上方点击**启用**可批量启用规则组。 diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editAlertRules.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editAlertRules.adoc new file mode 100644 index 000000000..e304e1a08 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editAlertRules.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: af3bb03cf3e148bfa42409178889df61 +. 在**编辑告警规则**对话框，编辑已有的告警规则或创建新告警规则，然后点击**确定**。 ++ +-- +* 将光标悬停在已有的告警规则上，点击切换开关可启用/禁用告警规则。 + +* 将光标悬停在已有的告警规则上，点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除告警规则。 + +* 将光标悬停在已有的告警规则上，点击image:/images/ks-qkcp/zh/icons/pen-light.svg[pen,18,18]可修改告警规则的设置。 + +* 点击**添加告警规则**可创建新告警规则。 +-- diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editAnAlertingPolicy.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editAnAlertingPolicy.adoc new file mode 100644 index 000000000..69e29e4ee --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editAnAlertingPolicy.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 3f022ef6620a4e01a4946d45ee3e93ce +. 在需要编辑的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑告警规则**。 diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editRuleGroupInformation.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editRuleGroupInformation.adoc new file mode 100644 index 000000000..ebf602eca --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-editRuleGroupInformation.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: 33d094f3069e40519db31aec587457b4 +. 在**编辑信息**对话框，设置规则组的基本信息，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::ruleGroups-para-aliasCheckIntervalDescription.adoc[] +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-openDetailsPage.adoc new file mode 100644 index 000000000..f1cfe14de --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 8ada03e949d64141806728273792c325 +. 在**规则组**页面，点击**自定义规则组**或**内置规则组**，然后在列表中点击一个规则组的名称打开其详情页面。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc new file mode 100644 index 000000000..bb61ef20c --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 6b961b60bdf64acab9b19b9c28b5fb3e +. 在**规则组**页面，点击**自定义规则组**或**内置规则组**打开规则组列表。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-searchForAlertingPolicies.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-searchForAlertingPolicies.adoc new file mode 100644 index 000000000..d1037bf25 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-searchForAlertingPolicies.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d6ed4db86bde40cbaa6d3dbebecda452 +* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的规则组。 diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-setBasicInfo.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-setBasicInfo.adoc new file mode 100644 index 000000000..a4ae3a8e4 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-setBasicInfo.adoc @@ -0,0 +1,16 @@ +// :ks_include_id: 0909f39a50384c55b38d52472ab4085e +. 在**基本信息**页签，设置规则组的基本信息，然后点击**下一步**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|规则组的名称。 + +名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 + +include::ruleGroups-para-aliasCheckIntervalDescription.adoc[] +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-viewAlertingPolicyDetails.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-viewAlertingPolicyDetails.adoc new file mode 100644 index 000000000..322229acf --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-oper-viewAlertingPolicyDetails.adoc @@ -0,0 +1,56 @@ +// :ks_include_id: 539c72cb8f884103bce5d979f3b31d09 +. 在规则组详情页面左侧的**属性**区域查看规则组的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::ruleGroups-para-ruleGroupStatus.adoc[] + +|检查间隔 +|指标检查之间的时间间隔。 + +include::ruleGroups-para-timeSpent.adoc[] + +|创建时间 +|规则组的创建时间。 + +|创建者 +|规则组的创建者。 +|=== +-- + +. 在规则组详情页面右侧的**告警规则**页签查看规则组中设置的告警规则。 ++ +-- +**告警规则**页签显示告警规则的名称、告警级别、触发状态、监控目标和最近检查时间。 + +* 在告警规则名称右侧点击image:/images/ks-qkcp/zh/icons/monitor.svg[monitor,18,18]可查看监控指标数据。 + +* 在告警规则右侧点击image:/images/ks-qkcp/zh/icons/chevron-down.svg["chevron-down",18,18]可查看告警规则的触发条件、PromSQL 表达式和告警消息内容。 +-- + +. 在规则组详情页面右侧点击**告警**页签查看当前生成的告警。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|消息 +| +include::ruleGroups-para-message.adoc[] + +|告警级别 +| +include::ruleGroups-para-alertLevel.adoc[] + +|监控目标 +|规则组的监控目标。 + +|触发时间 +| +include::ruleGroups-para-activationTime.adoc[] +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-activationTime.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-activationTime.adoc new file mode 100644 index 000000000..10e81afea --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-activationTime.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c3b29bad32424d7abc3be2e77357df17 +规则组由**未触发**状态变为**验证中**状态的时间。 diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertLevel.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertLevel.adoc new file mode 100644 index 000000000..7c6d57e33 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertLevel.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 63afbb864bc3418ca45d632bcda4ba1d +告警的级别，包括**提醒、警告、重要、紧急**。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList.adoc new file mode 100644 index 000000000..5062633df --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList.adoc @@ -0,0 +1,31 @@ +// :ks_include_id: 9e29dba51eed467195d8b4402adcee08 +* 规则组列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|规则组的名称。 + +include::ruleGroups-para-ruleGroupStatus.adoc[] + +|规则状态 +|规则组中包含的告警规则的状态。 + +include::ruleGroups-para-alertingStatusInactive.adoc[] + +include::../alerts/alerts-para-alertingStatus.adoc[] + +include::ruleGroups-para-alertingStatusDisabled.adoc[] + +include::ruleGroups-para-timeSpent.adoc[] + +// |集群 +// |使用该规则组进行资源监控的集群。 + +|最近检查 +|最近一次指标检查的执行时间。 +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList_whizard.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList_whizard.adoc new file mode 100644 index 000000000..7518c9316 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList_whizard.adoc @@ -0,0 +1,31 @@ +// :ks_include_id: 9e29dba51eed467195d8b4402adcee08 +* 规则组列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|规则组的名称。 + +include::ruleGroups-para-ruleGroupStatus.adoc[] + +|规则状态 +|规则组中包含的告警规则的状态。 + +include::ruleGroups-para-alertingStatusInactive.adoc[] + +include::../alerts/alerts-para-alertingStatus.adoc[] + +include::ruleGroups-para-alertingStatusDisabled.adoc[] + +// include::ruleGroups-para-timeSpent.adoc[] + +|集群 +|使用该规则组进行资源监控的集群。 + +|最近检查 +|最近一次指标检查的执行时间。 +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingStatusDisabled.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingStatusDisabled.adoc new file mode 100644 index 000000000..b85f18905 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingStatusDisabled.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: a88a0cc5a6db44ab923dd629c50bafd4 +* **已禁用**：告警规则已被禁用。 diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingStatusInactive.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingStatusInactive.adoc new file mode 100644 index 000000000..40fb5efa5 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-alertingStatusInactive.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 6bf2b0acd7e043fc8ef1328d3b45bec3 +* **未触发**：监控指标未满足预设的条件。此状态下系统不生成告警。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-aliasCheckIntervalDescription.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-aliasCheckIntervalDescription.adoc new file mode 100644 index 000000000..a84ebc29b --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-aliasCheckIntervalDescription.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: 154069b262b94648a55d983b0875f8c6 +|别名 +|规则组的别名。不同规则组的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|检查间隔 +|指标检查之间的时间间隔。默认值为 1 分钟。 + +|描述 +|规则组的描述信息。 + +描述可包含任意字符，最长 256 个字符。 diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-message.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-message.adoc new file mode 100644 index 000000000..95ffe2c8d --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-message.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 5f7a598e105f43558afe250665ee56d2 +告警消息的概要和详情。如果未设置消息的详情，**消息**列将显示告警规则组的概要。 diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-ruleGroupStatus.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-ruleGroupStatus.adoc new file mode 100644 index 000000000..e9a544e15 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-ruleGroupStatus.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: d4684807ee1d4a93ac734c072d1ce511 +|规则组状态 +|规则组当前是否已启用。 diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-timeSpent.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-timeSpent.adoc new file mode 100644 index 000000000..3019cc365 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-para-timeSpent.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 83be107bbcde41f7a4e73bae25c1e923 +|耗时 +|最近一次指标检查所花费的时间。 diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-prer-creationPrerequisites.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-prer-creationPrerequisites.adoc new file mode 100644 index 000000000..5778496f4 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-prer-creationPrerequisites.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: e40e965d1a704b41a1d1e33374d37a60 +ifeval::["{file_output_type}" == "html"] + +* {ks_product-en}平台需要启用告警系统扩展组件。 + +endif::[] + +ifeval::["{file_output_type}" == "pdf"] + +* {ks_product-en}平台需要启用告警系统扩展组件。关于更多信息，请参阅《{ks_product-en}平台管理指南》的“扩展组件管理”章节。 + +endif::[] diff --git a/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-prer-exposeMetrics.adoc b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-prer-exposeMetrics.adoc new file mode 100644 index 000000000..b94864134 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/ruleGroups/ruleGroups-prer-exposeMetrics.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 6c8ebb4ccf2948f99cfe15add7134ae5 +* 如需对应用程序的指标进行监控，您需要配置运行在容器中的应用程序，将符合 link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus 规范]的监控指标暴露在某个服务端路径下，并在用于暴露工作负载的服务上xref:05-cluster-management/06-application-workloads/04-services/07-edit-a-metrics-exporter.adoc[设置监控导出器]以声明提供应用程序监控指标的路径。 diff --git a/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-createASecret.adoc b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-createASecret.adoc new file mode 100644 index 000000000..924df3a3d --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-createASecret.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 71d8939bb0c34d539622e5d839efa46f +This section explains how to create Secrets. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-deleteSecrets.adoc b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-deleteSecrets.adoc new file mode 100644 index 000000000..3b25ee153 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-deleteSecrets.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: d9c8601d3a1f45e9857955c91e42c618 +This section explains how to delete a Secret. + +//warning +[.admon.warning,cols="a"] +|=== +| Warning + +| +Deleting a Secret is irreversible, please proceed with caution. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-editSecretInformation.adoc b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-editSecretInformation.adoc new file mode 100644 index 000000000..5183c0089 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-editSecretInformation.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: f8540b0bc54f45419444702eb08c3a6b +This section explains how to edit Secret information. + +You can edit the alias and description of the Secret. KubeSphere does not support editing the name of an already created Secret. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-editSecretSettings.adoc b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-editSecretSettings.adoc new file mode 100644 index 000000000..ac6894967 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-editSecretSettings.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: f7e3ff6a6c4d438995c3985f52dbf42d +This section explains how to edit the settings of a Secret. + +You can edit the data of the Secret. KubeSphere does not support editing the type of a Secret. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-secrets.adoc b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-secrets.adoc new file mode 100644 index 000000000..05f0a20d5 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-secrets.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 080455a800324a07a3042a4d85261101 +This section explains how to manage Secrets. + +Secrets are used to store and manage sensitive data such as passwords, tokens, and keys. Secrets can be created independently of the pods using them, reducing the data exposure risk. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-viewASecretList.adoc b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-viewASecretList.adoc new file mode 100644 index 000000000..c22df25d9 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-viewASecretList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c0f08b4b8a8b4ecb9361495af62b9e04 +This section explains how to view the list of Secrets. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-viewSecretDetails.adoc b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-viewSecretDetails.adoc new file mode 100644 index 000000000..d897f2442 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-desc-viewSecretDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 16ab2925bc4a4890949bea03ff0d3123 +This section explains how to view Secret details. diff --git a/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-createASecret.adoc b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-createASecret.adoc new file mode 100644 index 000000000..9b4fe6760 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-createASecret.adoc @@ -0,0 +1,50 @@ +// :ks_include_id: 554d961566e24e45a4faba216b099e2c +. On the **Basic Information** tab, set the basic information for the Secret, and then click **Next**. ++ +-- +[%header,cols="1,4"] +|=== +| Parameter | Description + +| Name +| The name of the Secret. The name can only contain lowercase letters, numbers, and hyphens (-), must start and end with a lowercase letter or number, and can be up to 63 characters long. + +| Alias +| The alias of the Secret. Aliases can be the same for different Secrets. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), cannot start or end with a hyphen (-), and can be up to 63 characters long. + +| Project +| The project to which the Secret belongs. + +| Description +| The description of the Secret. The description can contain any characters and can be up to 256 characters long. +|=== +-- + +. On the **Data Settings** tab, select the data type of the Secret from the **Type** dropdown list. ++ +-- +[%header,cols="1a,4a"] +|=== +| Type | Description + +| Default +| Used to store user-defined data. + +| TLS information +| Used to store TLS certificates and private keys. + +| Image registry information +| Used to store the address, username, email, and password of an image registry. + +| Username and password +| Used to store usernames and passwords. +|=== +-- + +. On the **Data Settings** tab, set the data for the Secret based on its type, and then click **Create**. ++ +==== +include::secrets-para-dataKeys.adoc[] + +Once the Secret is created, it will be displayed in the list of Secrets. +==== diff --git a/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-deleteASingleSecret.adoc b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-deleteASingleSecret.adoc new file mode 100644 index 000000000..c6682f5ca --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-deleteASingleSecret.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: efa6eca3dcdc40ffb7fc1b3a06351564 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the Secret you want to delete, then choose **Delete** from the dropdown list. + +. In the **Delete Secret** dialog, enter the name of the Secret, then click **OK**. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-deleteMultipleSecrets.adoc b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-deleteMultipleSecrets.adoc new file mode 100644 index 000000000..2c09ea5c9 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-deleteMultipleSecrets.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 821fd61185284238be5f5ef2b967af30 +. Select the checkbox on the left of the Secrets you want to delete, then click **Delete** above the Secret list. + +. In the **Delete Multiple Secrets** dialog, enter the name of the Secrets, then click **OK**. ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-editSecretInformation.adoc b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-editSecretInformation.adoc new file mode 100644 index 000000000..438b23420 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-editSecretInformation.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: 1936af45de46421dbe6053add93e1dfb +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the Secret you want to edit, then choose **Edit Information** from the dropdown list. + +. In the **Edit Information** dialog, set the alias and description for the Secret, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Alias +| The alias of the Secret. Aliases can be the same for different Secrets. An alias can only contain Chinese characters, letters, numbers, and hyphens (-). It cannot start or end with a hyphen (-) and has a maximum length of 63 characters. + +| Description +| The description of the Secret. The description can contain any characters, with a maximum length of 256 characters. +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-editSecretSettings.adoc b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-editSecretSettings.adoc new file mode 100644 index 000000000..e98d9428a --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-editSecretSettings.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: db7ae2d378f645d184b0930c64e21946 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the Secret you want to edit, then choose **Edit Settings** from the dropdown list. + +. In the **Edit Settings** dialog, set the data for the Secret, then click **OK**. ++ +==== +include::secrets-para-dataKeys.adoc[] +==== diff --git a/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-openSecretDetailsPage.adoc b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-openSecretDetailsPage.adoc new file mode 100644 index 000000000..2be35b185 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-openSecretDetailsPage.adoc @@ -0,0 +1 @@ +. Click the name of a Secret in the list to open its details page. diff --git a/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-searchForSecrets.adoc b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-searchForSecrets.adoc new file mode 100644 index 000000000..1a883b57f --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-searchForSecrets.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d4c2e8700f704fc387d1e57b8ee00641 +* Click the search box at the top of the list to search for Secrets by name. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-viewSecretDetails-for-kubefed.adoc b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-viewSecretDetails-for-kubefed.adoc new file mode 100644 index 000000000..d4e3d9c08 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-viewSecretDetails-for-kubefed.adoc @@ -0,0 +1,40 @@ +// :ks_include_id: a53d1d6e1dd4460e8fc6ff4476b08e2c +. 在保密字典详情页面左侧的**属性**区域查看保密字典的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// |集群 +// |保密字典所属的集群。 + +|项目 +|保密字典所属的项目。 + +|类型 +| +include::secrets-para-type.adoc[] + +|创建时间 +|保密字典的创建时间。 + +|更新时间 +|保密字典的更新时间。 + +|创建者 +|创建保密字典的用户。 + +|=== +-- + +. 在保密字典右侧的**数据**页签查看保密字典存储的键值对数据。 ++ +-- +// Note +include::../../../../_ks_components-en/admonitions/tip.adoc[] + +保密字典使用 Base64 数据编码。在**数据**页签右上角点击image:/images/ks-qkcp/zh/icons/eye-closed.svg[eye,18,18]/image:/images/ks-qkcp/zh/icons/eye.svg[eye-closed,18,18]可显示/隐藏数据明文。 + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-viewSecretDetails.adoc b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-viewSecretDetails.adoc new file mode 100644 index 000000000..9fdb88623 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-oper-viewSecretDetails.adoc @@ -0,0 +1,36 @@ +// :ks_include_id: a53d1d6e1dd4460e8fc6ff4476b08e2c +. View the resource attributes of the Secret in the **Attributes** area on the left side of the Secret details page. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Cluster +| The cluster to which the Secret belongs. + +| Project +| The project to which the Secret belongs. + +| Type +| +include::secrets-para-type.adoc[] + +| Creation Time +| The creation time of the Secret. + +| Creator +| The user who created the Secret. +|=== +-- + +. On the **Data** tab on the right side of the Secret details page, view the key-value pair data stored in the Secret. ++ +-- +// Note +include::../../../../_ks_components-en/admonitions/tip.adoc[] + +Secrets use Base64-encoded data. Click image:/images/ks-qkcp/zh/icons/eye-closed.svg[eye,18,18]/image:/images/ks-qkcp/zh/icons/eye.svg[eye-closed,18,18] in the upper-right corner of the **Data** tab to show/hide the plaintext data. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/secrets/secrets-para-data.adoc b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-para-data.adoc new file mode 100644 index 000000000..b423fd33a --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-para-data.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: d6fa7773eca94740994a340c203a6f69 +* Click **Add Data** to add a key-value pair. + +* Hover over the created pair, then click image:/images/ks-qkcp/zh/icons/pen-light.svg[pen,18,18] on the right to edit the pair. + +* Hover over the created pair, then click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right to delete the pair. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/secrets/secrets-para-dataKeys.adoc b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-para-dataKeys.adoc new file mode 100644 index 000000000..80c7da44c --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-para-dataKeys.adoc @@ -0,0 +1,71 @@ +// :ks_include_id: ab9267c3315d4f28b1e85cc72fff87f0 +* For the **Default** type of Secret, set the following parameters: ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Data +| Set key-value pairs. + +include::secrets-para-data.adoc[] +|=== +-- + +* For the **TLS information** type of Secret, set the following parameters: ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Certificate +| TLS certificate. + +| Private Key +| TLS private key. +|=== +-- + +* For the **Image registry information** type of Secret, set the following parameters: ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Registry Address +| Address of the image registry. Click the dropdown list to choose either HTTP or HTTPS protocol. + +| Username +| Username for accessing the image registry. + +| Email +| Email of the user accessing the image registry. + +| Password +| Password for accessing the image registry. + +* Click **Validate** to check if the password is correct. +* Click image:/images/ks-qkcp/zh/icons/eye.svg[eye,18,18]/image:/images/ks-qkcp/zh/icons/eye-closed.svg[eye-closed,18,18] to show/hide the password. + +| Data +| Key-value pair for accessing the image registry. +|=== +-- + +* For the **Username and password** type of Secret, set the following parameters: ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Username +| User-defined username. + +| Password +| User-defined password. Click image:/images/ks-qkcp/zh/icons/eye.svg[eye,18,18]/image:/images/ks-qkcp/zh/icons/eye-closed.svg[eye-closed,18,18] to show/hide the password. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/secrets/secrets-para-secretList.adoc b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-para-secretList.adoc new file mode 100644 index 000000000..89ce781c5 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-para-secretList.adoc @@ -0,0 +1,32 @@ +// :ks_include_id: 3bb84bf9d5e64bba80d8816c9176ed82 +* The Secrets list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Name +| The name and description of the Secret. + +ifdef::kubefed[] +| Status +| The current status of the Secret. +endif::[] + +ifndef::kubefed[] +| Project +| The project to which the Secret belongs. +endif::[] + +|Type +| +include::secrets-para-type.adoc[] + +| Fields +| The number of fields in the Secret. + +| Creation Time +| The creation time of the Secret. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/secrets/secrets-para-type.adoc b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-para-type.adoc new file mode 100644 index 000000000..7d5a75728 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/secrets/secrets-para-type.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 6e6d31a78576444f97059976c8f49b40 +The type of the Secrets. + +* **Default**: The default type of Secrets, used to store user-defined data. + +* **TLS information**: Used to store TLS certificates and private keys. + +* **Image registry information**: Used to store information for accessing image registries. + +* **Username and password**: Used to store usernames and passwords. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-changeTheRoleOfAServiceAccount.adoc b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-changeTheRoleOfAServiceAccount.adoc new file mode 100644 index 000000000..37219260c --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-changeTheRoleOfAServiceAccount.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: ba5fe4574cc24a7d9283273f06f7dd26 +This section explains how to change the role of a service account. + +You can control the permissions of a service account by assigning roles, allowing the service account to access specific resources and perform particular operations. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-createAServiceAccount.adoc b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-createAServiceAccount.adoc new file mode 100644 index 000000000..9d7d8ed3e --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-createAServiceAccount.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 3f60a878ee8940e9b3cbf10f3353b92f +This section explains how to create a service account. diff --git a/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-deleteServiceAccounts.adoc b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-deleteServiceAccounts.adoc new file mode 100644 index 000000000..745fed3a2 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-deleteServiceAccounts.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: bae57f78f3d540a093423af565ca9662 +This section explains how to delete a service account. + +//warning +[.admon.warning,cols="a"] +|=== +| Warning + +| +After deleting a service account, applications using that service account will lose access to the KubeSphere cluster. Please proceed with caution. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-editServiceAccountInformation.adoc b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-editServiceAccountInformation.adoc new file mode 100644 index 000000000..f436929d1 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-editServiceAccountInformation.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: efea9d6ad99a4b8c95572d4576118696 +This section explains how to edit service account information. + +You can edit the alias and description of the service account. KubeSphere does not support editing the name of an already created service account. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-serviceAccounts.adoc b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-serviceAccounts.adoc new file mode 100644 index 000000000..eed6bc89f --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-serviceAccounts.adoc @@ -0,0 +1,10 @@ +This section describes how to manage service accounts. + +Service accounts are special accounts provided by KubeSphere for applications. Applications, whether internal or external to the cluster, can use service accounts to access the KubeSphere's API server. + +Key distinctions between service accounts and user accounts include: + +- Service accounts cannot be authenticated using usernames and passwords; they can only be authenticated through tokens. +- Service accounts cannot be used to log in to the KubeSphere web console. + +You can create service accounts and control their permissions by assigning roles. This allows service accounts to access specific resources and perform designated operations. The system automatically creates a service account named **default** in each project. When creating a pod, if no service account is specified, the pod is assigned the **default** service account of the project. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-viewAServiceAccountList.adoc b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-viewAServiceAccountList.adoc new file mode 100644 index 000000000..60c200c9f --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-viewAServiceAccountList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: db44d5dd1fb14ca493ad5092790712ab +This section explains how to view the list of service accounts. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-viewServiceAccountDetails.adoc b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-viewServiceAccountDetails.adoc new file mode 100644 index 000000000..6e021c127 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-viewServiceAccountDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: adfcea0c202840f8b8a7a9070b6072b5 +This section explains how to view details of a service account. diff --git a/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-changeTheRoleOfAServiceAccount.adoc b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-changeTheRoleOfAServiceAccount.adoc new file mode 100644 index 000000000..4ba41ae7d --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-changeTheRoleOfAServiceAccount.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 32395ef55e91403f8791e1ac23036ee1 +. On the right side of the service account that requires modification, click on image:/images/ks-qkcp/zh/icons/more.svg[more,18,18], and then select **Change Role** from the dropdown list. + +. In the **Change Role** dialog, choose a project role from the dropdown list and click **OK**. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-createAServiceAccount.adoc b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-createAServiceAccount.adoc new file mode 100644 index 000000000..8f989d7ff --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-createAServiceAccount.adoc @@ -0,0 +1,27 @@ +. In the Service Accounts list page, click **Create**. + +. In the **Create Service Account** dialog, set the information for the service account, and then click **Create**. ++ +-- +[%header,cols="1,3"] +|=== +|Parameter |Description + +|Name +|The name of the service account. Service account names within the same project must be unique. Names can only contain lowercase letters, numbers, and hyphens (-), must start and end with a lowercase letter or number, and have a maximum length of 63 characters. + +|Alias +|The alias of the service account. Aliases can be the same for different service accounts. Aliases can only contain Chinese characters, letters, numbers, and hyphens (-), and must not start or end with a hyphen (-), with a maximum length of 63 characters. + +|Project +|The project to which the service account belongs. + +|Description +|The description of the service account. Descriptions can contain any characters, with a maximum length of 256 characters. + +|Project Role +|The role of the service account in the project. The role determines the permissions of the service account in the project. +|=== + +The service account will appear in the service account list after creation. +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-deleteASingleServiceAccount.adoc b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-deleteASingleServiceAccount.adoc new file mode 100644 index 000000000..b898027a0 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-deleteASingleServiceAccount.adoc @@ -0,0 +1,3 @@ +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the service account you want to delete, then choose **Delete** from the dropdown list. + +. In the **Delete Service Account** dialog, enter the name of the service account, then click **OK**. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-deleteMultipleServiceAccounts.adoc b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-deleteMultipleServiceAccounts.adoc new file mode 100644 index 000000000..b9693ea22 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-deleteMultipleServiceAccounts.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 6f5328039add4cdd843da743a785aaa7 +. Select the checkbox on the left of the service accounts you want to delete, then click **Delete** above the service account list. + +. In the **Delete Multiple Service Accounts** dialog, enter the name of the service accounts, then click **OK**. ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-editServiceAccountInformation.adoc b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-editServiceAccountInformation.adoc new file mode 100644 index 000000000..87f517d73 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-editServiceAccountInformation.adoc @@ -0,0 +1,16 @@ +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the service account you want to edit, then choose **Edit Information** from the dropdown list. + +. In the **Edit Information** dialog, set the alias and description for the service account, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Alias +| The alias of the service account. Aliases can be the same for different service accounts. An alias can only contain Chinese characters, letters, numbers, and hyphens (-). It cannot start or end with a hyphen (-) and has a maximum length of 63 characters. + +| Description +| The description of the service account. The description can contain any characters, with a maximum length of 256 characters. +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-openDetailsPage.adoc new file mode 100644 index 000000000..3a77b0c40 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 0dd2fb366a564cfba068b299483485f0 +. Click the name of a service account in the list to open its details page. diff --git a/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-searchForServiceAccounts.adoc b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-searchForServiceAccounts.adoc new file mode 100644 index 000000000..0f2777544 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-searchForServiceAccounts.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 31e6141a68d9431abf8e41e8ace22103 +* Click the search box at the top of the list to search for service accounts by name. diff --git a/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-viewServiceAccountDetails.adoc b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-viewServiceAccountDetails.adoc new file mode 100644 index 000000000..3d71af700 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-viewServiceAccountDetails.adoc @@ -0,0 +1,40 @@ +. View the resource attributes of the service account in the **Attributes** area on the left side of the service account details page. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Cluster +| The cluster to which the service account belongs. + +| Project +| The project to which the service account belongs. + +|Role +|The role of the service account in its associated project. + +| Creation Time +| The creation time of the service account. + +| Creator +| The user who created the service account. +|=== +-- + +. View the authentication information and corresponding kubeconfig information of the service account on the **Data** tab on the right side of the service account details page. ++ +-- +* In the **Data Settings** area, click on image:/images/ks-qkcp/zh/icons/eye-closed.svg[show,18,18]/image:/images/ks-qkcp/zh/icons/eye.svg[hide,18,18] in the upper right corner to display/hide the authentication information in plaintext. + +* In the **kubeconfig Settings** area, click on image:/images/ks-qkcp/zh/icons/copy.svg[copy,18,18] in the upper right corner to copy the kubeconfig information. Click on image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download,18,18] to download the **kubeconfig.yaml** file. + +//note +[.admon.note,cols="a"] +|=== +| Note + +| +The kubeconfig information contains the authentication details for the service account. You need to configure this kubeconfig information in your application to enable access to the KubeSphere cluster. For more information, refer to the link:https://kubernetes.io/zh/docs/concepts/configuration/organize-cluster-access-kubeconfig/[Kubernetes Documentation]. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-para-serviceAccountList.adoc b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-para-serviceAccountList.adoc new file mode 100644 index 000000000..11dc62a0a --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/serviceAccounts/serviceAccounts-para-serviceAccountList.adoc @@ -0,0 +1,23 @@ +* The service accounts list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Name +| The name and description of the service account. + +| Project +| The project to which the service account belongs. + +|Role +|The role of the service account in its associated project. The project role of the service account determines its permissions within the project. + +|Secret +|The name of the secret corresponding to the service account. This secret stores certificates, project names, and tokens used for authentication. + +|Creation Time +|The creation time of the service account. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-desc-createAService.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-desc-createAService.adoc new file mode 100644 index 000000000..d47ba76c2 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-desc-createAService.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 778abc4b808a4ed796f46c0c8b12c68d +This section explains how to create services. diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-desc-deleteServices.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-desc-deleteServices.adoc new file mode 100644 index 000000000..82604f962 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-desc-deleteServices.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: 5e2c112952a04a0a852f249edae6a04d +This section explains how to delete a service. + +//warning +[.admon.warning,cols="a"] +|=== +| Warning + +| +Deleting a service will make it impossible to access the pods behind it through the service. Please proceed with caution. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-desc-editAMetricsExporter.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-desc-editAMetricsExporter.adoc new file mode 100644 index 000000000..5b3a0302c --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-desc-editAMetricsExporter.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 6aade36eb695477ab6e8a0eda652c52e +本节介绍如何编辑监控导出器。 + +监控导出器用于对应用程序进行监控。{ks_product-en}平台的监控告警功能底层通过 Prometheus 实现。为监控应用程序的运行状况，您需要进行以下操作： diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-desc-editServiceExternalAccessSettings.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-desc-editServiceExternalAccessSettings.adoc new file mode 100644 index 000000000..50d643c61 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-desc-editServiceExternalAccessSettings.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: 6153ebc95ef847adb6e6294e7b521d88 +This section explains how to edit external access settings for services. + +//note +[.admon.note,cols="a"] +|=== +| Note + +| +This operation is only available for services with an internal access mode of VirtualIP, not available for services with internal access modes of Headless or ExternalName. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-desc-editServiceInformation.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-desc-editServiceInformation.adoc new file mode 100644 index 000000000..cba27b7f1 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-desc-editServiceInformation.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 0be7fc7e00d24083ac5d17ec7c4dd81b +This section explains how to edit service information. + +You can edit the alias and description of the service. KubeSphere does not support editing the name of an already created service. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-desc-editServiceSettings.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-desc-editServiceSettings.adoc new file mode 100644 index 000000000..bed77fc6d --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-desc-editServiceSettings.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 0c171d40a4db48718db0c8fd91e031a8 +This section explains how to edit service settings. diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-desc-services.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-desc-services.adoc new file mode 100644 index 000000000..bcbec16f2 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-desc-services.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 9d67f68a071549aa94a7433420ef1f66 +This section explains how to manage services. + +Services are used to expose applications for access either within or outside the cluster. + +* In KubeSphere, applications run in pods, and multiple pod replicas of the same application are managed by workloads or jobs. While each pod has a virtual IP address accessible within the cluster, pods are non-permanent resources that may be deleted or recreated. When a pod is recreated, the new pod's virtual IP address is generally different from the old one, and the old pod's IP address becomes invalid. + +* Services provide a stable address (domain or IP address) for client access. Services route client requests to a specific pod and offer load balancing across multiple pod replicas, so as to solve the issue of the original address becoming invalid when a pod is deleted or recreated. + +* In addition to providing a stable access address for workloads, services can expose workloads outside the cluster through NodePort or LoadBalancer methods. diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-desc-viewServiceDetails.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-desc-viewServiceDetails.adoc new file mode 100644 index 000000000..5359fd3cf --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-desc-viewServiceDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 312a369c91ea4bc58e98f2d1989311cd +This section explains how to view the service details. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-desc-viewServiceList.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-desc-viewServiceList.adoc new file mode 100644 index 000000000..2fb6a9e2a --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-desc-viewServiceList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: ef7bee4f35a44bbd891d4d160abdda30 +This section explains how to view the service list. diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-oper-createAService.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-oper-createAService.adoc new file mode 100644 index 000000000..1b2801369 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-oper-createAService.adoc @@ -0,0 +1,28 @@ +// :ks_include_id: 95f4759b32eb4061ae07cea32fd54ac8 +. On the **Service Settings** tab, configure the service's internal access mode, workload selector, and ports, then click **Next**. ++ +-- +include::services-para-serviceSettings.adoc[] +-- + +. On the **Advanced Settings** tab, configure the service's external access mode, session persistence settings, and metadata, then click **Create**. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +include::services-para-externalAccess.adoc[] + +include::services-para-sessionPersistence.adoc[] + +| Add Metadata +| Set labels for the service. + +* Click **Add** to set multiple labels. + +* Click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right side of a created label to delete it. +|=== + +Services will be displayed in the service list after creation. +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-oper-deleteASingleService.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-oper-deleteASingleService.adoc new file mode 100644 index 000000000..54ca6db5e --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-oper-deleteASingleService.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 03191d86a7474f0aa61513f52a671795 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the service you want to delete, then choose **Delete** from the dropdown list. diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-oper-deleteMultipleServices.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-oper-deleteMultipleServices.adoc new file mode 100644 index 000000000..f4c8793ef --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-oper-deleteMultipleServices.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 0497433d316e4c6e9a45cf29e12dbbd9 +. Select the checkbox on the left side of the services you want to delete, then click **Delete** above the service list. + +. In the **Delete Multiple Services** dialog, confirm and select the names of the resources related to the services to be deleted, then click **OK**. ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-oper-editAMetricsExporter.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-oper-editAMetricsExporter.adoc new file mode 100644 index 000000000..b8769c9f0 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-oper-editAMetricsExporter.adoc @@ -0,0 +1,47 @@ +// :ks_include_id: f0e2bbaddcbd4d3db4ce4f3625f57ca1 +. 在服务详情页面左上角选择**更多操作 > 编辑监控导出器**。 + +. 在**编辑监控导出器**页面，设置监控指标的收集路径、收集间隔和超时时间，然后点击**确定**。 ++ +-- +{ks_product-en}的监控告警模块将根据此处设置的参数访问服务并收集应用程序的监控指标。 +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|协议 +|用于通信的协议，取值可以为 **HTTP** 或 **HTTPS**。 + +|端口 +|用于通信的服务端口。 + +|路径 +|暴露应用程序监控指标的路径。 + +|认证方式 +|收集应用程序监控指标过程的通信认证方式。 + +* **无需认证**：不采用任何认证手段。此方式可能存在信息安全隐患。 + +* **TLS**：收集应用程序监控指标的过程通过 TLS 协议进程认证。 + +* **Bear 令牌**：通过令牌进行认证。 + +* **基础认证**：通过用户名和密码认证。 + +除**无需认证**外，其他认证方式都需要在应用程序中配置对应的认证逻辑，并提前创建包含认证信息的保密字典。 + +|收集间隔 +|应用程序监控指标的收集间隔，单位为分钟。 + +|超时时间 +|每次收集应用程序监控指标的超时时间，单位为秒。 +|=== +-- + +// Note +include::../../../../_ks_components-en/admonitions/note.adoc[] + +监控导出器创建完成后，您还需要在{ks_product-en} Web 控制台使用监控指标进一步创建规则组或自定义监控面板，以对应用程序的运行状态进行监控。 + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-oper-editServiceExternalAccessSettings.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-oper-editServiceExternalAccessSettings.adoc new file mode 100644 index 000000000..410380a4a --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-oper-editServiceExternalAccessSettings.adoc @@ -0,0 +1,18 @@ +// :ks_include_id: f59275b4c21c49c9983d211ee4b12b66 +. In the **Edit External Access** dialog, set the external access mode for the service, then click **OK**. ++ +-- +The external access modes for the service include the following types: + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| None +| The service cannot be accessed from outside the cluster. + +* **NodePort**: The system maps the ports of nodes to the service ports, and the service can be accessed through the node IP address and node port. + +* **LoadBalancer**: On the basis of a NodePort service, the system assigns an external IP address to the service and binds the external IP address to an external load balancer. The external load balancer listens on the node port corresponding to the service, allowing access to the service through the external IP address. To achieve this, LoadBalancer-type services need support from load balancer plugins and the infrastructure environment, and relevant annotations need to be set. For more information, please contact your infrastructure environment provider. +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-oper-editServiceInformation.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-oper-editServiceInformation.adoc new file mode 100644 index 000000000..83bc04496 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-oper-editServiceInformation.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: 1137d62e09344a798e172ba55bf7a205 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the service you want to edit, then choose **Edit Information** from the dropdown list. + +. In the **Edit Information** dialog, set the alias and description for the service, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Alias +| The alias of the service. Aliases can be the same for different services. An alias can only contain Chinese characters, letters, numbers, and hyphens (-). It cannot start or end with a hyphen (-) and has a maximum length of 63 characters. + +| Description +| The description for the service. The description can contain any characters, with a maximum length of 256 characters. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-oper-editServiceSettings-for-kubefed.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-oper-editServiceSettings-for-kubefed.adoc new file mode 100644 index 000000000..759cf775c --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-oper-editServiceSettings-for-kubefed.adoc @@ -0,0 +1,18 @@ +// :ks_include_id: f0f32c026c8a44b7ac18acbadf465ea5 +. 在需要操作的服务右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑设置**。 + +. 在**编辑设置**对话框的**服务设置**页签，修改服务的设置。 + +* 对于内部访问模式为 ExternalName 的服务，您可以修改外部服务的地址。 + +* 对于其他服务，您可以修改服务的内部访问模式、工作负载选择器和端口。 ++ +-- +include::services-para-serviceSettings.adoc[] +-- + +. 在**编辑设置**对话框的**集群差异设置**页签，为不同集群中的服务基于端口进行差异化设置，然后点击**确定**。 ++ +-- +// include::../../../multi-clusterProjectManagement/services/services-oper-setClusterDiff.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-oper-editServiceSettings.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-oper-editServiceSettings.adoc new file mode 100644 index 000000000..85da46acd --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-oper-editServiceSettings.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: f0f32c026c8a44b7ac18acbadf465ea5 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the service you want to edit, then choose **Edit Service** from the dropdown list. + +. In the **Edit Service** dialog, modify the service settings, then click **OK**. + +* For services with an internal access mode of ExternalName, you can modify the address of the external service. + +* For other services, you can modify the internal access mode, workload selector, and ports of the service. ++ +-- +include::services-para-serviceSettings.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-oper-exposeMetrics.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-oper-exposeMetrics.adoc new file mode 100644 index 000000000..c1a418265 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-oper-exposeMetrics.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9014ea6811834538b9c5b7fe24097a91 +. 在{ks_product-en} Web 控制台，使用监控指标创建规则组或自定义监控面板，从而对应用程序的运行状况进行监控。 diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-oper-openDetailsPage.adoc new file mode 100644 index 000000000..de9e83487 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9572433de70c4e3485289ea683e39c12 +. Click the name of a service in the list to open its details page. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-oper-openServiceExternalAccessSettings.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-oper-openServiceExternalAccessSettings.adoc new file mode 100644 index 000000000..8fbcf2984 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-oper-openServiceExternalAccessSettings.adoc @@ -0,0 +1,5 @@ +// :ks_include_id: f8bbecbf87544c4f9173c8107364d8ee + +. 在服务详情页面右侧点击**访问信息**页签查看服务的访问信息。 + +. 点击页面右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后从下拉列表中选择**编辑外部访问**。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-oper-searchForServices.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-oper-searchForServices.adoc new file mode 100644 index 000000000..2799e7f68 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-oper-searchForServices.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d085604adc244a4cbb580fb88485f275 +* Click the search box at the top of the list and search for services by name. diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-oper-viewServiceDetails-for-kubefed.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-oper-viewServiceDetails-for-kubefed.adoc new file mode 100644 index 000000000..eb2174b88 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-oper-viewServiceDetails-for-kubefed.adoc @@ -0,0 +1,115 @@ +// :ks_include_id: ec83e4ff0eb74cdaa02d3a52062d9bc5 +. 在服务详情页面左侧的**属性**区域查看服务的资源属性。 ++ +-- + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// |集群 +// |服务所属的集群。 + +|项目 +|服务所属的项目。 + +|类型 +| +include::services-para-internalAccess.adoc[] + +include::services-para-virtualip-headless.adoc[] + +include::services-para-externalName.adoc[] + +|应用 +|服务所属的应用名称。您可以创建一个包含多个服务的应用，每个服务都对应一个工作负载。 + +// |虚拟 IP 地址 +// |服务供集群内部访问的虚拟 IP 地址，仅对 VirtualIP 类型的服务显示。 + +// |外部 IP 地址 +// |服务供集群外部访问的 IP 地址，仅在服务启用外部访问时显示。 + +// |会话保持 +// |是否已启用会话保持功能，取值可以为： + +// * **已启用**：已启用会话保持。如果服务有多个容器组，在一定时间内（默认值为 10800 秒），来自相同客户端 IP 地址的请求将被转发给同一个容器组。 + +// * **未启用**：未启用会话保持。如果服务有多个容器组，来自相同客户端 IP 地址的请求将被随机转发给不同的容器组。 + +// |选择器 +// |服务的容器组选择器。容器组选择器由一个多个容器组标签组成，服务会将客户端请求转发给具有全部指定标签的容器组。 + +// |DNS +// |服务在集群内部的域名，可在集群内部访问。 + +// |端点 +// |服务的目标容器组的虚拟 IP 地址和容器端口。 + +|创建时间 +|服务的创建时间。 + +|更新时间 +|服务的最后更新时间。 + +|创建者 +|创建服务的用户。 +|=== +-- + +. 在服务详情页面右侧的**资源状态**页签查看服务的容器组副本数量和容器组。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|容器组副本数量 +|设置每个集群的容器组副本数。 + +|容器组 +| +服务中运行的所有容器组。展开下拉框可以选择查看特定集群中的容器组信息。 + +include::../nodes/nodes-para-podList.adoc[] +|=== +-- + +. 在服务详情页面右侧的**访问信息**页签查看服务的访问信息。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|内部域名 +|可通过 ..svc 格式的域名从集群内部访问服务。 + +|虚拟 IP 地址 +|服务供集群内部访问的虚拟 IP 地址。 + +|端口 +|为使容器能够被正常访问，{ks_product-en}平台上定义了以下端口类型： + +* 容器端口：容器中的应用程序监听的端口，只能在容器组内部访问。 + +* 服务端口：服务虚拟 IP 地址的端口，只能在集群内部访问，发送到服务端口的请求将被转发给容器端口。 + +* 节点端口：节点主机上的端口，可以从集群外部访问，发送到节点端口的请求将被转发给服务端口。NodePort 或 LoadBalancer 类型的服务具有节点端口。 + +// |工作负载 +// |显示管理容器组的工作负载的名称、更新时间、类型、状态和当前修改记录。 + +// |容器组 +// | +// include::../nodes/nodes-para-podList.adoc[] +|=== +-- + +. 在服务详情页面右侧点击**元数据**页签查看服务的标签和注解。 + +. 在服务详情页面右侧点击**事件**页签查看服务相关的事件。 ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-oper-viewServiceDetails.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-oper-viewServiceDetails.adoc new file mode 100644 index 000000000..c5467e887 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-oper-viewServiceDetails.adoc @@ -0,0 +1,88 @@ +// :ks_include_id: ec83e4ff0eb74cdaa02d3a52062d9bc5 +. In the **Attributes** section on the left side of the service details page, view the resource attributes of the service. ++ +-- + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Cluster +| The cluster to which the service belongs. + +| Project +| The project to which the service belongs. + +| Type +| +include::services-para-internalAccess.adoc[] + +include::services-para-virtualip-headless.adoc[] + +include::services-para-externalName.adoc[] + +| App +| The name of the application to which the service belongs. You can create an application that includes multiple services, with each service corresponding to a workload. + +| Virtual IP Address +| The virtual IP address for internal access within the cluster. Displayed only for services with the VirtualIP type. + +| External IP Address +| The IP address for external access outside the cluster. Displayed only when external access is enabled for the service. + +| Session Affinity +| Whether session affinity is enabled: + +* **Enabled**: Session affinity is enabled. If the service has multiple pods, requests from the same client IP address within a certain period (default is 10800 seconds) will be forwarded to the same pod. + +* **Disabled**: Session affinity is not enabled. If the service has multiple pods, requests from the same client IP address will be randomly forwarded to different pods. + +| Selector +| The selector for the service's pods. The pod selector consists of one or more pod labels, and the service will route client requests to pods that have all the specified labels. + +| DNS +| The internal domain of the service within the cluster, accessible within the cluster. + +| Endpoint +| The virtual IP address and container port of the target pods for the service. + +| Creation Time +| The creation time of the service. + +| Creator +| The user who created the service. +|=== +-- + +. In the **Resource Status** tab on the right side of the service details page, view the container ports, workloads, and pods for the service. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Ports +| To enable containers to be accessed properly, KubeSphere defines the following types of ports: + +* Container Port: The port on which the application in the container listens, only accessible within the pod. + +* Service Port: The port for the virtual IP address of the service, only accessible within the cluster. Requests sent to the service port will be forwarded to the container port. + +* Node Port: The port on the node host, accessible from outside the cluster. Requests sent to the node port will be forwarded to the service port. Services with the NodePort or LoadBalancer type have node ports. + +| Workloads +| Displays the name, update time, type, status, and current revision records of the workload managing the pods. + +| Pods +| +include::../nodes/nodes-para-podList.adoc[] +|=== +-- + +. Click the **Metadata** tab on the right side of the service details page to view the labels and annotations for the service. + +. Click the **Events** tab on the right side of the service details page to view events related to the service. ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-para-creationTime.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-para-creationTime.adoc new file mode 100644 index 000000000..76b654351 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-para-creationTime.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: f7bc10d6a0ae4ebfb0956bf2cd8624dd +| Creation Time +| The time the service created. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-para-externalAccess.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-para-externalAccess.adoc new file mode 100644 index 000000000..d7669d01d --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-para-externalAccess.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 9ed594d85e2d49d189b604ba75506964 +| External Access +| The external access mode for the service. + +// tag::bullets[] +* **NodePort**: The system maps the ports of nodes to the service ports, and the service can be accessed through the node IP address and node port. + +* **LoadBalancer**: On the basis of a NodePort service, the system assigns an external IP address to the service and binds the external IP address to an external load balancer. The external load balancer listens on the node port corresponding to the service, allowing access to the service through the external IP address. To achieve this, LoadBalancer-type services need support from load balancer plugins and the infrastructure environment, and relevant annotations need to be set. For more information, please contact your infrastructure environment provider. +// end::bullets[] \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-para-externalName.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-para-externalName.adoc new file mode 100644 index 000000000..1805569ca --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-para-externalName.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: ae3aeeab99d2436aaf471a053199ed31 +* **ExternalName**: The service routes business traffic to other services outside the cluster. The system does not assign a virtual IP address to the service, and it can be accessed internally by using the format `..svc.cluster.local`. diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-para-internalAccess.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-para-internalAccess.adoc new file mode 100644 index 000000000..109adff79 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-para-internalAccess.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d2f7e4ed2c324015a246ad69584a8562 +The internal access mode for the service. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-para-name.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-para-name.adoc new file mode 100644 index 000000000..b7fb24ba7 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-para-name.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: fc0d8d22d3934c7c8a894c53da744ea6 +| Name +| The name and description of the service. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-para-serviceAlias.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-para-serviceAlias.adoc new file mode 100644 index 000000000..61a05c27a --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-para-serviceAlias.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: f7106eed4381415e895021d16070780d +| Alias +| The alias of the service. Aliases can be the same for different services. Aliases can only contain Chinese characters, letters, numbers, and hyphens (-), and must not start or end with a hyphen (-), with a maximum length is 63 characters. diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-para-serviceDescription.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-para-serviceDescription.adoc new file mode 100644 index 000000000..99c0ce363 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-para-serviceDescription.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 84acacc3966a4dea95858ffeabf4a6b7 +| Description +| The description of the service. The description can contain any characters, with a maximum length of 256 characters. diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-para-serviceName.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-para-serviceName.adoc new file mode 100644 index 000000000..cd3315173 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-para-serviceName.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 89c9a4c83d7a46889b95133fc816d28d +| Name +| The name of the service. Service names within the same project must be unique. Names can only contain lowercase letters, numbers, and hyphens (-), and must start and end with a lowercase letter or number, with a maximum length of 253 characters. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-para-serviceSettings.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-para-serviceSettings.adoc new file mode 100644 index 000000000..47ae966d2 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-para-serviceSettings.adoc @@ -0,0 +1,34 @@ +// :ks_include_id: 797c8dc7400f4f17940a76eb88ae5149 +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Internal Access Mode +| The way to access the service within the cluster. + +* **Internal Domain Name**: The system does not assign a virtual IP address to the service. It can be accessed internally by using the format `..svc.cluster.local` or `.`. + +* **Virtual IP Address**: The system assigns a virtual IP address to the service for internal access within the cluster. It also supports access internally by using the format `..svc.cluster.local` or `.`. + +| Workload Selector +| Specify the workloads with specific labels to which the service routes business traffic. + +* Manually set selectors by entering the key and value of a label. Click **Add** to set multiple labels. + +* Manually select workloads by clicking **Specify Workload**. + +* Click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right side of a created label to delete it. + +| Ports +| Map service ports and their corresponding container ports. + +* **Protocol**: The protocol that the application in the target container actually listens on. To use the application governance features provided by KubeSphere, ensure that the protocol selected here matches the one the application in the target container actually listens on. + +* **Name**: The name of the service port. The application governance features of KubeSphere require the service port name to have the protocol name in lowercase as a prefix. To use the application governance features provided by KubeSphere, use the lowercase protocol name as the prefix for the port name (e.g., **http-**). + +* **Container Port**: The port number on which the application in the target container actually listens. + +* **Service Port**: The port number of the service. + +Click **Add** to set multiple service ports. Click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right side of a created service port to delete it. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-para-sessionPersistence.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-para-sessionPersistence.adoc new file mode 100644 index 000000000..d962b5f7e --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-para-sessionPersistence.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 9bd9803a7946434cb487882abcb428b8 +| Session Persistence +| Configure the system to forward all requests from the same client in the same session to the same pod within a specified duration. The default maximum stickiness duration is 10800 seconds, and you can also change it. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-para-statelessStatefulExternal.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-para-statelessStatefulExternal.adoc new file mode 100644 index 000000000..5907be282 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-para-statelessStatefulExternal.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: ae5f26efadb740b1b3a09e681f1ef06e +- **Stateful Service**: The internal access mode of the service is Headless, and the backend workload is Statefulset. + +- **Stateless Service**: The internal access mode of the service is VirtualIP, and the backend workload is Deployment. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-para-virtualip-headless.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-para-virtualip-headless.adoc new file mode 100644 index 000000000..3d3e9fbf9 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-para-virtualip-headless.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: bed3eb4cd7fa441990451420cd9a8ed4 +* **Headless**: The system does not assign a virtual IP address to the service. It can be accessed internally by using the format `..svc.cluster.local` or `.`. + +* **VirtualIP**: The system assigns a virtual IP address to the service for internal access within the cluster. It also supports access internally by using the format `..svc.cluster.local` or `.`. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/services/services-prer-exposeMetrics.adoc b/content/en/docs/_custom-en/clusterManagement/services/services-prer-exposeMetrics.adoc new file mode 100644 index 000000000..4f39c31c9 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/services/services-prer-exposeMetrics.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: f845b7136ccc47a59ea94257751c74cc +* 您需要配置目标应用程序将符合 Prometheus 规范的监控指标暴露在某个服务端路径下。有关更多信息，请参阅 link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus 官方文档]。 + +* 如果监控指标采集过程需要认证，您还需要在目标应用程序中配置相关认证逻辑，并在{ks_product-en}平台提前创建包含认证信息的保密字典。 diff --git a/content/en/docs/_custom-en/clusterManagement/storageClasses/systemClasses-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/clusterManagement/storageClasses/systemClasses-oper-openDetailsPage.adoc new file mode 100644 index 000000000..e3a04bc61 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/storageClasses/systemClasses-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: ddde1ce7630144f8bc7460c30577b036 +. Click the name of a storage class in the list to open its details page. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/storageClasses/systemClasses-para-allowVolumeCloning.adoc b/content/en/docs/_custom-en/clusterManagement/storageClasses/systemClasses-para-allowVolumeCloning.adoc new file mode 100644 index 000000000..5cd97f05b --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/storageClasses/systemClasses-para-allowVolumeCloning.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d8e84290faee432e8c4e286dd1fa707d +Cloning Persistent Volumes in the {ks_product-en} web console is allowed or not. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/storageClasses/systemClasses-para-allowVolumeExpansion.adoc b/content/en/docs/_custom-en/clusterManagement/storageClasses/systemClasses-para-allowVolumeExpansion.adoc new file mode 100644 index 000000000..c621d1a07 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/storageClasses/systemClasses-para-allowVolumeExpansion.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 57acc3d45ab443bdad3eee12eb83b5ca +Expanding capacity of Persistent Volumes in the {ks_product-en} web console is allowed or not. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/storageClasses/systemClasses-para-allowVolumeSnapshot.adoc b/content/en/docs/_custom-en/clusterManagement/storageClasses/systemClasses-para-allowVolumeSnapshot.adoc new file mode 100644 index 000000000..6acaa4bda --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/storageClasses/systemClasses-para-allowVolumeSnapshot.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 48f291ba67994c06a8a69b9222de92ab +Creating snapshots for Persistent Volumes in the {ks_product-en} web console is allowed or not. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/storageClasses/systemClasses-para-defaultStorageClass.adoc b/content/en/docs/_custom-en/clusterManagement/storageClasses/systemClasses-para-defaultStorageClass.adoc new file mode 100644 index 000000000..d8c9d6b50 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/storageClasses/systemClasses-para-defaultStorageClass.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 74c2d701d7a54e788036567ac9748872 +The storage class is the default storage class or not. Once a default storage class is set, the system will use it to create Persistent Volume Claims if no specific storage class is designated. Only one default storage class is allowed in a KubeSphere cluster. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/systemComponents/systemComponents-para-replica-count.adoc b/content/en/docs/_custom-en/clusterManagement/systemComponents/systemComponents-para-replica-count.adoc new file mode 100644 index 000000000..04dda6194 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/systemComponents/systemComponents-para-replica-count.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 95e7a27324f142b3bce7699ae4ef06da +系统组件实际运行的容器组副本数和期望的容器组副本数。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/systemComponents/systemComponents-para-status.adoc b/content/en/docs/_custom-en/clusterManagement/systemComponents/systemComponents-para-status.adoc new file mode 100644 index 000000000..82d22db18 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/systemComponents/systemComponents-para-status.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: d8bdf481c53743aca14f167808430d23 +系统组件的运行状态。 + +* **健康**：系统组件运行正常。 + +* **已停止**：系统组件的工作负载已停止运行。 + +* **告警**：系统组件实际运行的容器组副本数小于期望的容器组副本数。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-oper-openListPage.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-oper-openListPage.adoc new file mode 100644 index 000000000..24a82da18 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 8780fa783a634e2ea7e02b71327c3608 +. 在**卷快照**页面点击**卷快照内容**打开卷快照内容列表。 diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-capacity.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-capacity.adoc new file mode 100644 index 000000000..fd31f5569 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-capacity.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: a2112616394340108e2af64c91d2c33d +卷快照内容对应的持久卷的容量。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc new file mode 100644 index 000000000..39d02a6fa --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: a1caf9b38b4a4e0ab7bd462783b840a5 +删除卷快照时对卷快照内容采取的策略。删除策略在对应的卷快照类中设置。 + +* **Delete**：卷快照被删除后，系统自动删除卷快照内容。 + +* **Retain**：卷快照被删除后，系统不自动删除卷快照内容。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-status.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-status.adoc new file mode 100644 index 000000000..8b75250f8 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-status.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 6967c031afb24424b3fdd01250460660 +卷快照内容的状态。 + +* **就绪**：卷快照内容已创建成功，并且快照数据已保存到后端存储系统。 + +* **未就绪**：卷快照内容正在创建或正在删除中。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-volumeSnapshotClass.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-volumeSnapshotClass.adoc new file mode 100644 index 000000000..f46bdfc02 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-volumeSnapshotClass.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: fc3e0f0606144b55b1662409e2c4b5cb +创建卷快照所使用的卷快照类。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-createAPersistentVolumeFromAVolumeSnapshot.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-createAPersistentVolumeFromAVolumeSnapshot.adoc new file mode 100644 index 000000000..a07846abb --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-createAPersistentVolumeFromAVolumeSnapshot.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: e8fdffd5e61b45e99c5afd2ae8efb5ec +本节介绍如何使用卷快照创建持久卷。 + +卷快照创建后，您可以使用卷快照创建持久卷声明和持久卷。 diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-deleteVolumeSnapshots.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-deleteVolumeSnapshots.adoc new file mode 100644 index 000000000..758e12582 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-deleteVolumeSnapshots.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 3603af7c772d428bb6e514c29c8eb747 +本节介绍如何删除卷快照。 + +// Warning +include::../../../../_ks_components-en/admonitions/warning.adoc[] + +卷快照删除后不能恢复，请谨慎执行此操作以免数据丢失。 + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewAVolumeSnapshotList.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewAVolumeSnapshotList.adoc new file mode 100644 index 000000000..11d54e289 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewAVolumeSnapshotList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: a1f60dfd532d4f18b2f626e9ce81ea4e +本节介绍如何查看卷快照列表。 diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewVolumeSnapshotDetails.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewVolumeSnapshotDetails.adoc new file mode 100644 index 000000000..9d051b678 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewVolumeSnapshotDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 447a321161844ddba2a4dc1e7677dd14 +本节介绍如何查看卷快照的详情。 diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-volumeSnapshots.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-volumeSnapshots.adoc new file mode 100644 index 000000000..3eefeb5cc --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-desc-volumeSnapshots.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: fdb0d37ac974460092567e5ee221abcb +本节介绍如何管理卷快照和卷快照内容。 + +卷快照定义了保存快照数据所需要的存储资源。卷快照创建后，系统将在后端存储系统中保存快照数据，每个快照数据单元与{ks_product-en}平台上的一个卷快照内容对应。 diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAPersistentVolumeFromAVolumeSnapshot.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAPersistentVolumeFromAVolumeSnapshot.adoc new file mode 100644 index 000000000..5581c471b --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAPersistentVolumeFromAVolumeSnapshot.adoc @@ -0,0 +1,46 @@ +// :ks_include_id: 866a7f0d7d8549c595c932a0e15d5cba +. 在卷快照详情页面左上角选择**更多操作 > 创建卷**。 + +. 在**基本信息**页签，设置持久卷声明的基本信息，然后点击**下一步**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|持久卷声明的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 253 个字符。 + +|别名 +|持久卷声明的别名。不同持久卷声明的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|持久卷声明的描述信息。描述可包含任意字符，最长 256 个字符。 +|=== +-- + +. 在**存储设置**页签，选择后端存储区域的访问模式，然后点击**下一步**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|ReadWriteOnce +|允许单个节点读取后端存储区域中的数据并向其中写入数据。 + +|ReadOnlyMany +|允许多个节点读取后端存储区域中的数据。 + +|ReadWriteMany +|允许多个节点读取后端存储区域中的数据并向其中写入数据。 +|=== +-- + +. 在**高级设置**页签，设置持久卷声明的标签和注解，然后点击**创建**。 ++ +-- +include::../workloads/createWorkload/workloads-para-Metadata.adoc[] + +系统将根据以上步骤设置的参数创建持久卷声明，并且还将根据快照数据创建持久卷声明对应的持久卷。 +-- diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAVolumeSnapshot.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAVolumeSnapshot.adoc new file mode 100644 index 000000000..5f0659034 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAVolumeSnapshot.adoc @@ -0,0 +1,21 @@ +// :ks_include_id: 102bc308bb2647fd9be8af126d58b8e3 +. 在**创建快照**对话框，设置需要创建快照的持久卷声明、卷快照的名称和卷快照类，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|持久卷声明 +|需要创建快照的持久卷声明。 + +|名称 +|卷快照的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 253 个字符。 + +|卷快照类 +| +include::../persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshotClass.adoc[] +|=== + +卷快照创建后将显示在卷快照列表中。 +-- diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteASingleVolumeSnapshot.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteASingleVolumeSnapshot.adoc new file mode 100644 index 000000000..f73e7ec80 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteASingleVolumeSnapshot.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: d6ffb1f3d075421a9c9d96456b1349f1 +. 在需要删除的卷快照右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除卷快照**对话框，输入卷快照的名称，然后点击**确定**。 diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteMultipleVolumeSnapshots.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteMultipleVolumeSnapshots.adoc new file mode 100644 index 000000000..976f9fb27 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteMultipleVolumeSnapshots.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 7a2c4eb010e0470095968312938c7699 +. 选择需要删除的卷快照左侧的复选框，然后在卷快照列表上方点击**删除**。 + +. 在**批量删除卷快照**对话框，输入卷快照的名称，然后点击**确定**。 ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-openDetailsPage.adoc new file mode 100644 index 000000000..a3dd0077f --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: abe8911b7ecb4c4dbafe2a4e32f9932a +. 在卷快照列表中点击一个卷快照的名称打开其详情页面。 diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-searchForVolumeSnapshots.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-searchForVolumeSnapshots.adoc new file mode 100644 index 000000000..1316bee7c --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-searchForVolumeSnapshots.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 8ad6ef7eeeae445a95cd3af6e31f267c +* 在列表上方点击搜索框并设置搜索条件，可按名称或状态搜索卷快照。 diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-viewVolumeSnapshotDetails.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-viewVolumeSnapshotDetails.adoc new file mode 100644 index 000000000..2f41f368e --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-viewVolumeSnapshotDetails.adoc @@ -0,0 +1,41 @@ +// :ks_include_id: b8f433f8547944029075f5bec8d36efe +. 在卷快照详情页面左侧的**属性**区域查看卷快照的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|项目 +|卷快照的所属项目。 + +|状态 +| +include::volumeSnapshots-para-volumeSnapshotStatus.adoc[] + +|容量 +| +include::volumeSnapshots-para-capacity.adoc[] + +|快照类 +|用于保存快照数据的存储系统对应的卷快照类。 + +|创建时间 +|卷快照的创建时间。 + +|创建者 +|创建卷快照的用户。 +|=== +-- + +. 在卷快照详情页面右侧的**数据源**页签查看用于创建快照的持久卷声明的信息。 ++ +-- +include::../persistentVolumes/persistentVolumes-para-pvcInformation.adoc[] +-- + +. 在卷快照详情页面右侧点击**事件**页签查看卷快照的事件。 ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-viewVolumeSnapshotDetails_v4.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-viewVolumeSnapshotDetails_v4.adoc new file mode 100644 index 000000000..c179acfb1 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-oper-viewVolumeSnapshotDetails_v4.adoc @@ -0,0 +1,44 @@ +// :ks_include_id: b8f433f8547944029075f5bec8d36efe +. 在卷快照详情页面左侧的**属性**区域查看卷快照的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|项目 +|卷快照的所属项目。 + +|状态 +| +include::volumeSnapshots-para-volumeSnapshotStatus_v4.adoc[] + +|容量 +| +include::volumeSnapshots-para-capacity.adoc[] + +|快照类 +|用于保存快照数据的存储系统对应的卷快照类。 + +|卷快照内容 +|卷快照内容的名称。 + +|创建时间 +|卷快照的创建时间。 + +|创建者 +|创建卷快照的用户。 +|=== +-- + +. 在卷快照详情页面右侧的**数据源**页签查看用于创建快照的持久卷声明的信息。 ++ +-- +include::../persistentVolumes/persistentVolumes-para-pvcInformation.adoc[] +-- + +. 在卷快照详情页面右侧点击**事件**页签查看卷快照的事件。 ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-capacity.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-capacity.adoc new file mode 100644 index 000000000..2efec63c4 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-capacity.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: eeeb5fef69924224aac5599d6e8e999b +卷快照对应持久卷的容量。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotList.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotList.adoc new file mode 100644 index 000000000..d65716969 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotList.adoc @@ -0,0 +1,26 @@ +// :ks_include_id: ebcff396ff624f5f9d3e0534615ffdcb +* 卷快照列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|卷快照的名称、别名和卷快照类。 + +|状态 +| +include::volumeSnapshots-para-volumeSnapshotStatus.adoc[] + +|项目 +|卷快照所属的项目。 + +|容量 +| +include::volumeSnapshots-para-capacity.adoc[] + +|创建时间 +|卷快照的创建时间。 +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotList_v4.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotList_v4.adoc new file mode 100644 index 000000000..a33124d11 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotList_v4.adoc @@ -0,0 +1,26 @@ +// :ks_include_id: ebcff396ff624f5f9d3e0534615ffdcb +* 卷快照列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|卷快照的名称、别名和卷快照类。 + +|状态 +| +include::volumeSnapshots-para-volumeSnapshotStatus_v4.adoc[] + +|卷快照内容 +|卷快照内容的名称。 + +|容量 +| +include::volumeSnapshots-para-capacity.adoc[] + +|创建时间 +|卷快照的创建时间。 +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotStatus.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotStatus.adoc new file mode 100644 index 000000000..17c27b8fc --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotStatus.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: d7d51560e0e64d3a927f19e81658358b +卷快照当前的状态。 + +* **创建中**：卷快照和对应的卷快照内容正在创建中。 + +* **创建成功**：卷快照和对应的卷快照内容创建成功。 + +* **创建失败**：系统存在错误，卷快照或对应的卷快照内容创建失败。 + +* **删除中**：卷快照正在删除中。取决于卷快照的删除策略，系统可能会在卷快照删除后保留或自动删除卷快照内容。 diff --git a/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotStatus_v4.adoc b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotStatus_v4.adoc new file mode 100644 index 000000000..43675b353 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotStatus_v4.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: d7d51560e0e64d3a927f19e81658358b +卷快照当前的状态。 + +* **就绪**：卷快照和对应的卷快照内容创建成功。 + +* **未就绪**：卷快照和对应的卷快照内容正在创建、创建失败或卷快照正在删除中。 diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-enableLogCollectionCluster.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-enableLogCollectionCluster.adoc new file mode 100644 index 000000000..25e2860d2 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-enableLogCollectionCluster.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 01792eb26cce4187b5a1f964404e6037 +ifeval::["{file_output_type}" == "pdf"] + +有关如何在项目中启用**收集卷上的日志**，请参阅《{ks_product-en}项目管理指南》的“日志收集”章节。 + +endif::[] diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc new file mode 100644 index 000000000..7907e1cbe --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 4521ce6a20e1414e9ee4a6025bfae0f4 +Mount volumes, ConfigMaps, or Secrets for the container. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc new file mode 100644 index 000000000..2e93899c4 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 847da7da89ca4546b3e0d53d8edb7441 +Configure the container's image, name, type, and resources. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-setWorkloadMetadata.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-setWorkloadMetadata.adoc new file mode 100644 index 000000000..5e18b7ef9 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-setWorkloadMetadata.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c366a748b75848288944f6526bbf6aa7 +Configure labels and annotations for the workload. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-viewContainerLogsOnVolume.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-viewContainerLogsOnVolume.adoc new file mode 100644 index 000000000..33f54dae9 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-viewContainerLogsOnVolume.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 4d9963c5048842079eda1ead3073722d +日志收集完成后将打印到容器的标准输出，您可以在容器详情页面的**日志**页签查看日志内容。 diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-multi-project-para-workloadList.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-multi-project-para-workloadList.adoc new file mode 100644 index 000000000..d1c2f74af --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-multi-project-para-workloadList.adoc @@ -0,0 +1,24 @@ +// :ks_include_id: cad509443a554a38ab6ce4a11e4d2b73 +* 工作负载列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|工作负载的名称和描述信息。 + +|状态 +| +工作负载的正常容器组副本数、期望容器组副本数和运行状态。工作负载状态包括以下类型： + +include::../workloads-para-workloadStatus.adoc[] + +|应用 +|工作负载所声明的应用。 + +|更新时间 +|工作负载的更新时间。 +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume.adoc new file mode 100644 index 000000000..b7c365e3c --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: a03937e2a0cc45ffac2b60c8f2321638 +* Hover over the added volume or PVC template, then click image:/images/ks-qkcp/zh/icons/pen-light.svg[pen,18,18] on the right to edit its settings. +* Hover over the mounted volume or PVC template, then click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right to delete it. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume_new.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume_new.adoc new file mode 100644 index 000000000..2223727a2 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume_new.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: a03937e2a0cc45ffac2b60c8f2321638 +* Hover over the added volume, then click image:/images/ks-qkcp/zh/icons/pen-light.svg[pen,18,18] on the right to edit the volume settings. +* Hover over the mounted volume, then click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right to delete the volume. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc new file mode 100644 index 000000000..72b1c317d --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 6d818141bdf246f49b4c4825976cc804 +* Click **Add** to set multiple labels or annotations. + +* Click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right of a created label or annotation to delete it. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc new file mode 100644 index 000000000..fb5a37561 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 7e4e28a3e5ce47da9d146777b262caf4 +Set the waiting time before the pod terminates; the pod will be forcefully terminated after the specified timeout. The default value is 30 seconds. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-PodMetadata.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-PodMetadata.adoc new file mode 100644 index 000000000..5d0efb5bd --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-PodMetadata.adoc @@ -0,0 +1,5 @@ +// :ks_include_id: 91f17518b6d34f729b683653e6fa81e3 +Add metadata for the pod. Currently, you can only set annotations for the pod. + +* Click **Add** to set multiple annotations. +* To delete an annotation, Click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right of the created annotation. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc new file mode 100644 index 000000000..3045832b8 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc @@ -0,0 +1,16 @@ +// :ks_include_id: addcd8f38f374f16a793b840c8f4524b +Configure the ports for the container. Click **Use Default Port of Images** to set the container ports to the default ports of the image. Click **Add Port** to set multiple ports for the container. + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Protocol +| The protocol that the application in the container actually listens to. To use the Application Governance features provided by KubeSphere, ensure that the selected protocol matches the protocol that the application in the container actually listens to. + +| Name +| The name of the port. To use the Application Governance features provided by KubeSphere, use the lowercase protocol name as a prefix for the port name (e.g., **http-**). + +| Container Port +| The port number that the application in the container actually listens to. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc new file mode 100644 index 000000000..f812b785a --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc @@ -0,0 +1,22 @@ +// :ks_include_id: 90da833da58d47cbad5d77d94fe4d826 +Create post-start or pre-termination actions for the container. + +* Click **Add Action** to create an action. + +* Hover over the created action, then click image:/images/ks-qkcp/zh/icons/pen-light.svg[pen,18,18] on the right to edit the action settings. + +* Hover over the created action, then click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right to delete the action. + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Path +| The protocol (HTTP or HTTPS), the path relative to the virtual IP address of the pod for HTTP requests, and the port number for the request. Only available when the action execution method is **HTTP Request**. + +| Command +| The command to run in the container. You can use commas (,) to separate the commands and its parameters. Only available when the action execution method is **Command**. + +| Port +| The container port number for TCP checks. Only available when the action execution method is **TCP Port**. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc new file mode 100644 index 000000000..1e5990d8e --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 26629381ce2c4637b491e4fe2386923e +Create containers to run within the pod. You can create multiple containers within a pod. + +* Click **Add Container** to create a container. + +* Hover over a created container, then click image:/images/ks-qkcp/zh/icons/pen-light.svg[pen,18,18] on the right to edit the container settings. + +* Hover over a created container, then click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right to delete the container. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc new file mode 100644 index 000000000..b935ee0a4 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 87861bb084774716a738a763e7cb8d5a +|Add Persistent Volume Claim Template +|Add Persistent Volume Claim templates for StatefulSets. The system will create separate Persistent Volume Claims and Persistent Volumes for each pod replica, and mount the Persistent Volumes to the specified containers in each pod replica. Only available for **StatefulSets**. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc new file mode 100644 index 000000000..d76f70679 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc @@ -0,0 +1,37 @@ +// :ks_include_id: 55d0e202da594ec3bf0eec8a473d3557 +Create probes for liveness, readiness, or startup checks on the container. + +* Click **Add Probe** to create a probe. + +* Hover over the created probe, then click image:/images/ks-qkcp/zh/icons/pen-light.svg[pen,18,18] on the right to edit the probe settings. + +* Hover over the created probe, then click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right to delete the probe. + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Path +| The protocol (HTTP or HTTPS), the path relative to the virtual IP address of the pod for HTTP requests, and the port number for the request. Only available when the health check method is **HTTP Request**. + +| Command +| The command to run in the container. You can use commas (,) to separate the commands and its parameters. Only available when the health check method is **Command**. + +| Port +| The container port number for TCP checks. Only available when the health check method is **TCP Port**. + +| Initial Delay +| The delay time in seconds before the probe is initiated after container startup. + +| Timeout +| The timeout period for the probe in seconds. After the timeout, the check will be considered a failure. The value must be an integer, with a minimum of **0**. + +| Check Interval +| The time interval for performing checks in seconds. The value must be an integer, with a minimum of **1**. + +| Success Threshold +| The minimum consecutive successes required to consider the check successful after a failure. The minimum value is **1**. For liveness probes and startup probes, this parameter must be **1**. + +| Failure Threshold +| The minimum consecutive failures required to consider the check failed after a success. The minimum value is **1**. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-basicInformation.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-basicInformation.adoc new file mode 100644 index 000000000..809ada33c --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-basicInformation.adoc @@ -0,0 +1,24 @@ +* Basic Information ++ +-- +Configure the basic information for the workload. + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Name +| The name of the workload. The name can only contain lowercase letters, numbers, and hyphens (-). It must start and end with a lowercase letter or number, with a maximum length of 253 characters. + +| Alias +| The alias of the workload. Aliases can be the same for different workloads. The alias can only contain Chinese characters, letters, numbers, and hyphens (-). It must not start or end with a hyphen (-), with a maximum length of 63 characters. + +ifndef::kubefed[] +| Project +| The project in which the resources will be created. +endif::[] + +| Description +| The description of the workload. The description can contain any characters, with a maximum length of 256 characters. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc new file mode 100644 index 000000000..8287db436 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: e37f1e1a226842e7b71cfc533a74d392 +|收集卷上日志 +| +允许系统收集保存在卷上的容器日志。如需使用此功能，您需要进行以下操作： + +* 在容器所在的项目中启用**收集卷上日志**功能。 + +* 在**存储设置**页签启用**收集卷上日志**功能，为容器挂载读写模式的持久卷或临时卷，并设置**容器日志路径**。 + +* 设置容器中的应用程序将日志导出到卷挂载目录下的**容器日志路径**。 + +include::workloads-desc-viewContainerLogsOnVolume.adoc[] diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc new file mode 100644 index 000000000..0f55c46b7 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 0c5011c424e145ec95155aed67c9fccb +| Image +| +The image required to create the container. + +* Enter the image name (e.g., **nginx:latest**) or path (e.g., **docker.io/nginx:latest**), then press **Enter** to search for the image. + +* If you only enter the image name, the image will be pulled from Docker Hub by default. To use a private image registry, you need to create a Secret containing the information for the private image registry, and then select the private image registry on the left side of the **Image** text box. + +* Click image:/images/ks-qkcp/zh/icons/templet.svg[template,18,18] to browse images in the current image registry. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerLogPath.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerLogPath.adoc new file mode 100644 index 000000000..32a54a753 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerLogPath.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 186f24631180443aafb16fad9a46d724 +|容器日志路径 +|启用**收集卷上日志**功能时，容器日志的所在路径。 + +* 该路径相对于卷的挂载路径，支持通配符，可使用半角逗号（,）分隔多个路径。例如，当卷挂载路径为 **/data** 时，**log/*.log** 表示日志文件为 **/data/log** 目录下所有 .log 格式的文件。 + +* 如需使用**收集卷上日志**功能，您需要设置容器中的应用程序将日志导出到此处设置的路径。 + +include::workloads-desc-viewContainerLogsOnVolume.adoc[] diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc new file mode 100644 index 000000000..054bba4ae --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 3e5d0001b8ce42a688e457086df147d3 +| Container Name +| The name of the container. The name can only contain lowercase letters, numbers, and hyphens (-). It must start and end with a lowercase letter or number, with a maximum length of 63 characters. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc new file mode 100644 index 000000000..3b6a50a26 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc @@ -0,0 +1,36 @@ +// :ks_include_id: 03ba4803bc5e4930b178cd6397356d2c +Configure the permissions of the container process in the Linux system. + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Access Control +| Access permissions for the container process. + +* **Privileged Mode**: Run the container process as the **root** user on the host. + +* **Allow Privilege Escalation**: Allow the container process to gain more privileges than the parent process. This option is enabled by default when **Privileged Mode** is enabled. + +* **Root Directory Read-Only**: Set the root directory of the container filesystem to read-only. + +|User and User Group +| +The users and user groups running the entry point of container processes. + +* **Run as Non-root**: Checks if the container will run as the **root** user before starting. If the container is set to run as the **root** user, it won't start. When this feature is enabled, the system will ignore the **Privileged mode** setting. + +* **User**: The UID (User ID) executing the container process entry point. Defaults to the UID specified in the image metadata. + +* **User Group**: The GID (Group ID) executing the container process entry point. Defaults to the default GID of the container runtime. + +|SELinux Context +|The SELinux labels for the container process, including **Level**, **Role**, **Type**, and **User**. For more information, refer to the link:https://www.selinuxproject.org/page/Main_Page[SELinux Documentation]. + +| Capabilities +| Additional capabilities added to or removed from the container process in the Linux system. Refer to the link:https://man7.org/linux/man-pages/man7/capabilities.7.html[Linux Documentation] for the list of Linux process capabilities. + +* When adding or removing capabilities for the container process, you need to remove the **CAP_** prefix from the capability names. For example, entering **SYS_TIME** in the **Drop** text box will remove the **CAP_SYS_TIME** capability from the container process. + +* Click **Add** to set multiple instructions for adding or removing capabilities. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc new file mode 100644 index 000000000..f130554ec --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 44485d9a2c89473b896d0aa6c172b2c2 +| Container Type +| +The type of container. + +* **Init Container**: A container that performs initialization tasks for the working containers. The working containers will only start after all init containers have successfully completed. If an init container fails, the system sets the status of the pod to failure. + +* **Work Container**: A container that runs the application. It is generally recommended to have only one work container running in each pod. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc new file mode 100644 index 000000000..63f03672f --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc @@ -0,0 +1,29 @@ +// :ks_include_id: 3bea77d96c69484c89893f226380c3c4 +Configure custom rules for pod scheduling. + +* Click **Add** to set multiple rules. +* To delete a rule, Click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right of the created rule. + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Type +| +The type of the rule. + +* **Schedule with target** : Pod replicas will be scheduled to the same node as other pods with specific labels in the current project. + +* **Schedule away from target** : Pod replicas will be scheduled to different nodes than other pods with specific labels in the current project. + +|Policy +| +The policy by which the rule is enforced. + +* **Match if possible** : Try to satisfy the rule as much as possible. If the rule cannot be satisfied, the pod replicas will be scheduled to nodes that do not meet the rule requirements. + +* **Must match** : Must satisfy the rule requirements. If the rule requirements cannot be met, the pod replicas will not be scheduled to any node. + +|Target +|The target of the rule. Pod replicas will be scheduled to the same or different nodes as pods with the label **app=** ( is the selected value here), depending on the rule's type and policy. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc new file mode 100644 index 000000000..096fe73ad --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc @@ -0,0 +1,25 @@ +// :ks_include_id: 5f8f7ff05ece4c439f6806ad715b9c8c +Configure environment variables for the container. + +* Click **Add Environment Variable** to set multiple environment variables. + +* Click **Batch Reference** to create environment variables using data from a ConfigMap or Secret. The ConfigMap or Secret to be referenced must belong to the same project as the container. The values of environment variables will not dynamically change with changes made in the ConfigMap or Secret after the container is created. + +* Click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right of the created environment variable to delete it. + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Key +| The name of the environment variable. + +| Value +| The value of the environment variable. + +| Resource +| The name of the ConfigMap or Secret. Only available when referencing a ConfigMap or Secret. + +| Key in Resource +| The key in the ConfigMap or Secret. The value corresponding to this key will be used as the value of the environment variable. Only available when referencing a ConfigMap or Secret. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc new file mode 100644 index 000000000..c466e22be --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc @@ -0,0 +1,34 @@ +// :ks_include_id: ddb539fa66e840c9875e39645fc55d2a +Check the health status of the container. Before using this feature, you need to configure the application within the container to return the results of the health check. + +KubeSphere supports the following types of health check: + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Liveness Check +| Checks if the container is alive. If the liveness check fails, the system will attempt to restart the container. + +| Readiness Check +| Checks if the container is ready to process requests. If the readiness check fails, the system will prevent access to the pod through a service. + +| Startup Check +| Checks if the container has started. If the startup check fails, the system will disable other probes for the container and attempt to restart it. +|=== + +KubeSphere supports the following check methods: + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| HTTP Request +| Sends an HTTP GET request to the virtual IP address of the pod. If the response status code is 2XX or 3XX, the check is considered successful. + +| Command +| Runs a command in the container. The check is considered successful if the command's exit code is 0. + +| TCP Port +| Attempts to establish a TCP connection with the specified container port. The check is considered successful if the connection is established. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc new file mode 100644 index 000000000..aaebe6bf6 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc @@ -0,0 +1,19 @@ +// :ks_include_id: 9cc1c0abc4d6458bb0cfc67f88dc1f32 +Mount a file or directory on the node where the pod is located to the container using a HostPath volume. + +* Files or folders under the same path on different nodes may differ, so pod replicas on different nodes may read different data from the HostPath volume. + +* Ensure that the mounted path exists on the node where the pod is located, and the container process has the necessary permissions. Otherwise, the container process will be unable to read from or write to the data in the HostPath volume. + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Volume Name +|The name of the HostPath volume. + +|Host Path +|The path to the file or folder on the node that needs to be mounted. + +include::workloads-para-volumeMountModePath.adoc[] +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc new file mode 100644 index 000000000..9783d2170 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc @@ -0,0 +1,16 @@ +// :ks_include_id: d8d9b2087a9849b68d0e028a81a20303 +Set whether to pull images from the image registry when creating or updating Pods. + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Use Local Image First +| When creating or updating a pod, prioritize using the images stored by the container runtime on the node. + +| Pull Image Always +| When creating or updating a pod, pull the image from the image registry every time. + +| Use Local Image Only +| When creating or updating a pod, only use the images stored by the container runtime on the node. If the required image is not available locally, the pod may be created with an exception. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc new file mode 100644 index 000000000..7055ab882 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc @@ -0,0 +1,35 @@ +// :ks_include_id: 2c06de3e1ab94af48b7328587c8256b5 +Configure actions to be performed after the container starts or before it terminates for environment checking or graceful termination. Before using this feature, you need to configure the application within the container to return the results of the performed action. + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Post-start Action +| The action to be performed after the container starts. If the post-start action fails, the system will attempt to restart the container. + +| Pre-stop Action +| The action to be performed before the container terminates. This action follows these rules: + +* If the pre-stop action fails, the system will terminate the container immediately. + +* The default period for the graceful termination of a container is 30 seconds. If the pres-stop action is still running when the grace period ends, the system will provide a one-time grace period of 2 seconds. + +* After the grace period ends, regardless of whether the pres-stop action has finished, the system will terminate the container. +|=== + +KubeSphere supports the following execution methods for post-start actions and pre-stop actions: + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| HTTP Request +| Sends an HTTP GET request to the virtual IP address of the pod. If the response status code is 2XX or 3XX, the action is considered successful. + +| Command +| Runs a command in the container. The action is considered successful if the command's exit code is 0. + +| TCP Port +| Attempts to establish a TCP connection with the specified container port. The action is considered successful if the connection is established. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc new file mode 100644 index 000000000..6213c1401 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc @@ -0,0 +1,27 @@ +// :ks_include_id: 797ea47d2afa4ac7bf41bd1f29f2097a +Mount data from ConfigMaps or Secrets as a volume to the container. + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Select Configmap/Select Secret +|Select the ConfigMap or Secret in the current project. + +|Mount Mode +|Set the mount mode of the data from the ConfigMap or Secret on the container. Configmaps and Secrets only support mounting in **Read-only** mode or **Not mounted**. + +|Mount Path +|Set the path where the data from the ConfigMap or Secret is mounted on the container. + +* The system will generate a folder based on the data from the ConfigMap or Secret and map each key-value pair to a file. Each file is named after the key, and the content is the value. + +* Click image:/images/ks-qkcp/zh/icons/textfield.svg[textfield,18,18] to specify key-value pairs from the ConfigMap or Secret as files to be mounted. If no subpath is set, the entire ConfigMap or Secret is mounted by default. If a subpath is used, files mounted to the container will not dynamically update with changes in the ConfigMap or Secret. + +|Select Specific Keys +|Mount key-value pairs from the ConfigMap or Secret as files to the container. Files mounted to the container will dynamically update with changes in the ConfigMap or Secret. Click **Add** to mount multiple key-value pairs. + +* **Key**: The key of the key-value pair in the ConfigMap or Secret to be mounted. + +* **Path**: The path relative to the **Mount Path** in the container. The specified key-value pair from the ConfigMap or Secret will be mounted to this path, and existing files in the **Mount Path** will be overwritten. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc new file mode 100644 index 000000000..91ed0b283 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: a57200e8b62d4d6d901d0981c1ee5639 +|Mount ConfigMap or Secret +|Mount data from ConfigMaps or Secrets as a volume to the container. diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc new file mode 100644 index 000000000..50ceefa39 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 2f14bbf086794d0294530c5059da2be3 +|Mount Volume +|Mount Persistent Volumes, temporary volumes, or HostPath volumes to the container. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc new file mode 100644 index 000000000..51c6c8373 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: 1cf098581c104c40a442ab4ebc7be6ce +Mount a Persistent Volume for the container. The Persistent Volume Claim used to create the Persistent Volume must belong to the project where the container is located. + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Select Persistent Volume Claim +|Select the Persistent Volume Claim used to create the Persistent Volume. This Persistent Volume Claim must belong to the project where the container is located. If there is no available Persistent Volume Claim in the project of the container, you need to create one in advance. + +include::workloads-para-volumeMountModePath.adoc[] +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podIpPool.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podIpPool.adoc new file mode 100644 index 000000000..3996b7fd3 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podIpPool.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 6ba8bee2592a4a259898c42507fefa4b +|容器组 IP 池 +|选择用于为容器组副本分配虚拟 IP 地址的 IP 池。 diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podReplicas.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podReplicas.adoc new file mode 100644 index 000000000..0bf8f868b --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podReplicas.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: b523f301f41c402bb4b78d252ab3ffa2 +* Pod Settings > Number of Pod Replicas ++ +-- +Click image:/images/ks-qkcp/zh/icons/add-light.svg[add,18,18] or image:/images/ks-qkcp/zh/icons/substract-light.svg[substract,18,18] to increase/decrease the number of pod replicas. The minimum value is **1**. +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc new file mode 100644 index 000000000..e0411178f --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc @@ -0,0 +1,19 @@ +// :ks_include_id: 5c07b382dc7041a6b8d89f45dadfad06 +Specify the rules for scheduling pod replicas to nodes. + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Default Rules +|No rules specified; The system determines which node the pod replicas should be scheduled to. + +|Decentralized Scheduling +|Schedule pod replicas to different nodes whenever possible. + +|Centralized Scheduling +|Schedule pod replicas to the same node whenever possible. + +|Custom Rules +|Schedule pod replicas to nodes based on user-defined rules. If you choose this option, you need to further customize the scheduling rules. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podSecurityContext.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podSecurityContext.adoc new file mode 100644 index 000000000..9e7b0a624 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podSecurityContext.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 3156e518c97e495ebdd0028761edc427 +Set the permissions for all container processes in the pod within a Linux system. If both pod security context and container security context have set the user, group, and SELinux context, the settings in the container security context will override those in the pod security context. + +[options="header",cols="1a,4a"] +|=== +|Parameter |Description + +include::workloads-para-uidGidSelinux.adoc[] +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc new file mode 100644 index 000000000..584993a82 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc @@ -0,0 +1,13 @@ +// :ks_include_id: 0ae400ef2e644b79a0442a3a094b55b7 +Configure the parameters related to the Rolling Update strategy. + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Max Unavailable Pods +|The maximum number or percentage of unavailable pod replicas allowed during the update process. + +|Max Extra Pods +|The maximum number or percentage of extra pod replicas allowed during the update process. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc new file mode 100644 index 000000000..3df22a9fe --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 0314f28e62bf4e7fb08d1c779601d170 +| Select Nodes +| +Schedule pod replicas to nodes with specified labels. + +* You can manually enter key-value pairs for the labels of the target node, or click **Specify Node** to choose a node. + +* Click **Add Node Selector** to set multiple labels; pod replicas will be scheduled to nodes with all specified labels. + +* Click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right of a created label to delete it. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc new file mode 100644 index 000000000..5edfad418 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc @@ -0,0 +1,13 @@ +// :ks_include_id: 64d2897f5b044d81b1a2e5772897e884 +Configure the command to be executed inside the container when it starts. + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Command +| The startup command to be executed. + +| Parameters +| The parameters of the startup command. Use commas to separate multiple parameters. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc new file mode 100644 index 000000000..a5689d272 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 4c4df684b9b74e1a9e5cf5aab6f90439 +Select the checkbox on the left of **Synchronize Host Timezone** will synchronize the timezone between the container and the host. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume.adoc new file mode 100644 index 000000000..aa41cab8c --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume.adoc @@ -0,0 +1,20 @@ +// :ks_include_id: cc570a193fc8465392e3f53790581f56 +为容器挂载临时卷。临时卷具有以下特点： + +* 由系统自动在容器组所在的节点的存储系统中创建。 + +* 由系统自动管理，容量上限为节点的存储容量。 + +* 无法保存持久化数据，容器组创建时由系统自动创建临时卷，容器组删除时由系统自动删除临时卷。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|卷名称 +|临时卷的名称。 + +include::workloads-para-volumeMountModePath.adoc[] + +// include::workloads-para-containerLogPath.adoc[] +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume_new.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume_new.adoc new file mode 100644 index 000000000..01cc42bc9 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume_new.adoc @@ -0,0 +1,18 @@ +// :ks_include_id: cc570a193fc8465392e3f53790581f56 +Mount a temporary volume for the container. Temporary volumes have the following characteristics: + +* Automatically created by the system in the storage system of the node where the pod is located. + +* Managed automatically by the system, with a capacity limit equal to the storage capacity of the node. + +* Cannot store persistent data; the system creates and deletes temporary volumes automatically when the pod is created or deleted. + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Volume Name +|The name of the temporary volume. + +include::workloads-para-volumeMountModePath.adoc[] +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-uidGidSelinux.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-uidGidSelinux.adoc new file mode 100644 index 000000000..f56281dd0 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-uidGidSelinux.adoc @@ -0,0 +1,13 @@ +// :ks_include_id: 2fc5442d4a274f9dbf5b17caa5a4926a +|User and User Group +| +The users and user groups running the entry point of container processes. + +* **Run as Non-root**: Checks if the container will run as the **root** user before starting. If the container is set to run as the **root** user, it won't start. When this feature is enabled, the system will ignore the **Privileged mode** setting. + +* **User**: The UID (User ID) executing the container process entry point. Defaults to the UID specified in the image metadata. + +* **User Group**: The GID (Group ID) executing the container process entry point. Defaults to the default GID of the container runtime. + +|SELinux Context +|The SELinux labels for the container process, including **Level**, **Role**, **Type**, and **User**. For more information, refer to the link:https://www.selinuxproject.org/page/Main_Page[SELinux Documentation]. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc new file mode 100644 index 000000000..f5cc8a075 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc @@ -0,0 +1,13 @@ +// :ks_include_id: 6d48b5a3f3c74e7f958661364e5294d0 +Set the update strategy for pods. + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Rolling Update (Recommended) +|Gradually replace old pod replicas with new ones. During the update, the business traffic is load-balanced between old and new pod replicas, ensuring uninterrupted service. If you choose this strategy, you need to further configure **Maximum Unavailable Pods** and **Maximum Extra Pods**. + +|Simultaneous Update +|Delete all existing pod replicas and create new ones. The service is interrupted during the update. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-volumeMountModePath.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-volumeMountModePath.adoc new file mode 100644 index 000000000..5fc3da98f --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-volumeMountModePath.adoc @@ -0,0 +1,13 @@ +// :ks_include_id: 4401458e342646d99223518791c4a0b6 +|Mount Mode +| +The mount mode of the volume on the container. + +* **Read and write**: Allows the container to read from and write to the volume. + +* **Read-only**: Only allows the container to read from the volume. + +* **Not mounted**: The volume is not mounted to the container. + +|Mount Path +|The path where the volume is mounted to the container. Click image:/images/ks-qkcp/zh/icons/textfield.svg[textfield,18,18] to set the subpath that needs to be mounted. If no subpath is set, the entire volume is mounted by default. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc new file mode 100644 index 000000000..fe3281ed9 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc @@ -0,0 +1,22 @@ +// :ks_include_id: ae4fedba880e403d9c8c4888b5134d9c +Create separate Persistent Volume Claims and Persistent Volumes for each pod replica using the Persistent Volume Claim template and mount the Persistent Volumes to containers. Only available for **StatefulSets**. + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|PVC Name Prefix +|The prefix for the names of the Persistent Volume Claims created by the Persistent Volume Claim template. The system will automatically name the Persistent Volume Claims in the format `--`. Persistent volume claims for different pod replicas in the same StatefulSet are distinguished by the . + +|Storage Class +|The storage class used to create the Persistent Volume Claims. + +|Access Mode +| +include::../../persistentVolumeClaims/persistentVolumeClaims-para-accessMode.adoc[] + +|Volume Capacity +|The capacity of each Persistent Volume created by the Persistent Volume Claim template. + +include::workloads-para-volumeMountModePath.adoc[] +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-adjustTheNumberOfPodReplicas.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-adjustTheNumberOfPodReplicas.adoc new file mode 100644 index 000000000..10b15c025 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-adjustTheNumberOfPodReplicas.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 04ecee90589140c28c84ab59ddd6aeb7 +This section explains how to adjust the replica count of pods in a workload. diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-createAWorkload.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-createAWorkload.adoc new file mode 100644 index 000000000..081eedcb4 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-createAWorkload.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 651c070ef5524b1abe5f616f9bb1cbc1 +This section explains how to create workloads. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-deleteWorkloads.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-deleteWorkloads.adoc new file mode 100644 index 000000000..2d171aa9c --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-deleteWorkloads.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: 0b50b8cf874242deb4bc9fbabcd2bdb7 +This section explains how to delete a workload. + +//warning +[.admon.warning,cols="a"] +|=== +| Warning + +| +This operation will delete the workload and all pods managed by it. The business running in the workload will be interrupted. Please proceed with caution. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-editAutoScaling.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-editAutoScaling.adoc new file mode 100644 index 000000000..34ee61803 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-editAutoScaling.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 23d4ffc14a2f4f8a90a5a1b4d918d0e4 +This section explains how to edit autoscaling settings for workloads. + +The autoscaling feature allows the system to automatically adjust the pod replica count based on the target CPU and memory usage of all replicas in the workload. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-editWorkloadInformation.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-editWorkloadInformation.adoc new file mode 100644 index 000000000..4c1794cc4 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-editWorkloadInformation.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 8c633944651a4fc5ab95bedaaaa6eccf +This section explains how to edit workload information. + +You can edit the alias and description of the workload. KubeSphere does not support editing the name of an already created workload. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-editWorkloadSettings.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-editWorkloadSettings.adoc new file mode 100644 index 000000000..abf5612a0 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-editWorkloadSettings.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: c3706078af3f41c487c1a5fc573ef5bb +This section explains how to edit settings for created workloads. + +After the workload is created, you can edit the workload's update strategy, containers, storage, pod scheduling rules and pod grace period. diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-recreateAWorkload.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-recreateAWorkload.adoc new file mode 100644 index 000000000..4c504f199 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-recreateAWorkload.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: 373ea79d7dc9465b90f0d8a7d6ae5062 +This section explains how to recreate a workload. + +//warning +[.admon.warning,cols="a"] +|=== +|Warning + +| +This operation will delete and recreate all pods in the workload. The business in the workload will be interrupted until the new pods are created. Please proceed with caution. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-rollBackWorkloadSettings.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-rollBackWorkloadSettings.adoc new file mode 100644 index 000000000..586525dd4 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-rollBackWorkloadSettings.adoc @@ -0,0 +1,13 @@ +// :ks_include_id: 963da033862c424c9fc9f2cc246602fb +This section explains how to roll back workload settings. + +The system generates revision records after creating or modifying workloads, which can be used to roll back workload settings. Up to 10 revision records can be retained. + +//warning +[.admon.warning,cols="a"] +|=== +| Warning + +| +This operation will recreate the workload based on the selected revision record, and the running business will be interrupted. Please proceed with caution. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-stopWorkloads.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-stopWorkloads.adoc new file mode 100644 index 000000000..43aee1798 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-stopWorkloads.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: e824d7c6552945beaedf6ace7863defa +This section explains how to stop workloads. + +//warning +[.admon.warning,cols="a"] +|=== +| Warning + +| +This operation will adjust the pod replica count to 0, and the running business will be interrupted. Please proceed with caution. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-viewAWorkloadList.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-viewAWorkloadList.adoc new file mode 100644 index 000000000..8104dd8e9 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-viewAWorkloadList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 50f92d72149e46929bf7119f2fe1242a +This section explains how to view the list of workloads. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-viewWorkloadDetails.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-viewWorkloadDetails.adoc new file mode 100644 index 000000000..e584ccf6d --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-viewWorkloadDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 28b4a5dc9202450094b2d3bff92d4f7a +This section explains how to view workload details. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-workloads.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-workloads.adoc new file mode 100644 index 000000000..e7768fb14 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-desc-workloads.adoc @@ -0,0 +1,14 @@ +// :ks_include_id: d035ff78f85d42acb9f1d0b5715617e3 +This section explains how to manage workloads. + +In KubeSphere, applications run in pods. To ensure business continuity in case of pod failures, it is common to create multiple replicas of a pod for an application. Workloads are responsible for managing replicas of pods and provide the following key functionalities: + +* Automatically scale the number of pod replicas based on user-defined conditions. +* Automatically update pods based on user-specified update strategies. +* Roll back pods to previous versions. + +KubeSphere supports the following types of workloads: + +* **Deployments**: Used to manage stateless applications. Multiple replicas managed by a Deployment share a common volume. When a pod replica is recreated, the new and old replicas have different names. +* **StatefulSets**: Used to manage stateful applications. Multiple replicas managed by a StatefulSet can use independent volumes. Each pod replica has a fixed index in its name, and when a pod replica is recreated, the new and old replicas have the same name. +* **DaemonSets**: Used to manage daemon processes. DaemonSet ensures that one pod replica runs on all or specific nodes. When a new node is added to the cluster, if the new node meets the scheduling rules, DaemonSet will automatically create a pod replica on the new node. diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-multi-project-oper-createAWorkload-ClusterDiff.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-multi-project-oper-createAWorkload-ClusterDiff.adoc new file mode 100644 index 000000000..b38edbaa0 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-multi-project-oper-createAWorkload-ClusterDiff.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: 436a1f9062db4517a30c7da15aad1061 + +. 在**基本信息**页签，设置工作负载的基本信息，然后点击**下一步**。 + +. 在**容器组设置**页签，为工作负载管理的容器组设置副本数量、容器、更新策略、安全上下文、调度规则和元数据，然后点击**下一步**。 + +. 在**存储设置**页签，为工作负载管理的容器挂载卷，然后点击**下一步**。 + +. 在**高级设置**页签，为工作负载管理的容器组指定节点，并设置工作负载的元数据。 + +. 在**集群差异设置**页签，为不同集群中的工作负载基于容器、端口和环境变量进行差异化设置，然后点击**创建**。工作负载创建完成后将显示在工作负载列表中。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc new file mode 100644 index 000000000..43a0cd5ae --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d908eb90806d4d4ba8b6cbb65a3b96e1 +. 在**工作负载**页面，点击**部署**或**有状态副本集**打开工作负载列表。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-multi-project-oper-searchForWorkloads.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-multi-project-oper-searchForWorkloads.adoc new file mode 100644 index 000000000..a336a271a --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-multi-project-oper-searchForWorkloads.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 2f8f4e8c4cba43e0b81959fc339f9ca5 +* 在列表上方点击搜索框并设置搜索条件，可按名称搜索工作负载。 diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-adjustTheNumberOfPodReplicas.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-adjustTheNumberOfPodReplicas.adoc new file mode 100644 index 000000000..ccf405511 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-adjustTheNumberOfPodReplicas.adoc @@ -0,0 +1,13 @@ +// :ks_include_id: d02b5f4b6a354bdfbba1d532b30bda69 +. On the **Resource Status** tab of the workload details page, click image:/images/ks-qkcp/zh/icons/add-dark.svg[add-dark,18,18] or image:/images/ks-qkcp/zh/icons/substract-dark.svg[subtract-dark,18,18] to adjust the replica count. Then, in the **Adjust Replicas** dialog at the top right corner, click **OK**. ++ +-- +//warning +[.admon.warning,cols="a"] +|=== +| Warning + +| +If you adjust the pod replica count to 0, all replicas managed by the workload will be deleted, and the running business will be interrupted. Please proceed with caution. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-createAWorkload.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-createAWorkload.adoc new file mode 100644 index 000000000..d7a0bfc7f --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-createAWorkload.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 7187f68c21894926871b0e1276d5aa7e +. On the **Basic Information** tab, configure the basic information for the workload, and then click **Next**. + +. On the **Pod Settings** tab, set the replica count, containers, update strategy, security context, scheduling rules, and metadata for the pods managed by the workload, then click **Next**. + +. On the **Storage Settings** tab, mount volumes for the containers managed by the workload, then click **Next**. + +. On the **Advanced Settings** tab, specify IP pools and nodes for the pods managed by the workload, set metadata for the workload, then click **Create**. ++ +Once the workload is created, it will be displayed in the list of workloads. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-deleteASingleWorkload.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-deleteASingleWorkload.adoc new file mode 100644 index 000000000..41e4a89de --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-deleteASingleWorkload.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 25d819a958bf49fba9f643a2551ac347 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the workload you want to delete, then choose **Delete** from the dropdown list. diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-deleteMultipleWorkloads.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-deleteMultipleWorkloads.adoc new file mode 100644 index 000000000..6845badab --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-deleteMultipleWorkloads.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 87be09b63bf240abaec1c953680d92e6 +. Select the checkbox on the left side of the workloads you want to delete, then click **Delete** above the workload list. + +. In the **Delete Multiple Workloads** dialog, confirm and select the names of the resources related to the workloads to be deleted, then click **OK**. diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-editAutoScalingSettings.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-editAutoScalingSettings.adoc new file mode 100644 index 000000000..0f71cfc0c --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-editAutoScalingSettings.adoc @@ -0,0 +1,23 @@ +// :ks_include_id: d77f09013e3f495b8bea4d8b7300d5e0 +. On the top left of the workload details page, select **More > Edit Autoscaling**. + +. In the **Autoscaling** dialog, set the autoscaling parameters for the workload, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Target CPU Usage +|Target CPU usage for all pod replicas in the workload, measured in percentage. When the actual CPU usage is higher/lower than the target value, the system automatically decreases/increases the replica count. + +|Target Memory Usage +|Target memory usage for all pod replicas in the workload, measured in MiB. When the actual memory usage is higher/lower than the target value, the system automatically decreases/increases the replica count. + +|Minimum Replicas +|The minimum allowed pod replica count, with a default value of **1**. + +|Maximum Replicas +|The maximum allowed pod replica count, with a default value of **1**. +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-editWorkloadInformation.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-editWorkloadInformation.adoc new file mode 100644 index 000000000..ebe217d11 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-editWorkloadInformation.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: 4d2fb1de6b844f18938f0c8b6f08e279 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the workload you want to edit, then choose **Edit Information** from the dropdown list. + +. In the **Edit Information** dialog, set the alias and description for the workload, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Alias +| The alias of the workload. Aliases can be the same for different workloads. An alias can only contain Chinese characters, letters, numbers, and hyphens (-). It cannot start or end with a hyphen (-) and has a maximum length of 63 characters. + +| Description +| The description of the workload. The description can contain any characters, with a maximum length of 256 characters. +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-editWorkloadSettings.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-editWorkloadSettings.adoc new file mode 100644 index 000000000..194c18c57 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-editWorkloadSettings.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c86d968a626a4554a7415088043f003c +. On the top left of the workload details page, select **More > Edit Settings**. diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-openDetailsPage.adoc new file mode 100644 index 000000000..23c5275cb --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9a57470c05844927b339f00b72bbb342 +. On the **Workloads** page, click **Deployments**, **StatefulSets**, or **DaemonSets**, then click the name of a workload in the list to open its details page. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-openListPage.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-openListPage.adoc new file mode 100644 index 000000000..5129a83fc --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 7dd8d24939c3454f805540ee4215b74a +. On the **Workloads** page, click **Deployments**, **StatefulSets**, or **DaemonSets** to open the list of workloads. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-recreateAWorkload.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-recreateAWorkload.adoc new file mode 100644 index 000000000..d76e3b2bf --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-recreateAWorkload.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 0578975ed65b41108f5ec9903fae44ca +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the workload you want to recreate, then choose **Re-create** from the dropdown list. + +. In the **Re-create** dialog, click **OK**. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-rollBackWorkloadSettings.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-rollBackWorkloadSettings.adoc new file mode 100644 index 000000000..ec1f8324b --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-rollBackWorkloadSettings.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 87b86dd518334714ad747818ae534b07 +. On the top left of the workload details page, select **More > Roll Back**. + +. In the **Roll Back** dialog, select the **Target Revision Record**, then click **OK**. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-searchForWorkloads.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-searchForWorkloads.adoc new file mode 100644 index 000000000..88c443446 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-searchForWorkloads.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: cf8f148335ee4a91b16003d41eff0731 +* Click the search box at the top of the list to search for workloads by name or status. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-stopWorkloads.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-stopWorkloads.adoc new file mode 100644 index 000000000..50068e2f8 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-stopWorkloads.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 7e1535bd60ce4490bccd43efa8138a1e +. Select the checkbox on the left side of the workloads you want to stop, then click **Stop** above the workload list. + +. In the **Stop Workload** dialog, enter the name of the workload, then click **OK**. ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-viewWorkloadDetails.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-viewWorkloadDetails.adoc new file mode 100644 index 000000000..b176f7df3 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-viewWorkloadDetails.adoc @@ -0,0 +1,78 @@ +// :ks_include_id: c4e995deeaff4c618dca0b53432cab70 +. 在工作负载详情页面左侧的**属性**区域查看工作负载的资源属性。 ++ +-- + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群 +|工作负载所属的集群。 + +|项目 +|工作负载所属的项目。 + + +|应用 +|工作负载所属的应用名称。您可以创建一个包含多个服务的应用，每个服务都对应一个工作负载。 + +|创建时间 +|工作负载的创建时间。 + +|更新时间 +|工作负载的更新时间。 + +|创建者 +|创建工作负载的用户。 +|=== +-- + +. 在工作负载详情页面右侧的**资源状态**页签查看工作负载的容器组副本数量、容器端口和容器组。 ++ +-- +include::../../para-replicasPortsPods.adoc[] +-- + +. 在工作负载详情页面右侧点击**修改记录**页签查看工作负载的修改记录。 ++ +-- +* 在下拉列表中选择一个修改记录可查看其序列号、创建时间和副本集配置文件。{ks_product-en}系统自动为每个修改记录创建一个序列号，最多可保留 10 条修改记录。 + +* **配置文件**区域显示当前副本集配置文件相比前一个修订记录的副本集配置文件的差异。点击image:/images/ks-qkcp/zh/icons/chevron-down.svg[chevron-down,18,18]可以纵向显示配置文件差异，点击image:/images/ks-qkcp/zh/icons/chevron-right.svg[chevron-right,18,18]可以横向显示配置文件的差异。 +-- + +. 在工作负载详情页面右侧点击**元数据**页签查看工作负载的标签和注解。 + +. 在工作负载详情页面右侧点击**监控**页签查看工作负载的实时资源使用情况。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|CPU 用量 +|工作负载管理的所有容器组的实时 CPU 用量。 + +|内存用量 +|工作负载管理的所有容器组的实时内存用量。 + +|出站流量 +|工作负载管理的所有容器组的出站流量。 + +|入站流量 +|工作负载管理的所有容器组的入站流量。 +|=== + +include::../../../../_ks_components-en/oper-selectTimeRange.adoc[] +include::../../../../_ks_components-en/oper-Autorefresh.adoc[] +include::../../../../_ks_components-en/oper-refreshData.adoc[] +-- + +. 在工作负载详情页面右侧点击**环境变量**页签查看工作负载中的所有容器的环境变量。 + +. 在工作负载详情页面右侧点击**事件**页签查看工作负载相关的事件。 ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-viewWorkloadDetails_new.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-viewWorkloadDetails_new.adoc new file mode 100644 index 000000000..3458d114a --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-oper-viewWorkloadDetails_new.adoc @@ -0,0 +1,51 @@ +// :ks_include_id: c4e995deeaff4c618dca0b53432cab70 +. In the **Attributes** section on the left side of the workload details page, view the attributes of the workload. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Cluster +| The cluster to which the workload belongs. + +| Project +| The project to which the workload belongs. + +| Application +| The name of the application to which the workload belongs. You can create an application that includes multiple services, each corresponding to a workload. + +| Creation Time +| The creation time of the workload. + +| Update Time +| The update time of the workload. + +| Creator +| The user who created the workload. +|=== +-- + +. On the right side of the workload details page, on the **Resource Status** tab, view the pod replica count, container ports, and pods of the workload. ++ +-- +include::../../para-replicasPortsPods.adoc[] +-- + +. Click the **Revision Records** tab on the right side of the workload details page to view revision records for the workload. ++ +-- +* Click a revision record from the dropdown list to view its serial number, creation time, and configuration file. KubeSphere automatically creates a serial number for each revision record, and up to 10 revision records can be retained. + +* The **Configuration File** section displays the differences between the current configuration file and the configuration file from the previous revision record. Click image:/images/ks-qkcp/zh/icons/chevron-down.svg[chevron-down,18,18] to vertically display the differences in the configuration files, and Click image:/images/ks-qkcp/zh/icons/chevron-right.svg[chevron-right,18,18] to horizontally display the differences in the configuration files. +-- + +. Click the **Metadata** tab on the right side of the workload details page to view the labels and annotations of the workload. + +. Click the **Environment Variables** tab on the right side of the workload details page to view the environment variables of all containers in the workload. + +. Click the **Events** tab on the right side of the workload details page to view events related to the workload. ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-para-containerStatus.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-para-containerStatus.adoc new file mode 100644 index 000000000..e8021d627 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-para-containerStatus.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 46a592624040499bbca6afbfbae8fe0d +* **Waiting**: The container is performing pre-start operations, such as pulling an image from the image registry or reading data from a Secret. + +* **Running**: The container is running normally. If the container has configured post-start actions and the status is **Running**, then the pre-start actions of the container have been completed. + +* **Terminated**: The container has successfully terminated, or it has terminated due to a failure. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-para-workloadList.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-para-workloadList.adoc new file mode 100644 index 000000000..0b8eb2300 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-para-workloadList.adoc @@ -0,0 +1,24 @@ +// :ks_include_id: db17210e20fc4aeb8e782acd2909f83c +* The workload list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Name +| The name and description of the workload. + +| Status +| +Normal pod replica count, expected pod replica count, and running status of the workload. Workload status includes the following types: + +include::workloads-para-workloadStatus.adoc[] + +| Project +| Project to which the workload belongs. + +| Update Time +| Update time of the workload. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-para-workloadList_new.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-para-workloadList_new.adoc new file mode 100644 index 000000000..a4b52a305 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-para-workloadList_new.adoc @@ -0,0 +1,24 @@ +// :ks_include_id: db17210e20fc4aeb8e782acd2909f83c +* The workload list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Name +| The name and description of the workload. + +| Status +| +Normal pod replica count, expected pod replica count, and running status of the workload. Workload status includes the following types: + +include::workloads-para-workloadStatus.adoc[] + +| App +| Applications to which the workload belongs. + +| Update Time +| Update time of the workload. +|=== +-- diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-para-workloadStatus.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-para-workloadStatus.adoc new file mode 100644 index 000000000..c750d3269 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-para-workloadStatus.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 61e727942543431594ef9dfaf58908c7 +* **Running**: The workload is running normally. + +* **Updating**: The workload is updating pod replicas. + +* **Stopped**: Both the expected and current pod replica count of the workload is 0. \ No newline at end of file diff --git a/content/en/docs/_custom-en/clusterManagement/workloads/workloads-prer-workloadEdited.adoc b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-prer-workloadEdited.adoc new file mode 100644 index 000000000..166404e86 --- /dev/null +++ b/content/en/docs/_custom-en/clusterManagement/workloads/workloads-prer-workloadEdited.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d50e3c90a6c441ba8f7526d537afe063 +* The workload that needs to be rolled back must have been edited, so that the saved revision records can be used for rollback. \ No newline at end of file diff --git a/content/en/docs/_custom-en/glossary.adoc b/content/en/docs/_custom-en/glossary.adoc new file mode 100644 index 000000000..077315015 --- /dev/null +++ b/content/en/docs/_custom-en/glossary.adoc @@ -0,0 +1,299 @@ +== 通用术语 + +[%header,cols="1a,4a"] +|=== +|术语 +|说明 + +|集群（Cluster） +|集群是一组相互独立的计算机或服务器组成的一个较大的计算机服务系统。 + +|节点（Node） +|节点是组成集群的每一台工作机器，可以是虚拟机也可以是物理机。每个节点都可以独立运行和处理任务。 + +|企业空间（Workspace） +|企业空间是用来管理项目和组织成员的基本逻辑单元，是 KubeSphere 多租户系统的基础。 + +|企业空间成员 +|邀请至企业空间中工作的用户，拥有特定的权限。 + +|项目 +|KubeSphere 中的项目对应 Kubernetes 中的命名空间。 + +|多集群项目 +|工作负载部署在多个集群上的项目。 + +|项目成员 +|邀请至项目中工作的用户，拥有特定的权限。 + +|控制台 +|用户的登录页面，会显示租户拥有访问权限的资源，例如企业空间和项目。 + +|容器组（Pod） +|Pod 是应⽤程序的最⼩管理单元，相当于应⽤程序的逻辑主机。每个容器组包含⼀个或多个容器，这些容器共享一些集群资源。每个容器组都旨在运行给定应用程序的单个实例。 + +|容器（Container） +|容器是可移植、可执行的轻量级的镜像，用于封装应用程序及其依赖项的独立运行环境。 + +|镜像（Image） +|镜像是保存的容器实例，包含了应用程序的代码、运行时环境和依赖项。 + +|Docker +|一个开源的应用容器引擎，用于创建、部署和管理容器。 + +|Docker Hub +|一个容器镜像存储库。 + +|KubeKey +|一种全新的安装工具，提供灵活的安装选择，既可以仅安装 Kubernetes，也可以同时安装 Kubernetes 和 KubeSphere。KubeKey 还支持多种安装选项，例如 All-in-One、多节点安装以及离线安装，用户只需要先准备好配置文件再执行相关命令即可。 + +|ks-installer +|在已有 Kubernetes 集群上部署 KubeSphere 的安装包。 + +|kube-proxy +|kube-proxy 是集群中每个节点上所运行的网络代理。 + +|Kubectl +|亦称作: kubectl，与集群的控制平面进行通信的命令行工具，用于集群管理、应用部署、资源状态 查询等操作。 + +|Kubelet +|kubelet 会在集群中每个节点上运行。它保证容器（containers）都运行在 Pod 中。 +|=== + + +== 集群 + +[%header,cols="1a,4a"] +|=== +|术语 +|说明 + +|集群节点 +|集群本地的节点，通常所有集群节点都属于同⼀个私有⽹络。包含控制平面节点和工作节点。 + +|控制平面节点 +|也称为主节点，用来控制和管理整个集群。 + +|工作节点 +|提供容器运行环境，用来运行实际部署的应用。 + +|边缘节点 +|部署在边缘环境中受 KubeSphere 管理的节点。 + +|主集群 +|又称为 host 集群， host 集群管理成员集群，并提供统一的多集群中央控制平面。 + +|成员集群 +|又称为 member 集群，member 集群在多集群架构中由主集群统一管理。 + +|直接连接 +|当主集群的任意节点均可访问成员集群的 kube-apiserver 地址时可使用此方式直接连接主集群和成员集群。 + +|代理连接 +|当主集群无法直接连接成员集群时可使用代理方式连接主集群和成员集群。 + +|jwtSecret +|主集群和成员集群中用于校验用户身份的密钥。 + +|Tower +|多集群代理连接组件，包含 proxy 和 agent 两个部分，分别部署于主集群和成员集群。 + +|代理服务地址 +|使用代理连接时，成员集群上的 Tower agent 需要获取的主集群的通信服务地址。 + +|集群可⻅性 +|控制集群授权给哪些企业空间，以便企业空间可以使用所授权的集群。 +|=== + +== 应用程序和应用负载 + +[%header,cols="1a,4a"] +|=== +|术语 +|说明 + +|OpenPitrix +|一个用于打包、部署和管理不同类型应用的开源系统。 + +|应用模板 +|某个应用程序的模板，租户可使用应用模板部署新的应用程序实例。 + +|应用商店 +|应用商店包含内置应用，平台租户也可在应用商店中分享不同的应用程序。 + +|⼯作负载（Workload） +|工作负载是在 Kubesphere 上运行的应用程序，负责管理⼀个应⽤程序的一个或多个容器组。 + +|部署（Deployment） +|一种工作负载类型，⽤于管理⽆状态应⽤。一个部署运行着应用程序的几个副本，它会自动替换宕机或故障的实例。有关更多信息，请参阅link:https://kubernetes.io/zh/docs/concepts/workloads/controllers/deployment/[部署]。 + +|有状态副本集（StatefulSet） +|有状态副本集是用于管理有状态应用程序的工作负载对象，例如 MySQL。有关更多信息，请参阅link:https://kubernetes.io/zh/docs/concepts/workloads/controllers/statefulset/[有状态副本集]。 + +|守护进程集（DaemonSet） +|守护进程集管理多组容器组副本，确保 Pod 的副本在集群中的一组节点上运行。有关更多信息，请参阅link:https://kubernetes.io/zh/docs/concepts/workloads/controllers/daemonset/[守护进程集]。 + +|任务（Job） +|Job 是需要运行完成的确定性的或批量的任务，⽤于管理仅运⾏⼀次或周期性运⾏的容器组。有关更多信息，请参阅link:https://kubernetes.io/zh/docs/concepts/workloads/controllers/job/[任务]。 + +|定时任务（CronJob） +|定时任务是需要在特定的时间运行，或在指定的时间间隔内重复运行的批处理任务。有关更多信息，请参阅link:https://kubernetes.io/zh/docs/concepts/workloads/controllers/cron-jobs/[定时任务]。 + +|服务（Service） +|将运行在容器组上的应用程序公开为网络服务，提供了固定的地址（域名或 IP 地址）供客⼾端访问。有关更多信息，请参阅link:https://kubernetes.io/zh/docs/concepts/services-networking/service/[服务]。 + +|NodePort +|通过每个节点上的 IP 和静态端口（NodePort）暴露服务，可通过<节点 IP>:方式来访问服务。 + +|LoadBalancer +|使用云服务商提供的负载均衡器向外部暴露服务。 + +|应⽤路由（Ingress） +|应⽤路由⽤于对服务进⾏聚合并提供给集群外部访问。每个应⽤路由包含域名及其⼦路径到不同服务的映射规则。KubeSphere 应用路由对应 Kubernetes 中的 Ingress。 +|=== + +== 存储 + +[%header,cols="1a,4a"] +|=== +|术语 +|说明 + +|存储卷 +|一个基础资源对象，用于向容器提供存储。 + +|存储类（Storage Class） +|定义可供容器使⽤的存储卷类型。 + +|持久卷声明（Persistent Volume Claim, PVC） +|持久卷声明是用户对于存储需求的一种声明，它是命名空间里的资源，声明信息中可以指定存储大小、访问模式等。系统根据持久卷声明创建持久卷。 + +|持久卷（Persistent Volume, PV） +|根据持久卷声明中的参数，在后端存储系统中创建的可供容器使⽤的存储区域。它是通用的、可插拔的、并且不受单个 Pod 生命周期约束的持久化资源。 + +|卷快照类 +|定义可保存快照数据的⼀类卷快照。 + +|卷快照 +|卷的数据在某一个时刻的完整拷贝或镜像。可通过快照将数据完整地恢复到快照时间点。 + +|卷快照内容 +|根据卷快照中的参数，在后端存储系统中保存的快照数据。 +|=== + +== DevOps + +[%header,cols="1a,4a"] +|=== +|术语 +|说明 + +|DevOps 项目 +|DevOps 项目用于创建和管理流水线和凭证。 + +|SCM (Source Control Management) +|源控制管理，例如 GitHub 和 Gitlab。 + +|In-SCM +|通过 SCM 工具构建基于 Jenkinsfile 的流水线。 + +|Out-of-SCM +|通过图形编辑面板构建流水线，无需编写 Jenkinsfile。 + +|CI 节点 +|流水线、S2I 和 B2I 任务的专用节点。一般来说，应用程序往往需要在构建过程中拉取多个依赖项，这可能会导致如拉取时间过长、网络不稳定等问题，从而使得构建失败。为了确保流水线正常运行并加快构建速度（通过缓存），您可以配置一个或一组 CI 节点以供 CI/CD 流水线和 S2I/B2I 任务专用。 + +|B2I (Binary-to-Image) +|B2I 是一套从二进制可执行文件（例如 Jar 和 War 等）构建可再现容器镜像的工具和工作流。开发者和运维团队在项目打包成 War 和 Jar 这一类的制品后，可快速将制品或二进制的 Package 打包成 Docker 镜像，并发布到 DockerHub 或 Harbor 等镜像仓库中。 + +|S2I (Source-to-Image) +|S2I 是一套从源代码构建可再现容器镜像的工具和工作流。通过将源代码注入容器镜像，自动将编译后的代码打包成镜像。在 KubeSphere 中支持 S2I 构建镜像，也支持以创建服务的形式，一键将源代码生成镜像推送到仓库，并创建其部署和服务最终自动发布到 Kubernetes 中。 +|=== + +== 日志、事件和审计 + +[%header,cols="1a,4a"] +|=== +|术语 +|说明 + +|日志 +|日志是集群或应用程序记录的事件列表。 + +|⽇志接收器 +|收集系统的各类⽇志，包括：容器⽇志、资源事件、审计⽇志。 + +|审计策略 +|审计策略定义事件记录和所含数据的一系列规则。 + +|审计规则 +|审计规则定义如何处理审计日志。 + +|审计 Webhook +|Kubernetes 审计日志会发送至审计 Webhook。 +|=== + +== 网络 + +[%header,cols="1a,4a"] +|=== +|术语 +|说明 + +|网关（Gateway） +|为服务提供反向代理。⽹关根据应⽤路由中定义的规则将业务流量转发给不同的服务。 + +|⽹络策略 +|⽤于控制集群中容器组的访问和被访问权限。可以只允许容器组访问特定的其他容器组或⽹段；只允许容器组被特定的其他容器组或⽹段访问。 + +|容器组 IP 池 +|包含多个虚拟 IP 地址，⽤于为容器组分配虚拟 IP 地址。每个容器组 IP 池包含⼀个可在集群内部访问的私⽹ IP ⽹段。 +|=== + +== 监控、告警和通知 +[%header,cols="1a,4a"] +|=== +|术语 +|说明 + +|告警规则组 +|用于在特定监控指标满⾜预设条件和持续时间时⽣成告警。 + +|Prometheus +|负责监控存储系统的各项数据，根据告警规则向告警管理器发送告警信息。 +|=== + +== 其他 +[%header,cols="1a,4a"] +|=== +|术语 +|说明 + +|污点（Taint） +|⽤⼾在节点上创建的标记，由键、值和效果三部分组成。与容器组上创建的容忍度配合使⽤，以确保不会将 Pod 调度到不适合的节点上。 + +|容忍度（Toleration） +|容忍度表示允许将 Pod 调度到具有对应污点的节点或节点组上。由键、值和效果三部分组成。容忍度和污点共同作用可以确保不会将 Pod 调度在不适合的节点上。 + +|标签（Label） +|标签是为对象设置的可标识的键值对，通常用来管理和选择对象子集。 + +|注解（Annotation） +|注解是以键值对的形式给资源对象附加随机的无法标识的元数据。 + +|会话保持 +|将同⼀个会话中来⾃同⼀个客⼾端的请求全部转发给同⼀个容器组。 + +|保密字典（Secret） +|包含 Base64 编码的键值对，⽤于存储密码、令牌、密钥等保密数据。 + +|配置字典（ConfigMap） +|以键值对的形式存储环境变量、命令⾏参数和配置⽂件等⾮保密数据。 + +|服务账户（ServiceAccount） +|存储当前集群的访问信息，⽤于向集群内外的应⽤程序提供集群的访问权限。 + +|定制资源定义（CustomResourceDefinition） +|使⽤定制资源定义创建定制资源。通过定制化的代码给 API 服务器增加资源对象，而无需编译完整的定制 API 服务器。 +|=== + diff --git a/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-code-addNodes.adoc b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-code-addNodes.adoc new file mode 100644 index 000000000..21800471a --- /dev/null +++ b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-code-addNodes.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 6963bdcc859e4b46817de17172bb750a +// Bash +[,bash] +---- + + ./kk add nodes -f config-sample.yaml -a kubekey-artifact.tar.gz + +---- diff --git a/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-code-initializeRegistry.adoc b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-code-initializeRegistry.adoc new file mode 100644 index 000000000..0a8baa9f8 --- /dev/null +++ b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-code-initializeRegistry.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 1b45c225a03c4b1986ddda5832c75de6 +// Bash +[,bash] +---- + + ./kk init registry -f config-sample.yaml -a kubekey-artifact.tar.gz + +---- diff --git a/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-code-privateRegistry.adoc b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-code-privateRegistry.adoc new file mode 100644 index 000000000..a8f97375a --- /dev/null +++ b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-code-privateRegistry.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 0aa5c7c7c8bc4a8b8909c558f2500840 +// YAML +include::../../../_ks_components-en/code/yaml.adoc[] + + registry: + registryMirrors: [] + insecureRegistries: [] + privateRegistry: dockerhub.kubekey.local + +---- diff --git a/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-code-startUpgradeOffline.adoc b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-code-startUpgradeOffline.adoc new file mode 100644 index 000000000..50d9bd184 --- /dev/null +++ b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-code-startUpgradeOffline.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 2721978148e845f6909d22f903ee70c0 +// Bash +[,bash] +---- + + ./kk upgrade --with-kubernetes --with-kubesphere -f config-sample.yaml -a kubekey-artifact.tar.gz + +---- diff --git a/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-desc-installationSuccessOutput.adoc b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-desc-installationSuccessOutput.adoc new file mode 100644 index 000000000..653c43915 --- /dev/null +++ b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-desc-installationSuccessOutput.adoc @@ -0,0 +1,28 @@ +// :ks_include_id: b256b5b116ef4733a2be8513e5b03fd6 + + +// Bash +[,bash] +---- + +##################################################### +###              Welcome to KubeSphere!           ### +##################################################### + +Console: http://192.168.0.2:30880 +Account: admin +Password: P@88w0rd + +NOTES: + 1. After you log into the console, please check the + monitoring status of service components in + the "Cluster Management". If any service is not + ready, please wait patiently until all components + are up and running. + 2. Please change the default password after login. + +##################################################### +https://kubesphere.io             20xx-xx-xx xx:xx:xx +##################################################### + +---- diff --git a/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-note-doNotDeleteConfig_v4.adoc b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-note-doNotDeleteConfig_v4.adoc new file mode 100644 index 000000000..9fd161ebe --- /dev/null +++ b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-note-doNotDeleteConfig_v4.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: 6bfe6884350d4647a7cca1af7853a154 +// Note +include::../../../_ks_components-en/admonitions/note.adoc[] + +After {ks_product-en} is installed, please do not delete **config-sample.yaml**. This file will still be used for subsequent operations such as adding nodes. If this file is missing, you will need to recreate it. + +include::../../../_ks_components-en/admonitions/admonEnd.adoc[] diff --git a/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-note-initializeRegistry.adoc b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-note-initializeRegistry.adoc new file mode 100644 index 000000000..e5e911773 --- /dev/null +++ b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-note-initializeRegistry.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: f59af4ec0bd24d5a98d4003578c6e38d +// Note +include::../../../_ks_components-en/admonitions/note.adoc[] + +KubeKey will create a private image registry on the server specified in the **spec:roleGroups:registry** parameter in **config-sample.yaml**, with the default address set to **dockerhub.kubekey.local/kse**. + +include::../../../_ks_components-en/admonitions/admonEnd.adoc[] \ No newline at end of file diff --git a/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc new file mode 100644 index 000000000..79bd62ebb --- /dev/null +++ b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc @@ -0,0 +1,35 @@ +// :ks_include_id: 654fbac8f3b34fdfbdfb17fa841b2b0a + +. Transfer the {ks_product-en} installation package to a cluster node and log in to the cluster node. + +. Execute the following command to decompress the installation package and enter the directory generated after decompression (replace with the actual name of the installation package, and replace with the directory generated after decompression): ++ +-- +// Bash +[,bash] +---- + +tar -zxvf + +---- + +// Bash +[,bash] +---- + +cd + +---- +-- + +. Execute the following command to add execution permissions to the KubeKey binary **kk**: ++ +-- +// Bash +[,bash] +---- + +sudo chmod +x kk + +---- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc new file mode 100644 index 000000000..293dd9dac --- /dev/null +++ b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc @@ -0,0 +1,47 @@ +// :ks_include_id: e25e26f73c8441e69eef35173babd610 +. If you are accessing GitHub/Googleapis from a restricted location, please log in to any cluster node and run the following command to set the download region: ++ +-- +// Bash +[,bash] +---- + +export KKZONE=cn + +---- +-- + + +. Run the following command to download the latest version of KubeKey: ++ +-- +// Bash +[,bash] +---- + +curl -sfL https://get-kk.kubesphere.io | sh - + +---- + +After the download is complete, a KubeKey binary file **kk** will be generated in the current directory. + +// Note +include::../../../_ks_components-en/admonitions/note.adoc[] + +If the cluster node used to perform the operations cannot connect to the internet, you can manually link:https://github.com/kubesphere/kubekey/releases[download KubeKey] on a device with internet access and then transfer it to the cluster node. + +include::../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- +// end::download-kubekey[] + +. Add execute permission to the KubeKey binary file **kk**: ++ +-- +// Bash +[,bash] +---- + +sudo chmod +x kk + +---- +-- diff --git a/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-oper-editHosts_v4.adoc b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-oper-editHosts_v4.adoc new file mode 100644 index 000000000..352b878e0 --- /dev/null +++ b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-oper-editHosts_v4.adoc @@ -0,0 +1,22 @@ +// :ks_include_id: bc97a1c3d087413bba734c07a3edb221 +. Log in to all cluster nodes and execute the following command to edit the **/etc/hosts** file: ++ +-- +// Bash +[,bash] +---- + +vi /etc/hosts + +---- + +Add the following information to the **/etc/hosts** file to configure the domain resolution rules for the private image registry on the cluster nodes (replace `` with the actual IP address of the private image registry and replace the default address of the private image registry **dockerhub.kubekey.local** with your actual image registry address), and then save the file: + +// Bash +[,bash] +---- + + dockerhub.kubekey.local + +---- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-oper-transferConfig.adoc b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-oper-transferConfig.adoc new file mode 100644 index 000000000..9f47aa85f --- /dev/null +++ b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-oper-transferConfig.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 66c1533ca6e84872b4cfbedc6db42824 +. Transfer the installation configuration file **config-sample.yaml** to the current directory. \ No newline at end of file diff --git a/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-para-controlPlaneEndpoint.adoc b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-para-controlPlaneEndpoint.adoc new file mode 100644 index 000000000..a03f17ba1 --- /dev/null +++ b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-para-controlPlaneEndpoint.adoc @@ -0,0 +1,18 @@ +// :ks_include_id: d52c19a289c447d1ad5ec4114ecd814a +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|internalLoadBalancer +|Type of internal load balancer. If using local load balancer configuration, set this parameter to **haproxy**. Otherwise, you can comment out this parameter. + +|domain +|Internal access domain for the load balancer. Set this parameter to **lb.kubesphere.local**. + +|address +|IP address of the load balancer. If using local load balancer configuration, leave this parameter empty. If using a dedicated load balancer, set this parameter to the IP address of the load balancer. If using a generic server as the load balancer, set this parameter to the floating IP address of the load balancer. + +|port +|Port number that the load balancer listens on, which is the port number of the apiserver service. Set this parameter to **6443**. +|=== + diff --git a/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-para-hosts.adoc b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-para-hosts.adoc new file mode 100644 index 000000000..37acfd6ed --- /dev/null +++ b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-para-hosts.adoc @@ -0,0 +1,29 @@ +// :ks_include_id: 011f0f1d835947cbb1b37e80036c0b2e +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|name +|User-defined server name. + +|address +|The SSH login IP address of the server. + +|internalAddress +|The IP address of the server within the subnet. + +|port +|The SSH port number of the server. This parameter does not need to be set if using the default port 22. + +|user +|The SSH login user name of the server, which must be the **root** user or another user with **sudo** permissions. If you use **root** user, you can not set this parameter. + +|password +|The server's SSH login password. This parameter does not need to be set if **privateKeyPath** has been set. + +|privateKeyPath +|The path to the server's SSH login key. This parameter does not need to be set if **password** has been set. + +|arch +|The server architecture. If the server's hardware architecture is Arm64, please set this parameter to **arm64**, otherwise do not set this parameter. By default, the installation package only supports scenarios where all cluster nodes are x86_64 or arm64 architecture. If the hardware architecture of each cluster node is not exactly the same, please contact the {ks_product-en} technical support team. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-para-roleGroups.adoc b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-para-roleGroups.adoc new file mode 100644 index 000000000..68ad266a9 --- /dev/null +++ b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-para-roleGroups.adoc @@ -0,0 +1,20 @@ +// :ks_include_id: bcd276927dfd4924a47a068697e1b751 +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|etcd +|Nodes for installing the etcd database. Set the cluster control plane nodes under this parameter. + +|control-plane +|Cluster control plane nodes. If you have configured high availability for the cluster, you can set multiple control plane nodes. + +|worker +|Cluster worker nodes. + +|registry +|Server used for creating a private image registry. This server is not used as a cluster node. +ifeval::["{file_output_type}" == "html"] +During the installation or upgrade of {ks_product-en}, if the cluster nodes cannot connect to the Internet, you need to set the server used for creating a private image registry under this parameter. Otherwise, you can comment out this parameter. +endif::[] +|=== diff --git a/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-prer-backUpData.adoc b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-prer-backUpData.adoc new file mode 100644 index 000000000..abe264508 --- /dev/null +++ b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-prer-backUpData.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 50cd63fd16fa4df7a5bea0e87ac5d117 +To avoid data loss, please back up all important data in advance. \ No newline at end of file diff --git a/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-startInstallationOffline.adoc b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-startInstallationOffline.adoc new file mode 100644 index 000000000..682b9072b --- /dev/null +++ b/content/en/docs/_custom-en/installationAndUpgrade/installationAndUpgrade-startInstallationOffline.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: d864cdae8aef4d39917a96709ad7d1d4 +// Bash +[,bash] +---- + + ./kk create cluster -f config-sample.yaml -a kubekey-artifact.tar.gz + +---- diff --git a/content/en/docs/_custom-en/multi-clusterProjectManagement/apps/apps-oper-viewResourceStatus.adoc b/content/en/docs/_custom-en/multi-clusterProjectManagement/apps/apps-oper-viewResourceStatus.adoc new file mode 100644 index 000000000..2a0e1adcf --- /dev/null +++ b/content/en/docs/_custom-en/multi-clusterProjectManagement/apps/apps-oper-viewResourceStatus.adoc @@ -0,0 +1,23 @@ +// :ks_include_id: 0432dd129aa949c9b90b43831d5d0157 +. 在应用详情页面右侧的**资源状态**页签查看组成应用的服务。 ++ +-- +**服务**区域提供以下信息： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|有状态服务 +|组成该应用的有状态服务的名称。 + +|无状态服务 +|组成该应用的无状态服务的名称。 + +|内部域名 +|可通过 ..svc 格式的域名从集群内部访问服务。 + +|虚拟 IP 地址 +|服务供集群内部访问的虚拟 IP 地址。 +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/multi-clusterProjectManagement/apps/apps-para-details.adoc b/content/en/docs/_custom-en/multi-clusterProjectManagement/apps/apps-para-details.adoc new file mode 100644 index 000000000..06bd4879d --- /dev/null +++ b/content/en/docs/_custom-en/multi-clusterProjectManagement/apps/apps-para-details.adoc @@ -0,0 +1,19 @@ +// :ks_include_id: 70f19c4ccbb54fb4ad10de0f5c8a4a1e + +|项目 +|应用所属的项目。 + +|应用 +|应用的名称。 + +|版本 +|应用的版本。 + +|创建时间 +|应用的创建时间。 + +|更新时间 +|应用的更新时间。 + +|创建者 +|创建应用的用户。 diff --git a/content/en/docs/_custom-en/multi-clusterProjectManagement/configmaps/config-desc.adoc b/content/en/docs/_custom-en/multi-clusterProjectManagement/configmaps/config-desc.adoc new file mode 100644 index 000000000..dba8feef8 --- /dev/null +++ b/content/en/docs/_custom-en/multi-clusterProjectManagement/configmaps/config-desc.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: b4d12ee4d7d748a4915f6f72d47fa1d7 +本节介绍如何管理配置资源。 + +{ks_product-en}支持管理以下两类配置资源： + +* 保密字典：包含 Base64 编码的键值对，用于存储密码、令牌、密钥等保密数据。 + +* 配置字典：包含明文键值对，用于存储普通配置数据。 diff --git a/content/en/docs/_custom-en/multi-clusterProjectManagement/configmaps/configmaps-oper-viewConfigmapDetails.adoc b/content/en/docs/_custom-en/multi-clusterProjectManagement/configmaps/configmaps-oper-viewConfigmapDetails.adoc new file mode 100644 index 000000000..23c588fb7 --- /dev/null +++ b/content/en/docs/_custom-en/multi-clusterProjectManagement/configmaps/configmaps-oper-viewConfigmapDetails.adoc @@ -0,0 +1,20 @@ +// :ks_include_id: 69e70e31d4604cfaaab5683e4ecae96c +. 在配置字典详情页面左侧的**属性**区域查看配置字典的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|项目 +|配置字典所属的项目。 + +|创建时间 +|配置字典的创建时间。 + +|创建者 +|创建配置字典的用户。 +|=== +-- + +. 在配置字典右侧的**数据**页签查看配置字典中存储的键值对数据。 diff --git a/content/en/docs/_custom-en/multi-clusterProjectManagement/configmaps/configmaps-para-configmapList.adoc b/content/en/docs/_custom-en/multi-clusterProjectManagement/configmaps/configmaps-para-configmapList.adoc new file mode 100644 index 000000000..e562b7c20 --- /dev/null +++ b/content/en/docs/_custom-en/multi-clusterProjectManagement/configmaps/configmaps-para-configmapList.adoc @@ -0,0 +1,21 @@ +// :ks_include_id: 7faeedc1e81841e7a783f960b238f5f0 +* 配置字典列表提供以下信息： ++ +-- +[%header,cols="1,4"] +|=== +|参数 |描述 + +|名称 +|配置字典的名称。 + +|状态 +|配置字典当前的状态。 + +|数据 +|配置字典存储的键值对数据的键名称。不同的键通过半角逗号（,）分隔。 + +|创建时间 +|配置字典的创建时间。 +|=== +-- diff --git a/content/en/docs/_custom-en/multi-clusterProjectManagement/project-config/project-quota-para.adoc b/content/en/docs/_custom-en/multi-clusterProjectManagement/project-config/project-quota-para.adoc new file mode 100644 index 000000000..5ae518f49 --- /dev/null +++ b/content/en/docs/_custom-en/multi-clusterProjectManagement/project-config/project-quota-para.adoc @@ -0,0 +1,39 @@ +// :ks_include_id: 54a483bb55aa44d8ac2635c12c503512 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|CPU 上限 +|项目中所有容器 CPU 上限总和的最大值，单位为核。 + +|CPU 预留 +|项目中所有容器 CPU 预留总和的最大值，单位为核。 + +|内存上限 +|项目中所有容器内存上限总和的最大值，单位为 MiB。 + +|内存预留 +|项目中所有容器内存预留总和的最大值，单位为 MiB。 + +|容器组 +|项目中当前已创建的容器组数量，以及可以创建的容器组数量上限。 + +|部署 +|项目中当前已创建的部署数量，以及可以创建的部署数量上限。 + +|有状态副本集 +|项目中当前已创建的有状态副本集数量，以及可以创建的有状态副本集数量上限。 + +|卷 +|项目中当前已创建的卷数量，以及可以创建的卷数量上限。 + +|服务 +|项目中当前已创建的服务数量，以及可以创建的服务数量上限。 + +|应用路由 +|项目中当前已创建的应用路由数量，以及可以创建的应用路由数量上限。 + +|GPU 上限 +|项目中当前已使用的 GPU 数量，以及可以使用的 GPU 数量上限，单位为 GPU。 +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/multi-clusterProjectManagement/project-config/project-quota-para_v4.adoc b/content/en/docs/_custom-en/multi-clusterProjectManagement/project-config/project-quota-para_v4.adoc new file mode 100644 index 000000000..c8a4290c4 --- /dev/null +++ b/content/en/docs/_custom-en/multi-clusterProjectManagement/project-config/project-quota-para_v4.adoc @@ -0,0 +1,45 @@ +// :ks_include_id: 54a483bb55aa44d8ac2635c12c503512 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|CPU 上限 +|项目中所有容器 CPU 上限总和的最大值，单位为核。 + +// |CPU 预留 +// |项目中所有容器 CPU 预留总和的最大值，单位为核。 + +|内存上限 +|项目中所有容器内存上限总和的最大值，单位为 MiB。 + +// |内存预留 +// |项目中所有容器内存预留总和的最大值，单位为 MiB。 + +|容器组 +|项目中当前已创建的容器组数量，以及可以创建的容器组数量上限。 + +|持久卷声明限制 +|项目中当前已创建的持久卷声明容量，以及可以创建的持久卷声明的容量上限。 + +|持久卷声明 +|项目中当前已创建的持久卷声明数量，以及可以创建的持久卷声明的数量上限。 + +// |部署 +// |项目中当前已创建的部署数量，以及可以创建的部署数量上限。 + +// |有状态副本集 +// |项目中当前已创建的有状态副本集数量，以及可以创建的有状态副本集数量上限。 + +// |卷 +// |项目中当前已创建的卷数量，以及可以创建的卷数量上限。 + +// |服务 +// |项目中当前已创建的服务数量，以及可以创建的服务数量上限。 + +// |应用路由 +// |项目中当前已创建的应用路由数量，以及可以创建的应用路由数量上限。 + +// |GPU 上限 +// |项目中当前已使用的 GPU 数量，以及可以使用的 GPU 数量上限，单位为 GPU。 +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/multi-clusterProjectManagement/projectManagement-oper-openProjectPage.adoc b/content/en/docs/_custom-en/multi-clusterProjectManagement/projectManagement-oper-openProjectPage.adoc new file mode 100644 index 000000000..905f38e6c --- /dev/null +++ b/content/en/docs/_custom-en/multi-clusterProjectManagement/projectManagement-oper-openProjectPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 161aaad98ab04d7fa4240eec51d232f7 +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product-en} Web 控制台并进入您的多集群项目。 diff --git a/content/en/docs/_custom-en/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc b/content/en/docs/_custom-en/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc new file mode 100644 index 000000000..882a08e1d --- /dev/null +++ b/content/en/docs/_custom-en/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 161aaad98ab04d7fa4240eec51d232f7 +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product-en} Web 控制台并进入您的联邦项目。 diff --git a/content/en/docs/_custom-en/multi-clusterProjectManagement/projectManagement-prer-requiredPermission.adoc b/content/en/docs/_custom-en/multi-clusterProjectManagement/projectManagement-prer-requiredPermission.adoc new file mode 100644 index 000000000..b8074c487 --- /dev/null +++ b/content/en/docs/_custom-en/multi-clusterProjectManagement/projectManagement-prer-requiredPermission.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: a7b11e38d6794c2692390f9d0afbb7df +您需要加入一个多集群项目并在项目中具有pass:a,q[{ks_permission}]权限。 diff --git a/content/en/docs/_custom-en/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc b/content/en/docs/_custom-en/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc new file mode 100644 index 000000000..70cba9fe9 --- /dev/null +++ b/content/en/docs/_custom-en/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: a7b11e38d6794c2692390f9d0afbb7df +您需要加入一个联邦项目并在对应企业空间中具有pass:a,q[{ks_permission}]权限。 diff --git a/content/en/docs/_custom-en/multi-clusterProjectManagement/routes/routes-create-ClusterDiff.adoc b/content/en/docs/_custom-en/multi-clusterProjectManagement/routes/routes-create-ClusterDiff.adoc new file mode 100644 index 000000000..749f72184 --- /dev/null +++ b/content/en/docs/_custom-en/multi-clusterProjectManagement/routes/routes-create-ClusterDiff.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 479a0d3323374bee8e2220e0fdafd307 + +* 在**集群**区域，勾选项目所在的一个或多个集群，可为指定集群中的应用添加路由规则。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/multi-clusterProjectManagement/routes/routes-para-routeList.adoc b/content/en/docs/_custom-en/multi-clusterProjectManagement/routes/routes-para-routeList.adoc new file mode 100644 index 000000000..7c62b6e5a --- /dev/null +++ b/content/en/docs/_custom-en/multi-clusterProjectManagement/routes/routes-para-routeList.adoc @@ -0,0 +1,21 @@ +// :ks_include_id: d43be0d6bddf43e5aacfeed52c0fe32a +* 应用路由列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|应用路由的名称和描述。 + +|状态 +|应用路由当前的状态。 + +|应用 +|应用路由所对应的应用名称。 + +|创建时间 +|应用路由的创建时间。 +|=== +-- diff --git a/content/en/docs/_custom-en/multi-clusterProjectManagement/services/services-oper-setClusterDiff.adoc b/content/en/docs/_custom-en/multi-clusterProjectManagement/services/services-oper-setClusterDiff.adoc new file mode 100644 index 000000000..2ebea3934 --- /dev/null +++ b/content/en/docs/_custom-en/multi-clusterProjectManagement/services/services-oper-setClusterDiff.adoc @@ -0,0 +1,14 @@ +// :ks_include_id: 1c90e483af564b3eb017afec1b5da0c8 +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|容器设置 +|在不同的集群中使用不同的容器设置。在多集群环境下，您可以为指定集群中的服务设置不同的容器镜像、容器类型和资源配置等。 + +|端口设置 +|为不同集群中的容器设置不同的端口。在多集群环境下，您可以为指定集群中的服务设置不同的访问协议、容器端口和服务端口等。 + +|环境变量 +|为不同集群中的容器设置不同的环境变量。在多集群环境下，您可以为指定集群中的服务设置不同的环境变量。 +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/multi-clusterProjectManagement/services/services-oper-setStorageAdvancedDiff.adoc b/content/en/docs/_custom-en/multi-clusterProjectManagement/services/services-oper-setStorageAdvancedDiff.adoc new file mode 100644 index 000000000..85a583238 --- /dev/null +++ b/content/en/docs/_custom-en/multi-clusterProjectManagement/services/services-oper-setStorageAdvancedDiff.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 417489540caa4044871d8fba1c13e801 +. 在**存储设置**页签，为服务后端工作负载管理的容器挂载卷，然后点击**下一步**。 + +. 在**高级设置**页签，为服务后端工作负载管理的容器组指定 IP 池和节点，设置服务的外部访问模式、会话保持设置和元数据，然后点击**下一步**。 + +. 在**集群差异设置**页签，为不同集群中的服务基于容器、端口和环境变量进行差异化设置，然后点击**创建**。服务创建完成后将显示在服务列表中。 diff --git a/content/en/docs/_custom-en/multi-clusterProjectManagement/workloads/para-replicasPortsPods.adoc b/content/en/docs/_custom-en/multi-clusterProjectManagement/workloads/para-replicasPortsPods.adoc new file mode 100644 index 000000000..ee9cd1690 --- /dev/null +++ b/content/en/docs/_custom-en/multi-clusterProjectManagement/workloads/para-replicasPortsPods.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: 57816266c5504de8838e5d900bee849d +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|容器组副本数量 +|各集群中工作负载的当前容器组副本数和期望容器组副本数。 + +|端口 +|工作负载管理的容器的端口名称、协议和端口号。 + +|容器组 +| +工作负载中运行的所有容器组。展开下拉框可以选择查看特定集群中的容器组信息。 + +include::../../clusterManagement/nodes/nodes-para-podList.adoc[] +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/multi-clusterProjectManagement/workloads/workloads-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/multi-clusterProjectManagement/workloads/workloads-oper-openDetailsPage.adoc new file mode 100644 index 000000000..b890d8235 --- /dev/null +++ b/content/en/docs/_custom-en/multi-clusterProjectManagement/workloads/workloads-oper-openDetailsPage.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 1901acc4d08f4b24bff6496619ed61bc + +. 在**部署**或**有状态副本集**页签，点击目标工作负载名称，进入工作负载详情页面。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/multi-clusterProjectManagement/workloads/workloads-oper-setClusterDiff.adoc b/content/en/docs/_custom-en/multi-clusterProjectManagement/workloads/workloads-oper-setClusterDiff.adoc new file mode 100644 index 000000000..01da4247e --- /dev/null +++ b/content/en/docs/_custom-en/multi-clusterProjectManagement/workloads/workloads-oper-setClusterDiff.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: e767267c152f4de48a2d1585837e30e0 + +|容器设置 +|在不同的集群中使用不同的容器设置。在多集群环境下，您可以为指定集群中的工作负载设置不同的容器镜像、容器类型和资源配置等。 + +|端口设置 +|为不同集群中的容器设置不同的端口。在多集群环境下，您可以为指定集群中的工作负载设置不同的访问协议、容器端口和工作负载端口等。 + +|环境变量 +|为不同集群中的容器设置不同的环境变量。在多集群环境下，您可以为指定集群中的工作负载设置不同的环境变量。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/multi-clusterProjectManagement/workloads/workloads-oper-viewWorkloadDetails.adoc b/content/en/docs/_custom-en/multi-clusterProjectManagement/workloads/workloads-oper-viewWorkloadDetails.adoc new file mode 100644 index 000000000..d7dcb1126 --- /dev/null +++ b/content/en/docs/_custom-en/multi-clusterProjectManagement/workloads/workloads-oper-viewWorkloadDetails.adoc @@ -0,0 +1,65 @@ +// :ks_include_id: 53806508deb8493a8bded94825780b98 +. 在工作负载详情页面左侧的**属性**区域查看工作负载的资源属性。 ++ +-- + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|项目 +|工作负载所属的项目。 + +|应用 +|工作负载所属的应用名称。您可以创建一个包含多个服务的应用，每个服务都对应一个工作负载。 + +|创建时间 +|工作负载的创建时间。 + +|更新时间 +|工作负载的更新时间。 + +|创建者 +|创建工作负载的用户。 +|=== +-- + +. 在工作负载详情页面右侧的**资源状态**页签查看工作负载的容器组副本数量、容器端口和容器组。 ++ +-- +include::para-replicasPortsPods.adoc[] +-- + +. 在工作负载详情页面右侧点击**元数据**页签查看工作负载的标签和注解。 + +. 在工作负载详情页面右侧点击**监控**页签查看工作负载的实时资源使用情况。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|CPU 用量 +|工作负载管理的所有容器组的实时 CPU 用量。 + +|内存用量 +|工作负载管理的所有容器组的实时内存用量。 + +|出站流量 +|工作负载管理的所有容器组的出站流量。 + +|入站流量 +|工作负载管理的所有容器组的入站流量。 +|=== + +* 在**监控**右侧的第一个下拉框可以选择查看指定集群的资源监控信息。 +include::../../../../_ks_components-en/oper-selectTimeRange.adoc[] +include::../../../../_ks_components-en/oper-Autorefresh.adoc[] +include::../../../../_ks_components-en/oper-refreshData.adoc[] +-- + +. 在工作负载详情页面右侧点击**事件**页签查看工作负载相关的事件。 ++ +-- +include::../../clusterManagement/clusterManagement-para-eventsTab.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/multi-clusterProjectManagement/workloads/workloads-oper-viewWorkloadDetails_v4.adoc b/content/en/docs/_custom-en/multi-clusterProjectManagement/workloads/workloads-oper-viewWorkloadDetails_v4.adoc new file mode 100644 index 000000000..c7506e9ae --- /dev/null +++ b/content/en/docs/_custom-en/multi-clusterProjectManagement/workloads/workloads-oper-viewWorkloadDetails_v4.adoc @@ -0,0 +1,65 @@ +// :ks_include_id: 53806508deb8493a8bded94825780b98 +. 在工作负载详情页面左侧的**属性**区域查看工作负载的资源属性。 ++ +-- + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|项目 +|工作负载所属的项目。 + +|应用 +|工作负载所属的应用名称。您可以创建一个包含多个服务的应用，每个服务都对应一个工作负载。 + +|创建时间 +|工作负载的创建时间。 + +|更新时间 +|工作负载的更新时间。 + +|创建者 +|创建工作负载的用户。 +|=== +-- + +. 在工作负载详情页面右侧的**资源状态**页签查看工作负载的容器组副本数量、容器端口和容器组。 ++ +-- +include::para-replicasPortsPods.adoc[] +-- + +. 在工作负载详情页面右侧点击**元数据**页签查看工作负载的标签和注解。 + +// . 在工作负载详情页面右侧点击**监控**页签查看工作负载的实时资源使用情况。 +// + +// -- +// [%header,cols="1a,4a"] +// |=== +// |参数 |描述 + +// |CPU 用量 +// |工作负载管理的所有容器组的实时 CPU 用量。 + +// |内存用量 +// |工作负载管理的所有容器组的实时内存用量。 + +// |出站流量 +// |工作负载管理的所有容器组的出站流量。 + +// |入站流量 +// |工作负载管理的所有容器组的入站流量。 +// |=== + +// * 在**监控**右侧的第一个下拉框可以选择查看指定集群的资源监控信息。 +// include::../../../../_ks_components-en/oper-selectTimeRange.adoc[] +// include::../../../../_ks_components-en/oper-Autorefresh.adoc[] +// include::../../../../_ks_components-en/oper-refreshData.adoc[] +// -- + +. 在工作负载详情页面右侧点击**事件**页签查看工作负载相关的事件。 ++ +-- +include::../../clusterManagement/clusterManagement-para-eventsTab.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/note-separateNamesByComma.adoc b/content/en/docs/_custom-en/note-separateNamesByComma.adoc new file mode 100644 index 000000000..61d6bb471 --- /dev/null +++ b/content/en/docs/_custom-en/note-separateNamesByComma.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: bcbfd3ccebad4b3285b0a8fd9daf855d +[.admon.note,cols="a"] +|=== +|Note + +|Please separate multiple names using a comma (,) and a space. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/para-replicasPortsPods.adoc b/content/en/docs/_custom-en/para-replicasPortsPods.adoc new file mode 100644 index 000000000..0cc3632d9 --- /dev/null +++ b/content/en/docs/_custom-en/para-replicasPortsPods.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: 9dfd0319fc99473aa7930dfd36ff5321 +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Replicas +| The current and expected pod replica count of the workload. + +| Ports +| The port name, protocol, and port number of the containers managed by the workload. + +| Pods +| +All the pods running in the workload. + +include::clusterManagement/nodes/nodes-para-podList.adoc[] +|=== diff --git a/content/en/docs/_custom-en/platformManagement/accessControl/platformRoles/platformRoles-para-aliasDescription.adoc b/content/en/docs/_custom-en/platformManagement/accessControl/platformRoles/platformRoles-para-aliasDescription.adoc new file mode 100644 index 000000000..33f51365b --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/accessControl/platformRoles/platformRoles-para-aliasDescription.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: ab00e2a484af4b28883732e655a5eca8 +|Alias +|Alias of the platform role. The alias can contain Chinese characters, letters, numbers, and hyphens (-). It must not start or end with a hyphen (-) and can be up to 63 characters long. + +|Description +|Description of the platform role. The description can contain any characters and is limited to 256 characters. \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/accessControl/platformRoles/platformRoles-para-permissions.adoc b/content/en/docs/_custom-en/platformManagement/accessControl/platformRoles/platformRoles-para-permissions.adoc new file mode 100644 index 000000000..68fe9791b --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/accessControl/platformRoles/platformRoles-para-permissions.adoc @@ -0,0 +1,71 @@ +// :ks_include_id: 175d7d7252294a048ca2f385318a9c7a +具有 **platform-admin** 角色的用户可以启用和禁用扩展组件。其他平台操作所需权限如下： + +* 访问控制 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|企业空间查看 +|查看企业空间列表。 + +|企业空间管理 +|创建企业空间、编辑企业空间信息、删除企业空间。 + +|用户查看 +|查看用户列表、查看用户详情 + +|用户管理 +|创建用户、编辑用户信息、启用和禁用用户、修改用户角色、删除用户。 + +|角色查看 +|查看角色列表、查看角色详情。 + +|角色管理 +|创建平台角色、编辑平台角色信息、编辑平台角色权限、删除平台角色。 +|=== +-- + +* 集群管理 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|集群查看 +|查看集群列表。 + +|集群管理 +|添加成员集群、编辑集群信息、更新 kubeconfig、移除成员集群。 +|=== +-- + +* 应用管理 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|应用查看 +|查看应用模板列表、查看应用模板详情、查看应用审核记录。 + +|应用模板管理 +|下架和上架应用、下架和上架应用版本、管理应用分类、设置应用所属的分类、审核应用版本。 +|=== +-- + +* 平台设置管理 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|平台设置管理 +|设置邮件通知、设置飞书通知、设置钉钉通知、设置企业微信通知、设置 Slack 通知、设置 Webhook 通知。 +|=== +-- diff --git a/content/en/docs/_custom-en/platformManagement/accessControl/platformRoles/platformRoles-para-permissions_new.adoc b/content/en/docs/_custom-en/platformManagement/accessControl/platformRoles/platformRoles-para-permissions_new.adoc new file mode 100644 index 000000000..353a7f3d0 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/accessControl/platformRoles/platformRoles-para-permissions_new.adoc @@ -0,0 +1,71 @@ +// :ks_include_id: 175d7d7252294a048ca2f385318a9c7a +平台角色可配置以下权限： + +* 访问控制 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|企业空间查看 +|查看企业空间列表。 + +|企业空间管理 +|创建企业空间、编辑企业空间信息、删除企业空间。 + +|用户查看 +|查看用户列表、查看用户详情。 + +|用户管理 +|创建用户、编辑用户信息、启用和禁用用户、修改用户角色、删除用户。 + +|角色查看 +|查看角色列表、查看角色详情。 + +|角色管理 +|创建平台角色、编辑平台角色信息、编辑平台角色权限、删除平台角色。 +|=== +-- + +* 集群管理 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|集群查看 +|查看集群列表。 + +|集群管理 +|添加成员集群、编辑集群信息、更新 kubeconfig、移除成员集群。 +|=== +-- + +* 应用管理 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|应用查看 +|查看应用模板列表、查看应用模板详情、查看应用审核记录。 + +|应用模板管理 +|下架和上架应用、下架和上架应用版本、管理应用分类、设置应用所属的分类、审核应用版本。 +|=== +-- + +* 平台设置管理 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|平台设置管理 +|设置平台信息、通知等。 +|=== +-- diff --git a/content/en/docs/_custom-en/platformManagement/accessControl/users/users-oper-deleteASingleUser.adoc b/content/en/docs/_custom-en/platformManagement/accessControl/users/users-oper-deleteASingleUser.adoc new file mode 100644 index 000000000..7518d15e7 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/accessControl/users/users-oper-deleteASingleUser.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: b7e7568c806d46f3b1fe48e53ee77c27 +. 在需要删除的用户右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除用户**对话框输入用户的名称，然后点击**确定**。 diff --git a/content/en/docs/_custom-en/platformManagement/accessControl/users/users-oper-deleteMultipleUsers.adoc b/content/en/docs/_custom-en/platformManagement/accessControl/users/users-oper-deleteMultipleUsers.adoc new file mode 100644 index 000000000..e529b5998 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/accessControl/users/users-oper-deleteMultipleUsers.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 0a2acbdb2d9d421396a23302b0355ee0 +. 选择需要删除的用户左侧的复选框，然后在列表上方点击**删除**。 + +. 在**批量删除用户**对话框，输入用户的名称，然后点击**确定**。 ++ +-- +include::../../../note-separateNamesByComma.adoc[] +-- diff --git a/content/en/docs/_custom-en/platformManagement/accessControl/users/users-para-description.adoc b/content/en/docs/_custom-en/platformManagement/accessControl/users/users-para-description.adoc new file mode 100644 index 000000000..6024de1a3 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/accessControl/users/users-para-description.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 0f84e76eac814b369d9d7d787b76978f +|描述 +|用户的描述信息。描述可包含任意字符，最长 256 个字符。 diff --git a/content/en/docs/_custom-en/platformManagement/accessControl/users/users-para-email.adoc b/content/en/docs/_custom-en/platformManagement/accessControl/users/users-para-email.adoc new file mode 100644 index 000000000..d6ad1ec5d --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/accessControl/users/users-para-email.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 8045ddccddf74c4ebc4fdda0018be4f9 +|邮箱 +|用户的邮箱地址。邮箱地址可用于登录{ks_product-en} Web 控制台。 diff --git a/content/en/docs/_custom-en/platformManagement/accessControl/users/users-para-lastLogin.adoc b/content/en/docs/_custom-en/platformManagement/accessControl/users/users-para-lastLogin.adoc new file mode 100644 index 000000000..b20dace75 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/accessControl/users/users-para-lastLogin.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 094ac151a3d24a8a82e6c17d3cd06150 +|最近登录 +|用户最后一次登录{ks_product-en} Web 控制台的时间。 diff --git a/content/en/docs/_custom-en/platformManagement/accessControl/users/users-para-openDetailsPage.adoc b/content/en/docs/_custom-en/platformManagement/accessControl/users/users-para-openDetailsPage.adoc new file mode 100644 index 000000000..d92f093f6 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/accessControl/users/users-para-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 304159e85298457ea560ea7e21c39685 +. 在用户列表中点击一个用户的名称打开其详情页面。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/accessControl/users/users-para-platformRole.adoc b/content/en/docs/_custom-en/platformManagement/accessControl/users/users-para-platformRole.adoc new file mode 100644 index 000000000..cd60beac8 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/accessControl/users/users-para-platformRole.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 6d1f98cd75794e74ac21e70c3d969a7b +|平台角色 +|用户在{ks_product-en}平台的角色。平台角色将决定用户在{ks_product-en}的权限。 diff --git a/content/en/docs/_custom-en/platformManagement/accessControl/workspaces/workspaces-para-alias.adoc b/content/en/docs/_custom-en/platformManagement/accessControl/workspaces/workspaces-para-alias.adoc new file mode 100644 index 000000000..7b3f005ea --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/accessControl/workspaces/workspaces-para-alias.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: e61943aee54940b8b168df6e8670fe56 +|别名 +|企业空间的别名。不同企业空间的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 diff --git a/content/en/docs/_custom-en/platformManagement/accessControl/workspaces/workspaces-para-description.adoc b/content/en/docs/_custom-en/platformManagement/accessControl/workspaces/workspaces-para-description.adoc new file mode 100644 index 000000000..a37839fe3 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/accessControl/workspaces/workspaces-para-description.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 4b6b94bc523849ce96c16f75888e6871 +|描述 +|企业空间的描述信息。描述可包含任意字符，最长 256 个字符。 diff --git a/content/en/docs/_custom-en/platformManagement/appStoreManagement/appTemplates/appTemplates-para-templateCategories.adoc b/content/en/docs/_custom-en/platformManagement/appStoreManagement/appTemplates/appTemplates-para-templateCategories.adoc new file mode 100644 index 000000000..3af198a21 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/appStoreManagement/appTemplates/appTemplates-para-templateCategories.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 7f602e6e82414c39b2434c3a6ef39aa0 +|分类 +|应用模板所属的分类。您可以将应用模板分配到一个分类中以便于管理。有关更多信息，请参阅xref:04-platform-management/05-app-store-management/02-app-categories/_index.adoc[应用分类]。 diff --git a/content/en/docs/_custom-en/platformManagement/appStoreManagement/appTemplates/appTemplates-para-templateStatus.adoc b/content/en/docs/_custom-en/platformManagement/appStoreManagement/appTemplates/appTemplates-para-templateStatus.adoc new file mode 100644 index 000000000..5718ecc9f --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/appStoreManagement/appTemplates/appTemplates-para-templateStatus.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: 3ee13f9fe099432788220e03d24f96ce +|状态 +|应用模板当前的状态。 + +* **已发布**：应用模板中至少有一个应用版本状态已发布到应用商店。 + +* **已下架**：应用模板中的所有应用版本都已下架。 diff --git a/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-desc-waitForExtensionDisabled.adoc b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-desc-waitForExtensionDisabled.adoc new file mode 100644 index 000000000..aab31d399 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-desc-waitForExtensionDisabled.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c7f7a227d261492aa85e52060e0d8efc +扩展组件禁用过程可能需要一定时间，请等待禁用完成。 diff --git a/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-desc-waitForExtensionEnabled.adoc b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-desc-waitForExtensionEnabled.adoc new file mode 100644 index 000000000..541a522b8 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-desc-waitForExtensionEnabled.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: eccad0736cc54ecf90209d6d5e1c6530 +* 扩展组件启用过程可能需要一定时间，请等待启用完成。 diff --git a/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-deleteStatusEs.adoc b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-deleteStatusEs.adoc new file mode 100644 index 000000000..29ef497c2 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-deleteStatusEs.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: 90a37798901c4e17b3927a928d018e29 +删除以下参数： + +// YAML +include::../../../../_ks_components-en/code/yaml.adoc[] + +status: + es: + enabledTime: 2022-08-11T06:22:01UTC + status: enabled + +---- diff --git a/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-disableOberservabilityCenter.adoc b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-disableOberservabilityCenter.adoc new file mode 100644 index 000000000..e45f90669 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-disableOberservabilityCenter.adoc @@ -0,0 +1,22 @@ +// :ks_include_id: dfb36f0881804a72bed1b36dbcb98042 +. 在集群配置文件中，将 **spec:monitoring:whizard:enabled** 参数设置为 **false**，并删除 **status:alerting:status** 和 **status:monitoring:status** 参数，然后保存文件。 ++ +-- +// YAML +include::../../../../_ks_components-en/code/yaml.adoc[] + +spec: + monitoring: + whizard: + enabled: false #将 whizard:enabled 参数设置为 false + +status: + alerting: + enabledTime: XXXX-XX-XXXXX:XX:XXXXX + status: enabled #删除 alerting:status:enabled + monitoring: + enabledTime: XXXX-XX-XXXXX:XX:XXXXX + status: enabled #删除 monitoring:status:enabled + +---- +-- diff --git a/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-editCC.adoc b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-editCC.adoc new file mode 100644 index 000000000..914c9d27e --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-editCC.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: 3d4578a964454b68a55ed88860355d8e +. 在 **kubectl** 对话框，执行以下命令编辑集群配置文件： ++ +-- +// Bash +[,bash] +---- + +kubectl edit cc ks-installer -n kubesphere-system + +---- +-- diff --git a/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc new file mode 100644 index 000000000..f606426d0 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 6eca522f12cc4fac84157f8cae7f92ba +. 以具有 **platform-admin** 角色的用户登录{ks_product-en} Web 控制台。 diff --git a/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-openKubectl.adoc b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-openKubectl.adoc new file mode 100644 index 000000000..888e16777 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-openKubectl.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: db20d1bbd2ed4dc9af2b84f07b0b87e3 +. Hover over image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18] in the bottom right corner of the page, then click **kubectl** in the menu. \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-setExternalElasticsearch.adoc b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-setExternalElasticsearch.adoc new file mode 100644 index 000000000..01f352645 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-setExternalElasticsearch.adoc @@ -0,0 +1,22 @@ +// :ks_include_id: 3c4ccff9b03e44d9bc09a0d109039463 +* 如需使用外部 Elasticsearch 服务，将 **externalElasticsearchHost** 和 **externalElasticsearchPort** 参数分别设置为 Elasticsearch 服务的地址和端口号。 ++ +-- +// YAML +include::../../../../_ks_components-en/code/yaml.adoc[] + +spec: + common: + es: + externalElasticsearchHost: "" + externalElasticsearchPort: "" + +---- + +// Note +include::../../../../_ks_components-en/admonitions/note.adoc[] + +如果您不设置外部 Elasticsearch 服务的地址和端口号，{ks_product-en}将安装并使用内置 Elasticsearch 服务。 + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- diff --git a/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-setParametersInCc.adoc b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-setParametersInCc.adoc new file mode 100644 index 000000000..12131fe87 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-oper-setParametersInCc.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9cf6ccf21d414fdbb88676af3417b2fb +. 在集群配置文件中，设置以下参数，然后保存文件。 diff --git a/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-prer-platformAdmin.adoc b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-prer-platformAdmin.adoc new file mode 100644 index 000000000..c3a72c814 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/extensionManagement/extensionManagement-prer-platformAdmin.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 533e874085874479aae0d8bb598443f2 +您需要在{ks_product-en}平台具有 **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[平台角色]。 diff --git a/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusterTags/clusterTags-openListPage.adoc b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusterTags/clusterTags-openListPage.adoc new file mode 100644 index 000000000..7228c86a4 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusterTags/clusterTags-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 0531ad01f6504951b7876d7d79c0bc59 +. On the **Cluster Management** page, click the **Cluster Tags** tab to open the list of cluster tags. \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterBasicInfo.adoc b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterBasicInfo.adoc new file mode 100644 index 000000000..e61ae7a54 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterBasicInfo.adoc @@ -0,0 +1,16 @@ +// :ks_include_id: 9db9031f82114758ae483f38e21709cb +. On the **Cluster Management** page, click **Add Cluster**. + +. On the **Basic Information** tab, set the name, tags, provider, and description for the member cluster, then click **Next**. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Name +|The name of the member cluster. The name can only contain lowercase letters, numbers, and hyphens (-), must start and end with a lowercase letter or number, and can be up to 63 characters long. + +include::clusters-para-tagProviderDescription.adoc[] +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterTags.adoc b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterTags.adoc new file mode 100644 index 000000000..c795e156f --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterTags.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 8caf86e9401c464db99437a414d7b638 +. Click the image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] icon on the right side of the cluster you want to add tags, then select **Add Tags** from the dropdown list. + +. In the **Add Tags** dialog, choose the key and value for the tag, click **Add**, and then click **OK**. ++ +-- +After adding the tags, you can search for clusters by tags by clicking on the search box above the cluster list. +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToHost.adoc b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToHost.adoc new file mode 100644 index 000000000..3e87f740a --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToHost.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 7cf91b11a38f4489821f2a2d6263ba79 +. Log in to the {ks_product-en} web console of the host cluster with a user having the **platform-admin** role. \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToMember.adoc b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToMember.adoc new file mode 100644 index 000000000..4ca151591 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToMember.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 6f5ad82253e247759208da8268e3a081 +. 以具有 **platform-admin** 角色的用户登录成员集群的 Web 控制台。 diff --git a/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-setJwtsecret.adoc b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-setJwtsecret.adoc new file mode 100644 index 000000000..18fbb3b74 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-setJwtsecret.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: cdb73bd2ec05458fbc52d34a87cff019 +. 在集群配置文件中，将 **spec:authentication:jwtSecret** 参数设置为主集群的 jwtSecret 值，然后保存文件。 diff --git a/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-para-tagProviderDescription.adoc b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-para-tagProviderDescription.adoc new file mode 100644 index 000000000..9036ad8b6 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-para-tagProviderDescription.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: b4185a2af95d4c7ba1cbf681916d81a0 +|Tag +|Tags for the member cluster. Select tags from the dropdown list. + +|Provider +|The provider of the member cluster. You can select the provider from the dropdown list or enter it manually. + +|Description +|Description of the member cluster. The description can contain any characters and can be up to 256 characters long. \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-prer-enableMulticluster.adoc b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-prer-enableMulticluster.adoc new file mode 100644 index 000000000..4cb11f252 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-prer-enableMulticluster.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: e7aea6697127455bac788a878791e24e +* 主集群和成员集群都需要启用多集群管理扩展组件。有关更多信息，请参阅xref:04-platform-management/01-extension-management/13-multi-cluster-management/01-enable-multi-cluster-management.adoc[启用多集群管理]。 diff --git a/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-prer-enableMulticlusterManagement.adoc b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-prer-enableMulticlusterManagement.adoc new file mode 100644 index 000000000..78a9d60cf --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-prer-enableMulticlusterManagement.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 37c5f9735a854c9da9d6dae831f217d2 +* {ks_product-en}平台需要启用多集群管理扩展组件。有关更多信息，请参阅xref:04-platform-management/01-extension-management/13-multi-cluster-management/01-enable-multi-cluster-management.adoc[启用多集群管理]。 diff --git a/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-prer-obtainJwtsecret.adoc b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-prer-obtainJwtsecret.adoc new file mode 100644 index 000000000..b58a0faad --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-prer-obtainJwtsecret.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: 33a4ed2e95284895920ebfa744f2f2eb +. 在 **kubectl** 对话框，执行以下命令获取主集群的 jwtSecret 值。 ++ +-- +// Bash +[,bash] +---- + +kubectl -n kubesphere-system get cm kubesphere-config -o yaml | grep -v "apiVersion" | grep jwtSecret + +---- +-- diff --git a/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-prer-platformAdminHostMemeber.adoc b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-prer-platformAdminHostMemeber.adoc new file mode 100644 index 000000000..5f4d5ad46 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/multiclusterManagement/clusters/clusters-prer-platformAdminHostMemeber.adoc @@ -0,0 +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[平台角色]。 diff --git a/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-commonParameters.adoc b/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-commonParameters.adoc new file mode 100644 index 000000000..fc174978c --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-commonParameters.adoc @@ -0,0 +1,18 @@ +// :ks_include_id: e1fc48dace834fd9b24c37503267b870 +* 通用参数 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|规则名称 +|告警规则的名称。规则名称可包含任意字符，最长 63 个字符。 + +|概要 +|告警消息的内容概要。消息概要可包含任意字符，最长 63 个字符。 + +|详情 +|告警消息的详细描述。消息详情可包含任意字符，最长 256 个字符。 +|=== +-- diff --git a/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-commonParameters_new.adoc b/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-commonParameters_new.adoc new file mode 100644 index 000000000..760a77e81 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-commonParameters_new.adoc @@ -0,0 +1,23 @@ +// :ks_include_id: e1fc48dace834fd9b24c37503267b870 +* 通用参数 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|规则名称 +|告警规则的名称。规则名称可包含任意字符，最长 63 个字符。 + +|标签设置 +|为告警规则设置键值对标签，以便在通知订阅中通过标签过滤，发送标签符合特定条件的告警通知。 + +告警规则创建后，会自动生成一个键为 rule_id 的标签。 + +|概要 +|告警消息的内容概要。消息概要可包含任意字符，最长 63 个字符。 + +|详情 +|告警消息的详细描述。消息详情可包含任意字符，最长 256 个字符。 +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-duration.adoc b/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-duration.adoc new file mode 100644 index 000000000..fcf28a869 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-duration.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 3c60b62a4b7b46268fc4359057be4bbd +|持续时间 +|设置系统等待一段时间并检查告警情况是否持续存在，如果告警情况持续存在才触发告警。 diff --git a/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-ruleExpression.adoc b/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-ruleExpression.adoc new file mode 100644 index 000000000..a30ee9aa1 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-ruleExpression.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: bbc7923adc904ec2a560a3b6a8d350de +|告警规则表达式 +|用于指定监控目标和触发条件的 PromQL 表达式。有关更多信息，请参阅 link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus 官方文档]。 diff --git a/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-triggerCondition.adoc b/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-triggerCondition.adoc new file mode 100644 index 000000000..4bcb88f3c --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-triggerCondition.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 197c3cc778524087a496fa04b4eabab8 +|触发条件 +|触发告警的条件。您可以设置条件的指标、操作符、阈值、持续时间和告警的级别。例如，CPU 用量 > 80% 持续 60 分钟时触发重要告警。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/platformManagement-oper-logIn.adoc b/content/en/docs/_custom-en/platformManagement/platformManagement-oper-logIn.adoc new file mode 100644 index 000000000..a2c997ca5 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/platformManagement-oper-logIn.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 541b15e404b44af589125a703978271e +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc b/content/en/docs/_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc new file mode 100644 index 000000000..74fff162f --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc @@ -0,0 +1 @@ +You should have the pass:a,q[{ks_permission}] permission on the {ks_product-en} platform. For more information, refer to "Platform Roles". \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-filterRule.adoc b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-filterRule.adoc new file mode 100644 index 000000000..6bfc1daad --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-filterRule.adoc @@ -0,0 +1,22 @@ +// :ks_include_id: 6883b8e230774b5085de676f53fe897b +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|键 +|通知内容中的键。点击下拉列表可选择预设的键，在下拉列表中可以输入自定义的键。 + +|操作符 +|筛选条件的操作符。 + +* **包含**：键对应的值包含特定的字符串。 + +* **不包含**：键对应的值不包含特定的字符串。 + +* **存在**：通知内容中存在特定的键。 + +* **不存在**：通知内容中不存在特定的键。 + +|值 +|键对应的值必须包含的字符串。按 **Enter** 可设置多个字符串，键对应的值包含其中一个字条串即满足条件。 +|=== diff --git a/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-filterRule_new.adoc b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-filterRule_new.adoc new file mode 100644 index 000000000..5fdcf0a65 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-filterRule_new.adoc @@ -0,0 +1,24 @@ +// :ks_include_id: 6883b8e230774b5085de676f53fe897b +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|键 +|通知内容中的键。点击下拉列表可选择预设的键，在下拉列表中可以输入自定义的键。 + +|操作符 +|筛选条件的操作符。 + +* **包含**：键对应的值包含特定的字符串。 + +* **不包含**：键对应的值不包含特定的字符串。 + +* **存在**：通知内容中存在特定的键。 + +* **不存在**：通知内容中不存在特定的键。 + +* **正则匹配**：通过正则表达式来筛选符合条件的通知。 + +|值 +|键对应的值必须包含的字符串。按 **Enter** 可设置多个字符串，键对应的值包含其中一个字条串即满足条件。 +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-groupChatBotSettings.adoc b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-groupChatBotSettings.adoc new file mode 100644 index 000000000..8f27bdf50 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-groupChatBotSettings.adoc @@ -0,0 +1,18 @@ +// :ks_include_id: 9f95c83dc7754be49bf6b78b7587d110 +* 群机器人设置 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|Webhook URL +|群机器人的 Webhook URL。{ks_product-en}将向该 URL 发送通知。 + +|Secret +|群机器人的访问密钥。 + +|关键词 +|群机器人接受的关键词。点击**添加**可设置多个关键词。 +|=== +-- diff --git a/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions.adoc b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions.adoc new file mode 100644 index 000000000..607852b62 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: cd2ef9bcec6f4a9e8c517cfa2a4c539d +* 过滤条件 ++ +-- +{ks_product-en}发送的通知以键值对的形式呈现，您可以设置系统仅发送标签符合特定条件的通知。点击**添加**可设置多个条件。 + +include::notificationChannels-para-filterRule.adoc[] +-- diff --git a/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc new file mode 100644 index 000000000..f12792503 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: cd2ef9bcec6f4a9e8c517cfa2a4c539d +* 过滤条件 ++ +-- +{ks_product-en}发送的通知以键值对的形式呈现。当此处填写的**键**和**值**与规则组告警规则的标签设置中的**键**和**值**一致时，就可以通过标签过滤，发送标签符合特定条件的告警通知。点击**添加**可设置多个条件。 + +include::notificationChannels-para-filterRule_new.adoc[] +-- diff --git a/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc new file mode 100644 index 000000000..31859ac00 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: a951805f6c724c60851e752934b9e529 +* 点击**发送测试信息**以确认通知渠道工作正常。 diff --git a/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sessionId.adoc b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sessionId.adoc new file mode 100644 index 000000000..eb35585a1 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sessionId.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 4bc2cd1ba23245a3a6cfa71e436db5d5 +|会话 ID +|接收通知的会话的 User ID 或 Department ID。点击**添加**可设置多个会话 ID。 diff --git a/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-aliasDescription.adoc b/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-aliasDescription.adoc new file mode 100644 index 000000000..4d7dff49b --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-aliasDescription.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 920119fed2624b659ff20db4f8b42082 +|别名 +|静默策略的别名。不同静默策略的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|静默策略的描述信息。描述可包含任意字符，最长 256 个字符。 diff --git a/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceConditions.adoc b/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceConditions.adoc new file mode 100644 index 000000000..7915b0157 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceConditions.adoc @@ -0,0 +1,14 @@ +// :ks_include_id: 4886da3f3a094de187d396ed1236141b +* 对所有通知静默 ++ +-- +设置静默策略适用于所有通知。 +-- + +* 自定义静默条件 ++ +-- +设置静默策略仅适用于满足指定条件的通知。点击**添加**可设置通知需要满足的条件。 + +include::../notificationChannels/notificationChannels-para-filterRule.adoc[] +-- diff --git a/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceConditions_new.adoc b/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceConditions_new.adoc new file mode 100644 index 000000000..cec7cae59 --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceConditions_new.adoc @@ -0,0 +1,14 @@ +// :ks_include_id: 4886da3f3a094de187d396ed1236141b +* 对所有通知静默 ++ +-- +设置静默策略适用于所有通知。 +-- + +* 自定义静默条件 ++ +-- +设置静默策略仅适用于满足指定条件的通知。点击**添加**可设置通知需要满足的条件。 + +include::../notificationChannels/notificationChannels-para-filterRule_new.adoc[] +-- diff --git a/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceTime.adoc b/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceTime.adoc new file mode 100644 index 000000000..b9d5f335a --- /dev/null +++ b/content/en/docs/_custom-en/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceTime.adoc @@ -0,0 +1,16 @@ +// :ks_include_id: 4cae0895d3854461b646043abc44ff2b +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|持续静默 +|满足静默条件的通知在所有时间静默。 + +|在特定时间范围内静默 +|满足静默条件的通知在指定的时间范围内静默。您需要选择静默的开始时间和结束时间。 + +|周期性静默 +|满足静默条件的通知每日、每周或每月在指定的时间范围内静默。您需要选择静默的日期、开始时间和结束时间。 +|=== + +静默策略创建完成后将显示在静默策略列表中。 diff --git a/content/en/docs/_custom-en/pluggable-component-management/edit-ks-installer.adoc b/content/en/docs/_custom-en/pluggable-component-management/edit-ks-installer.adoc new file mode 100644 index 000000000..8ad274240 --- /dev/null +++ b/content/en/docs/_custom-en/pluggable-component-management/edit-ks-installer.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: bdad0846da234ee885d8445a68831c7d + +. 您需要使用具有 **platform-admin** 角色的用户（例如 **admin** 用户）登录{ks_product-en} Web 控制台，在左上角点击**平台管理 > 集群管理**。 + +. 在左侧导航栏，点击**定制资源定义**。 + +. 在 **定制资源定义**页面的搜索框中，输入 **clusterconfiguration** 并按 **Enter** 进行搜索。 + +. 点击搜索结果中的 **ClusterConfiguration** 进入其详情页面。 + +. 在**资源状态**页签上，点击 **ks-installer** 右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**编辑 YAML**。 diff --git a/content/en/docs/_custom-en/pluggable-component-management/view-component-installation-log.adoc b/content/en/docs/_custom-en/pluggable-component-management/view-component-installation-log.adoc new file mode 100644 index 000000000..4c9771f6c --- /dev/null +++ b/content/en/docs/_custom-en/pluggable-component-management/view-component-installation-log.adoc @@ -0,0 +1,13 @@ +// :ks_include_id: 869f4ffb7dfb40ab91283be53050a5f3 + +. 启用组件后，您可以将鼠标悬停至 Web 控制台右下角的image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,20,25]，点击 **kubectl**，在弹出的对话框执行以下命令来查看组件安装过程。 ++ +-- +// Bash +[,bash] +---- + +kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f + +---- +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/apps/apps-basic-para.adoc b/content/en/docs/_custom-en/projectManagement/apps/apps-basic-para.adoc new file mode 100644 index 000000000..64174b2f0 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/apps/apps-basic-para.adoc @@ -0,0 +1,18 @@ +// :ks_include_id: 8ae63028dce6415c9e3b833f410194c5 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|应用的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 + +|版本 +|用户自定义的应用版本。版本只能包含小写字母和数字，最长 16 个字符。 + +|应用治理 +|是否为应用启用应用治理功能。开启应用治理后可以对应用使用流量监控、灰度发布和链路追踪功能。 + +|描述 +|应用的描述信息。描述可包含任意字符，最长 256 个字符。 +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/apps/apps-compose-description.adoc b/content/en/docs/_custom-en/projectManagement/apps/apps-compose-description.adoc new file mode 100644 index 000000000..1049ac52c --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/apps/apps-compose-description.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 282a1d4ff17c46e19164103e677b6b0d + +您可以自定义应用的服务、工作负载和路由创建自制应用。相比基于模板的应用，自制应用支持应用治理，您可以为自制应用启用应用治理从而使用流量监控、灰度发布和链路追踪功能。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/apps/apps-oper-editAppInformation.adoc b/content/en/docs/_custom-en/projectManagement/apps/apps-oper-editAppInformation.adoc new file mode 100644 index 000000000..5f0f4a1c9 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/apps/apps-oper-editAppInformation.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: 4d2fb1de6b844f18938f0c8b6f08e279 +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the application you want to edit, then choose **Edit Information** from the dropdown list. + +. In the **Edit Information** dialog, set the alias and description for the application, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Alias +| The alias of the application. Aliases can be the same for different applications. An alias can only contain Chinese characters, letters, numbers, and hyphens (-). It cannot start or end with a hyphen (-) and has a maximum length of 63 characters. + +| Description +| The description for the application. The description can contain any characters, with a maximum length of 256 characters. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/apps/apps-oper-installApp.adoc b/content/en/docs/_custom-en/projectManagement/apps/apps-oper-installApp.adoc new file mode 100644 index 000000000..d1fddd2f9 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/apps/apps-oper-installApp.adoc @@ -0,0 +1,23 @@ +// :ks_include_id: 0a4b47588752413da3e9f8fdb60e06fa +. On the **Basic Information** tab, set the basic information of the application, then click **Next**. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Name +|User-defined name for the application. The name can only contain lowercase letters, numbers, and hyphens (-), must start with a lowercase letter and end with a lowercase letter or number, and can be up to 32 characters long. + +|Version +|Version of the application. + +|Description +|Description of the application. The description can contain any characters and is limited to 256 characters. + +|Location +|Workspace, cluster, and project to which the application belongs. +|=== +-- + +. On the **App Settings** tab, configure the functional parameters of the application as needed, then click **Install**. \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/apps/apps-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/projectManagement/apps/apps-oper-openDetailsPage.adoc new file mode 100644 index 000000000..1145646fc --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/apps/apps-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c26d258b7e114b3e8e333660dfafc3a7 +. 在**应用**页面，点击**基于模板的应用**或**自制应用**打开应用列表，然后在列表中点击一个应用的名称打开其详情页面。 diff --git a/content/en/docs/_custom-en/projectManagement/apps/apps-oper-openListPage.adoc b/content/en/docs/_custom-en/projectManagement/apps/apps-oper-openListPage.adoc new file mode 100644 index 000000000..84f27df60 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/apps/apps-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 1573d8675ac344b49d00046f3bb0b822 +. 在**应用**页面，点击**基于模板的应用**或**自制应用**打开应用列表。 diff --git a/content/en/docs/_custom-en/projectManagement/apps/apps-oper-viewResourceStatus.adoc b/content/en/docs/_custom-en/projectManagement/apps/apps-oper-viewResourceStatus.adoc new file mode 100644 index 000000000..017044296 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/apps/apps-oper-viewResourceStatus.adoc @@ -0,0 +1,69 @@ +// :ks_include_id: c4590bcc1e7e440b8eaf162491107dc0 +. 在应用详情页面左侧的**资源状态**页签查看组成应用的应用路由、服务和工作负载。 + +* **应用路由**区域提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|应用路由的名称。 + +|域名 +|应用路由的域名。 + +|URL +|应用路由所对应服务的访问地址。 +|=== + +在应用路由右侧点击**访问服务**可访问应用路由的后端服务。 +-- + +* **服务**区域提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|服务的名称。 + +|内部访问模式 +| +include::../../clusterManagement/services/services-para-internalAccess.adoc[] + +include::../../clusterManagement/services/services-para-virtualip-headless.adoc[] + +// |应用治理 +// |应用是否已启用应用治理。应用治理启用后，您可以使用{ks_product-en}提供的流量监控、灰度发布和链路追踪功能。 + +|虚拟 IP 地址 +|服务供集群内部访问的虚拟 IP 地址。仅在服务的内部访问类型为 **VirtualIP** 时显示。 +|=== +-- + +* **工作负载**区域提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|工作负载的名称。 + +|类型 +|工作负载的类型。 + +|状态 +|工作负载当前的状态。 + +include::../../clusterManagement/workloads/workloads-para-workloadStatus.adoc[] + +|修改记录 +|工作负载的当前修改记录。 +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/apps/apps-oper-viewResourceStatus_v4.adoc b/content/en/docs/_custom-en/projectManagement/apps/apps-oper-viewResourceStatus_v4.adoc new file mode 100644 index 000000000..76514c7ca --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/apps/apps-oper-viewResourceStatus_v4.adoc @@ -0,0 +1,46 @@ +// :ks_include_id: c4590bcc1e7e440b8eaf162491107dc0 +. On the **Resource Status** tab on the right side of the details page, view the services and workloads that make up the application. + +* The **Services** section provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Name +|The name of the service. + +|Project +|The project to which the service belongs. + +|Internal Access +|The virtual IP address for internal access to the service within the cluster. + +|External Access +|The port number for external access to the service from outside the cluster. +|=== +-- + +* The **Workloads** section provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Name +|The name of the workload. + +|Project +|The project to which the workload belongs. + +|Status +|The current status of the workload. + +include::../../clusterManagement/workloads/workloads-para-workloadStatus.adoc[] + +// |Revision History +// |The revision history of the workload. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/apps/apps-para-details1.adoc b/content/en/docs/_custom-en/projectManagement/apps/apps-para-details1.adoc new file mode 100644 index 000000000..1258b153d --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/apps/apps-para-details1.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 6d568952e6604999a005dfff5d21d3d3 +|集群 +|应用所属的集群。 + +|项目 +|应用所属的项目。 + +include::apps-para-status.adoc[] diff --git a/content/en/docs/_custom-en/projectManagement/apps/apps-para-details2.adoc b/content/en/docs/_custom-en/projectManagement/apps/apps-para-details2.adoc new file mode 100644 index 000000000..bb2d537b2 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/apps/apps-para-details2.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: cc2613e81ffc4baa9d26ef37bbdc0e9f +|Version +|The version of the application. + +|Creation Time +|The creation time of the application. + +|Update Time +|The update time of the application. + +|Creator +|The user who created the application. \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/apps/apps-para-status.adoc b/content/en/docs/_custom-en/projectManagement/apps/apps-para-status.adoc new file mode 100644 index 000000000..1b6a722c3 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/apps/apps-para-status.adoc @@ -0,0 +1,13 @@ +// :ks_include_id: 9db80030fef4430e98fae7a372d67f6d +|状态 +|应用当前的状态。 + +* **创建中**：系统正在创建应用。 + +* **运行中**：应用运行正常。 + +* **升级中**：系统正在升级应用版本。 + +* **删除中**：系统正在删除应用。 + +* **失败**：应用创建失败。 diff --git a/content/en/docs/_custom-en/projectManagement/apps/apps-para-status_v4.adoc b/content/en/docs/_custom-en/projectManagement/apps/apps-para-status_v4.adoc new file mode 100644 index 000000000..04c2550c5 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/apps/apps-para-status_v4.adoc @@ -0,0 +1,15 @@ +// :ks_include_id: 9db80030fef4430e98fae7a372d67f6d +|Status +|The current status of the application. + +* **Creating**: The system is currently creating the application. + +* **Created**: The application has been created but is not yet running. + +* **Running**: The application is running normally. + +* **Upgrading**: The system is upgrading the application. + +* **Deleting**: The system is deleting the application. + +* **Failed**: The application creation has failed. \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/apps/apps-types.adoc b/content/en/docs/_custom-en/projectManagement/apps/apps-types.adoc new file mode 100644 index 000000000..97946a249 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/apps/apps-types.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: faff93159cca48358390bdd176c1577d + +在{ks_product-en}平台，应用特指由一个或多个工作负载、服务、应用路由等资源组成的业务程序。根据应用的创建方式，{ks_product-en}平台上的应用分为以下两类： + +* 基于模板的应用：通过已有的应用模板创建的应用。创建应用所使用的应用模板可以为上传到企业空间的应用模板、已发布到应用商店的应用模板或第三方应用仓库中的应用模板。 + +* 自制应用：由用户手动编排工作负载、服务、应用路由等资源创建的应用。在创建自制应用时，您可以启用应用治理以使用{ks_product-en}提供的流量监控、灰度发布和链接追踪功能。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/customScaling/customScaling-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/projectManagement/customScaling/customScaling-oper-openDetailsPage.adoc new file mode 100644 index 000000000..160435081 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/customScaling/customScaling-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 826ae67a40634df8a39c61d38bcdbbee +. 在**自定义伸缩**页面，点击目标自定义伸缩任务的名称打开其详情页面。 diff --git a/content/en/docs/_custom-en/projectManagement/customScaling/customScaling-prer-enableCustomScaling.adoc b/content/en/docs/_custom-en/projectManagement/customScaling/customScaling-prer-enableCustomScaling.adoc new file mode 100644 index 000000000..d5e71796d --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/customScaling/customScaling-prer-enableCustomScaling.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c1083cc9ce1f4ea7bedb9fd1f1dd808e +* 您已经创建一个自定义伸缩任务。 diff --git a/content/en/docs/_custom-en/projectManagement/grayscaleRelease/grayscaleRelease-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/projectManagement/grayscaleRelease/grayscaleRelease-oper-openDetailsPage.adoc new file mode 100644 index 000000000..f3f40097d --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/grayscaleRelease/grayscaleRelease-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c9236cd08c5e43f9a20e107705d04a48 +. 在**灰度发布**页面，点击**发布任务**，然后点击一个灰度发布任务的名称打开其详情页面。 diff --git a/content/en/docs/_custom-en/projectManagement/grayscaleRelease/grayscaleRelease-para-strategySettings.adoc b/content/en/docs/_custom-en/projectManagement/grayscaleRelease/grayscaleRelease-para-strategySettings.adoc new file mode 100644 index 000000000..a55a348c0 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/grayscaleRelease/grayscaleRelease-para-strategySettings.adoc @@ -0,0 +1,24 @@ +// :ks_include_id: 24a43a70d2cc491b86afd4bda8e41b78 +* 对于**蓝绿部署**，在新版本或旧版本右侧点击**接管**可将业务流量全部转发给该版本。 + +* 对于**金丝雀发布**任务，您可以选择指定新旧版本的流量分配比例，或根据请求参数将请求转发给新版本或旧版本。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|指定流量分配 +|拖动滑块可设置新旧版本接收业务流量的百分比。 + +|指定请求参数 +|将参数满足特定条件的请求转发给新版本，其他请求转发给旧版本。 +|=== +-- + +// Note +include::../../../../_ks_components-en/admonitions/note.adoc[] + +流量镜像任务将业务流量的副本发送给新版本进行测试，而不实际暴露新版本，所以不需要设置业务流量转发策略。 + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] diff --git a/content/en/docs/_custom-en/projectManagement/grayscaleRelease/grayscaleRelease-para-trafficSuccessLatency.adoc b/content/en/docs/_custom-en/projectManagement/grayscaleRelease/grayscaleRelease-para-trafficSuccessLatency.adoc new file mode 100644 index 000000000..c51f818f3 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/grayscaleRelease/grayscaleRelease-para-trafficSuccessLatency.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: c831ace6bfe442abba34ed44c8c2ec4b +|流量 +|新旧版本的每秒请求数量。 + +|请求成功率 +|新旧版本的成功请求百分比。 + +|请求延迟 +|新旧版本的平均请求延迟。 diff --git a/content/en/docs/_custom-en/projectManagement/grayscaleRelease/grayscaleRelease-prer-enableApplicationGovernance.adoc b/content/en/docs/_custom-en/projectManagement/grayscaleRelease/grayscaleRelease-prer-enableApplicationGovernance.adoc new file mode 100644 index 000000000..f3cc7a2c1 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/grayscaleRelease/grayscaleRelease-prer-enableApplicationGovernance.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: d21b709ba38e40b78399826de4588ecd +ifeval::["{file_output_type}" == "html"] + +* {ks_product-en}平台需要启用应用治理扩展组件。 + +endif::[] + +ifeval::["{file_output_type}" == "pdf"] + +* {ks_product-en}平台需要启用应用治理扩展组件。有关更多信息，请参阅《{ks_product-en}平台管理指南》的“扩展组件管理”章节。 + +endif::[] diff --git a/content/en/docs/_custom-en/projectManagement/imageBuilders/imageBuilders-desc-creationComplete.adoc b/content/en/docs/_custom-en/projectManagement/imageBuilders/imageBuilders-desc-creationComplete.adoc new file mode 100644 index 000000000..37c102ba6 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/imageBuilders/imageBuilders-desc-creationComplete.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 1ea59c0e60ef40fbb5f7a7341c382f1e +镜像构建器创建完成后将显示在镜像构建器列表中。 diff --git a/content/en/docs/_custom-en/projectManagement/imageBuilders/imageBuilders-desc-imageBuilderCreated.adoc b/content/en/docs/_custom-en/projectManagement/imageBuilders/imageBuilders-desc-imageBuilderCreated.adoc new file mode 100644 index 000000000..d55ba19c0 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/imageBuilders/imageBuilders-desc-imageBuilderCreated.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: f52c5a33e96e4c138d01b50b78731090 +镜像构建器开始运行后将自动进行以下操作： diff --git a/content/en/docs/_custom-en/projectManagement/imageBuilders/imageBuilders-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/projectManagement/imageBuilders/imageBuilders-oper-openDetailsPage.adoc new file mode 100644 index 000000000..650e6e76d --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/imageBuilders/imageBuilders-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d93217c5c87e49bfa268c2f02486f7c3 +. 在镜像构建器列表中点击一个镜像构建器的名称打开其详情页面。 diff --git a/content/en/docs/_custom-en/projectManagement/imageBuilders/imageBuilders-para-creationTime.adoc b/content/en/docs/_custom-en/projectManagement/imageBuilders/imageBuilders-para-creationTime.adoc new file mode 100644 index 000000000..785d30bb5 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/imageBuilders/imageBuilders-para-creationTime.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: dc27d543d85f4d5bbcba78203ed681d4 +|创建时间 +|镜像构建器的创建时间。 diff --git a/content/en/docs/_custom-en/projectManagement/imageBuilders/imageBuilders-para-imageName.adoc b/content/en/docs/_custom-en/projectManagement/imageBuilders/imageBuilders-para-imageName.adoc new file mode 100644 index 000000000..13d2074c4 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/imageBuilders/imageBuilders-para-imageName.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 4f350e60e809473fba0431f9d5c73f71 +|名称 +|镜像构建器的名称。由系统自动生成，格式为 <镜像命名空间>**-**<镜像名称>**-**<镜像标签>**-**<随机码>。 diff --git a/content/en/docs/_custom-en/projectManagement/imageBuilders/imageBuilders-para-type.adoc b/content/en/docs/_custom-en/projectManagement/imageBuilders/imageBuilders-para-type.adoc new file mode 100644 index 000000000..883277a1b --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/imageBuilders/imageBuilders-para-type.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: fd79f6c4d3e744308f805372d06ec344 +|类型 +|镜像构建器的类型。 + +* **源码构建镜像**：使用源代码构建镜像。 + +* **制品构建镜像**：使用制品构建镜像。 diff --git a/content/en/docs/_custom-en/projectManagement/microserviceConfiguration/microserviceConfiguration-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/projectManagement/microserviceConfiguration/microserviceConfiguration-oper-openDetailsPage.adoc new file mode 100644 index 000000000..95a9ce6b2 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/microserviceConfiguration/microserviceConfiguration-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 352d6d8a19f04dbeb3551dbec55871b0 +. 在微服务配置列表中，点击一个微服务配置的名称打开其详情页面。 diff --git a/content/en/docs/_custom-en/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc b/content/en/docs/_custom-en/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc new file mode 100644 index 000000000..d4bd13671 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc @@ -0,0 +1,109 @@ +// :ks_include_id: 2da62725a68a446abf46e55566d6ae11 +以下介绍如何设置微服务网关的参数。 + +* 基本信息 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|微服务网关的名称，同时也是对应的部署的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 + +|镜像 +|用于创建微服务网关的容器镜像。例如 **registry.cn-beijing.aliyuncs.com/kse/spring-cloud-gateway:latest**。 + +|副本数量 +|微服务网关部署的容器组副本数量。 +|=== +-- + +* 资源配额 ++ +-- +设置为微服务网关每个容器的资源预留和资源上限。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|CPU 预留 +|为容器预留的 CPU 资源，单位为核。 + +|CPU 上限 +|允许容器使用的 CPU 资源上限，单位为核。 + +|内存预留 +|为容器预留的内存资源，单位为 MiB。 + +|内存上限 +|允许容器使用的内存资源上限，单位为 MiB。 +|=== +-- + +* 端口设置 ++ +-- +设置用于暴露微服务网关的服务的端口。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|协议 +|目标容器中的应用程序实际监听的协议。 + +|名称 +|服务端口的名称。 + +|容器端口 +|目标容器中的应用程序实际监听的端口号。如果使用示例容器镜像 **registry.cn-beijing.aliyuncs.com/kse/spring-cloud-gateway:latest**，请将容器端口号设置为 **8080**。 + +|服务端口 +|服务的端口号。 +|=== + +点击**添加**可设置多个服务端口。在已创建的服务端口右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除服务端口。 +-- + +* 镜像拉取策略 ++ +-- +include::../../clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] +-- + +* 健康检查 ++ +-- +include::../../clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] +-- + +* 环境变量 ++ +-- +include::../../clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] +-- + +* 启动命令 ++ +-- +include::../../clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] +-- + +* 外部访问 ++ +-- +设置是否允许从 KubeSphere 集群外部访问微服务网关。如果启用外部访问，您需要选择外部访问模式。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|NodePort +|系统将节点的端口映射到服务端口，可通过节点的 IP 地址和节点端口访问服务。 + +|LoadBalancer +|系统在 NodePort 服务的基础上为服务分配一个外部 IP 地址，并将外部 IP 地址与一个外部负载均衡器绑定。外部负载均衡器监听服务对应的节点端口，从而可以通过外部 IP 地址访问服务。为实现上述功能，LoadBalancer 类型的服务需要负载均衡器插件和基础设施环境提供支持，并且需要设置相关注解。有关更多信息，请联系您的基础设施环境提供商。 +|=== +-- diff --git a/content/en/docs/_custom-en/projectManagement/microservices/microservices-oper-openInstanceList.adoc b/content/en/docs/_custom-en/projectManagement/microservices/microservices-oper-openInstanceList.adoc new file mode 100644 index 000000000..cd9fe0f44 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/microservices/microservices-oper-openInstanceList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c7354e9057cd4477a7c4d78ff3c222dc +. 在微服务右侧点击image:/images/ks-qkcp/zh/icons/plus-square.svg[plus-square,18,18]打开微服务实例列表。 diff --git a/content/en/docs/_custom-en/projectManagement/microservices/microservices-para-instances.adoc b/content/en/docs/_custom-en/projectManagement/microservices/microservices-para-instances.adoc new file mode 100644 index 000000000..2fc7b4101 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/microservices/microservices-para-instances.adoc @@ -0,0 +1,20 @@ +// :ks_include_id: 63f2cf5af75e41deb6a5d5c45da3d5b3 +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|微服务实例的名称。 + +|权重 +|微服务实例在微服务中的权重。发送给微服务的流量将根据微服务实例的权重分配给微服务实例。 + +|IP 地址 +|微服务实例的在{ks_product-en}集群内部的访问地址。 + +|端口 +|微服务实例的访问端口号。 + +|创建时间 +|微服务实例的创建时间。 +|=== diff --git a/content/en/docs/_custom-en/projectManagement/microservices/microservices-prer-enableSpringCloud.adoc b/content/en/docs/_custom-en/projectManagement/microservices/microservices-prer-enableSpringCloud.adoc new file mode 100644 index 000000000..2731bc46f --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/microservices/microservices-prer-enableSpringCloud.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: 386a46cc0a3947d2976ae884512759d6 +ifeval::["{file_output_type}" == "html"] +* {ks_product-en}平台需要启用 Spring Cloud 扩展组件。 +endif::[] +ifeval::["{file_output_type}" == "pdf"] +* {ks_product-en}平台需要启用 Spring Cloud 扩展组件。有关更多信息，请参阅《{ks_product-en}平台管理指南》的“扩展组件管理”章节。 +endif::[] \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc b/content/en/docs/_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc new file mode 100644 index 000000000..6460c1bcb --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9b4eef92c7d44ab79e49b128781dbfde +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission, and access your project. \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/projectManagement-prer-requiredPermission.adoc b/content/en/docs/_custom-en/projectManagement/projectManagement-prer-requiredPermission.adoc new file mode 100644 index 000000000..3b5e83958 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/projectManagement-prer-requiredPermission.adoc @@ -0,0 +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[项目角色]。 diff --git a/content/en/docs/_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc b/content/en/docs/_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc new file mode 100644 index 000000000..234e5d058 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 6579f3ef4c70439ca10c8e8de94ce9fb +You should join a project and have the pass:a,q[{ks_permission}] permission within the project. For more information, refer to "Project Members" and "Project Roles". \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/projectRoles/projectRoles-desc-initialProjectAdmin.adoc b/content/en/docs/_custom-en/projectManagement/projectRoles/projectRoles-desc-initialProjectAdmin.adoc new file mode 100644 index 000000000..2e15597bb --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/projectRoles/projectRoles-desc-initialProjectAdmin.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c5751818dcc6470db19af8b18c1f1069 +The creator of a project automatically becomes the project administrator. Additionally, the **admin** user in the {ks_product-en} platform by default has all permissions in all projects. In the initial state of a project, the above users can invite other users to join the project and set their roles within the project. \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/projectRoles/projectRoles-para-aliasAndDescription.adoc b/content/en/docs/_custom-en/projectManagement/projectRoles/projectRoles-para-aliasAndDescription.adoc new file mode 100644 index 000000000..6d93645b1 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/projectRoles/projectRoles-para-aliasAndDescription.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 306f31ec34bf463a85cce5be5d58905e +| Alias +| The alias of the project role. The aliases of different project roles can be the same. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), cannot start or end with a hyphen (-), and can be up to 63 characters long. + +| Description +| The description of the project role. The description can contain any characters and is up to 256 characters long. \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/projectRoles/projectRoles-para-permissions.adoc b/content/en/docs/_custom-en/projectManagement/projectRoles/projectRoles-para-permissions.adoc new file mode 100644 index 000000000..62bfe09cd --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/projectRoles/projectRoles-para-permissions.adoc @@ -0,0 +1,150 @@ +// :ks_include_id: f730ff7f032240069f81e1b59ff72366 +* 存储 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|持久卷声明查看 +|查看持久卷声明列表、查看持久卷声明详情。 + +|持久卷声明管理 +|创建持久卷声明、克隆持久卷、创建卷快照、扩展持久卷、编辑持久卷声明信息、删除持久卷声明。 + +|卷快照查看 +|查看卷快照列表、查看卷快照详情。 + +|卷快照管理 +|创建卷快照、使用卷快照创建持久卷、删除卷快照。 +|=== +-- + +* 配置 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|服务帐户查看 +|查看服务帐户列表、查看服务帐户详情 + +|服务帐户管理 +|创建服务帐户、编辑服务帐户信息、修改服务帐户角色、删除服务帐户。 + +|保密字典查看 +|查看保密字典列表、查看保密字典详情。 + +|保密字典管理 +|创建保密字典、编辑保密字典信息、编辑保密字典设置、删除保密字典。 + +|配置字典查看 +|查看配置字典列表、查看配置字典详情。 + +|配置字典管理 +|创建配置字典、编辑配置字典信息、编辑配置字典设置、删除配置字典。 +|=== +-- + +* 访问控制 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|角色查看 +|查看项目角色列表、查看项目角色详情。 + +|角色管理 +|创建项目角色、编辑项目角色信息、编辑项目角色权限、删除项目角色。 + +|成员查看 +|查看项目成员列表。 + +|成员管理 +|邀请用户加入项目、修改项目成员角色、移除项目成员。 +|=== +-- + +* 监控告警 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|自定义监控查看 +|查看自定义监控面板。 + +|自定义监控管理 +|创建自定义监控面板、编辑自定义监控面板信息、编辑自定义监控面板、删除自定义监控面板。 + +|规则组查看 +|查看规则组列表、查看规则组详情。 + +|规则组管理 +|创建规则组、编辑规则组、删除规则组。 + +|告警查看 +|查看告警列表。 +|=== +-- + +* 应用负载 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|应用负载查看 +| +* 应用查看：查看应用列表、查看基于模板的应用详情、查看自制应用详情。 + +* 服务查看：查看服务拓扑、查看服务列表、查看服务详情。 + +* 工作负载查看：查看工作负载列表、查看工作负载详情。 + +* 任务查看：查看任务列表、查看任务详情。 + +* 应用路由查看：查看应用路由列表、查看应用路由详情、访问应用路由的后端服务。 + +* 容器组查看：查看容器组列表、查看容器组详情、查看容器详情。 + +* 灰度发布查看：查看灰度发布任务列表、查看灰度发布任务详情。 + +* 镜像构建器查看：查看镜像构建器列表、查看镜像构建器详情。 + +|应用负载管理 +| +* 应用管理：从应用模板安装应用、从应用商店安装应用、创建自制应用、删除应用。 + +* 服务管理：创建有状态或无状态服务、创建外部服务、使用源代码创建服务、使用制品创建服务、通过现有工作负载创建服务、编辑服务信息、编辑服务设置、编辑服务外部访问设置、编辑监控导出器、删除服务。 + +* 工作负载管理：创建工作负载、编辑工作负载信息、重新创建工作负载、删除工作负载、调整容器组副本数量、停止工作负载、回退工作负载设置、编辑自动扩缩设置、编辑工作负载设置。 + +* 任务管理：创建任务、编辑任务信息、删除任务、重新运行任务、暂停定时任务。 + +* 应用路由管理：创建应用路由、编辑应用路由信息、编辑路由规则、编辑应用路由注解、删除应用路由。 + +* 容器组管理：访问容器终端、删除容器组。 + +* 灰度发布管理：创建灰度发布任务、切换上线版本（蓝绿部署）、调整流量分配比例（金丝雀发布）、编辑灰度发布任务设置、删除灰度发布任务。 + +* 镜像构建器管理：使用源代码创建镜像构建器、使用制品创建镜像构建器、编辑镜像构建器信息、运行镜像构建器、删除镜像构建器。 +|=== +-- + +* 项目设置 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|项目设置管理 +|查看项目概览信息、编辑项目信息、编辑项目配额、编辑默认容器配额、删除项目。 +|=== +-- diff --git a/content/en/docs/_custom-en/projectManagement/projectRoles/projectRoles-para-permissions_new.adoc b/content/en/docs/_custom-en/projectManagement/projectRoles/projectRoles-para-permissions_new.adoc new file mode 100644 index 000000000..c9aca66a5 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/projectRoles/projectRoles-para-permissions_new.adoc @@ -0,0 +1,149 @@ +// :ks_include_id: f730ff7f032240069f81e1b59ff72366 +* 存储 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|持久卷声明管理 +|创建持久卷声明、克隆持久卷、扩展持久卷、编辑持久卷声明信息、删除持久卷声明。 + +|持久卷声明查看 +|查看持久卷声明列表、查看持久卷声明详情。 + +|=== +-- + +* 配置 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|配置字典管理 +|创建配置字典、编辑配置字典信息、编辑配置字典设置、删除配置字典。 + +|配置字典查看 +|查看配置字典列表、查看配置字典详情。 + +|保密字典管理 +|创建保密字典、编辑保密字典信息、编辑保密字典设置、删除保密字典。 + +|保密字典查看 +|查看保密字典列表、查看保密字典详情。 + +|服务帐户管理 +|创建服务帐户、编辑服务帐户信息、修改服务帐户角色、删除服务帐户。 + +|服务帐户查看 +|查看服务帐户列表、查看服务帐户详情。 + +|=== +-- + +* 应用负载 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|应用负载管理 +| +// * 应用管理：从应用模板安装应用、从应用商店安装应用、创建自制应用、删除应用。 + +* 服务管理：创建有状态或无状态服务、创建外部服务、通过现有工作负载创建服务、编辑服务信息、编辑服务设置、编辑服务外部访问设置、删除服务。 + +* 工作负载管理：创建工作负载、编辑工作负载信息、重新创建工作负载、删除工作负载、调整容器组副本数量、停止工作负载、回退工作负载设置、编辑工作负载设置。 + +* 任务管理：创建任务、编辑任务信息、删除任务、重新运行任务、暂停定时任务。 + +* 应用路由管理：创建应用路由、编辑应用路由信息、编辑路由规则、编辑应用路由注解、删除应用路由。 + +* 容器组管理：访问容器终端、删除容器组。 + +// * 灰度发布管理：创建灰度发布任务、切换上线版本（蓝绿部署）、调整流量分配比例（金丝雀发布）、编辑灰度发布任务设置、删除灰度发布任务。 + +// * 镜像构建器管理：使用源代码创建镜像构建器、使用制品创建镜像构建器、编辑镜像构建器信息、运行镜像构建器、删除镜像构建器。 + +|应用负载查看 +| +// * 应用查看：查看应用列表、查看基于模板的应用详情、查看自制应用详情。 + +* 服务查看：查看服务拓扑、查看服务列表、查看服务详情。 + +* 工作负载查看：查看工作负载列表、查看工作负载详情。 + +* 任务查看：查看任务列表、查看任务详情。 + +* 应用路由查看：查看应用路由列表、查看应用路由详情、访问应用路由的后端服务。 + +* 容器组查看：查看容器组列表、查看容器组详情、查看容器详情。 + +// * 灰度发布查看：查看灰度发布任务列表、查看灰度发布任务详情。 + +// * 镜像构建器查看：查看镜像构建器列表、查看镜像构建器详情。 + + +|=== +-- + +* 访问控制 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|角色查看 +|查看项目角色列表、查看项目角色详情。 + +// |角色管理 +// |创建项目角色、编辑项目角色信息、编辑项目角色权限、删除项目角色。 + +|成员查看 +|查看项目成员列表。 + +// |成员管理 +// |邀请用户加入项目、修改项目成员角色、移除项目成员。 +|=== +-- + +// * 监控告警 +// + +// -- +// [%header,cols="1a,4a"] +// |=== +// |权限 |允许操作 + +// |自定义监控查看 +// |查看自定义监控面板。 + +// |自定义监控管理 +// |创建自定义监控面板、编辑自定义监控面板信息、编辑自定义监控面板、删除自定义监控面板。 + +// |规则组查看 +// |查看规则组列表、查看规则组详情。 + +// |规则组管理 +// |创建规则组、编辑规则组、删除规则组。 + +// |告警查看 +// |查看告警列表。 +// |=== +// -- + + +// * 项目设置 +// + +// -- +// [%header,cols="1a,4a"] +// |=== +// |权限 |允许操作 + +// |项目设置管理 +// |查看项目概览信息、编辑项目信息、编辑项目配额、编辑默认容器配额、删除项目。 +// |=== +// -- diff --git a/content/en/docs/_custom-en/projectManagement/projectRoles/projectRoles-para-permissions_v4.adoc b/content/en/docs/_custom-en/projectManagement/projectRoles/projectRoles-para-permissions_v4.adoc new file mode 100644 index 000000000..1bb9e45e9 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/projectRoles/projectRoles-para-permissions_v4.adoc @@ -0,0 +1,87 @@ +// :ks_include_id: f730ff7f032240069f81e1b59ff72366 +* Storage ++ +-- +[%header,cols="1a,4a"] +|=== +|Permission |Operations Allowed + +|PVC Management +|Create Persistent Volume Claims, clone Persistent Volumes, expand Persistent Volumes, edit Persistent Volume Claim information, delete Persistent Volume Claims. + +|PVC Viewing +|View Persistent Volume Claim lists, view Persistent Volume Claim details. +|=== +-- + +* Configuration ++ +-- +[%header,cols="1a,4a"] +|=== +|Permission |Operations Allowed + +|ConfigMap Management +|Create ConfigMaps, edit ConfigMap information, edit ConfigMap settings, delete ConfigMaps. + +|View ConfigMaps +|View ConfigMap lists, view ConfigMap details. + +|Secret Management +|Create Secrets, edit Secret information, edit Secret settings, delete Secrets. + +|View Secrets +|View Secret lists, view Secret details. + +|Service Account Management +|Create service accounts, edit service account information, change service account roles, delete service accounts. + +|View Service Accounts +|View service account lists, view service account details. +|=== +-- + +* Application Workloads ++ +-- +[%header,cols="1a,4a"] +|=== +|Permission |Operations Allowed + +|Application Workload Management +|Manage resources such as applications, services, workloads, and jobs in the project. + +|Application Workload Viewing +|View resources such as applications, services, workloads, and jobs in the project. +|=== +-- + +* Applications ++ +-- +[%header,cols="1a,4a"] +|=== +|Permission |Operations Allowed + +|Application Instance Management +|Install applications from application templates, install applications from the App Store, delete applications. + +|View Application Instances +|View application lists, view details of template-based applications. +|=== +-- + +* Access Control ++ +-- +[%header,cols="1a,4a"] +|=== +|Permission |Operations Allowed + +|Role Viewing +|View project role lists, view project role details. + +|Member Viewing +|View project member lists. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/projectRoles/projectRoles-para-presetRoles.adoc b/content/en/docs/_custom-en/projectManagement/projectRoles/projectRoles-para-presetRoles.adoc new file mode 100644 index 000000000..7bbe21633 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/projectRoles/projectRoles-para-presetRoles.adoc @@ -0,0 +1,16 @@ +// :ks_include_id: 2b56feb1f8cc44b5b2eda05290fc26e5 +KubeSphere provides the following preset project roles: + +[%header,cols="1a,4a"] +|=== +|Role |Description + +|admin +|Project administrator with all permissions within the project. + +|operator +|Project operator with permissions excluding project settings management, role management, and member management. + +|viewer +|Project viewer with permissions to view all resources within the project. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/services/services-desc-autoCreateWorkload.adoc b/content/en/docs/_custom-en/projectManagement/services/services-desc-autoCreateWorkload.adoc new file mode 100644 index 000000000..b0ef71bd9 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-desc-autoCreateWorkload.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 090f3fcc283e40d2a5b07f8dcb4ac645 +为创建工作负载，{ks_product-en}将创建镜像构建器，并自动执行以下步骤： diff --git a/content/en/docs/_custom-en/projectManagement/services/services-desc-seeImageBuilder.adoc b/content/en/docs/_custom-en/projectManagement/services/services-desc-seeImageBuilder.adoc new file mode 100644 index 000000000..1a15211a9 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-desc-seeImageBuilder.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 6113bcafa9264e92892a1889dbfe7330 +有关镜像构建器的更多信息，请参阅xref:07-project-management/08-image-builder/_index.adoc[镜像构建器]。 diff --git a/content/en/docs/_custom-en/projectManagement/services/services-desc-setLabelsAnnotations.adoc b/content/en/docs/_custom-en/projectManagement/services/services-desc-setLabelsAnnotations.adoc new file mode 100644 index 000000000..e5911abb1 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-desc-setLabelsAnnotations.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 0dc49673473f4b0faae45bafaaf6990c +为服务后端工作负载管理的容器组指定 IP 池和节点，设置服务的外部访问模式、会话保持设置和元数据。 diff --git a/content/en/docs/_custom-en/projectManagement/services/services-desc-setServiceLabelWorkloadAnnotation.adoc b/content/en/docs/_custom-en/projectManagement/services/services-desc-setServiceLabelWorkloadAnnotation.adoc new file mode 100644 index 000000000..15cbd3e69 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-desc-setServiceLabelWorkloadAnnotation.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: b48f001ab35b4c5d86dfeb6455441fd5 +Configure labels for the service and annotations for the backend workload. \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/services/services-oper-buildImageUsingArtifact.adoc b/content/en/docs/_custom-en/projectManagement/services/services-oper-buildImageUsingArtifact.adoc new file mode 100644 index 000000000..235ae22cd --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-oper-buildImageUsingArtifact.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: bc3932ca9b3f46c8b0b79e131d2e14d9 +. 使用镜像构建器将用户上传的制品文件构建为容器镜像。 diff --git a/content/en/docs/_custom-en/projectManagement/services/services-oper-createWorkloadUsingImage.adoc b/content/en/docs/_custom-en/projectManagement/services/services-oper-createWorkloadUsingImage.adoc new file mode 100644 index 000000000..b4abdbc41 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-oper-createWorkloadUsingImage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 7a0a9a69b8634926bdef057bd7c149b6 +. 在{ks_product-en}平台拉取镜像并创建有状态副本集或部署。 diff --git a/content/en/docs/_custom-en/projectManagement/services/services-oper-pullSourceCodeAndBuildImage.adoc b/content/en/docs/_custom-en/projectManagement/services/services-oper-pullSourceCodeAndBuildImage.adoc new file mode 100644 index 000000000..9863b6735 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-oper-pullSourceCodeAndBuildImage.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 163ce46573404b5db1ad521a92036c9d +. 连接用户指定的源代码仓库并获取应用程序的源代码。 + +. 使用镜像构建器将源代码构建为容器镜像。 diff --git a/content/en/docs/_custom-en/projectManagement/services/services-oper-pushPullImage.adoc b/content/en/docs/_custom-en/projectManagement/services/services-oper-pushPullImage.adoc new file mode 100644 index 000000000..84bfcc026 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-oper-pushPullImage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 47accd090e41451b86db2d5ab8618141 +. 将容器镜像推送到用户指定的镜像服务。 diff --git a/content/en/docs/_custom-en/projectManagement/services/services-oper-setBasicInformation.adoc b/content/en/docs/_custom-en/projectManagement/services/services-oper-setBasicInformation.adoc new file mode 100644 index 000000000..d42e79542 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-oper-setBasicInformation.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: b5f9785a467642188bf3156e649b5046 +. On the **Basic Information** tab, configure the basic information for the service, and then click **Next**. \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/services/services-oper-setStorageAdvanced.adoc b/content/en/docs/_custom-en/projectManagement/services/services-oper-setStorageAdvanced.adoc new file mode 100644 index 000000000..bd0f77520 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-oper-setStorageAdvanced.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 046dfe4aa0334cd393ccf4c776cd19f2 +. On the **Storage Settings** tab, mount volumes for the containers managed by the backend workload of the service, then click **Next**. + +. On the **Advanced Settings** tab, specify IP pools and nodes for the pods managed by the backend workload of the service, set the external access mode, session persistence settings, and metadata for the service, then click **Create**. ++ +Once the service is created, it will be displayed in the list of services. \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/services/services-para-app.adoc b/content/en/docs/_custom-en/projectManagement/services/services-para-app.adoc new file mode 100644 index 000000000..099c91f97 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-para-app.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 2df70ed494ae4c76b008a5d347901192 +|应用 +|服务所属的应用。如果服务不属于任何应用，此处将显示服务的名称。 diff --git a/content/en/docs/_custom-en/projectManagement/services/services-para-artifactFile.adoc b/content/en/docs/_custom-en/projectManagement/services/services-para-artifactFile.adoc new file mode 100644 index 000000000..8f3a7d2d8 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-para-artifactFile.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: f411b3f211414f0aa7b55ad69983de5a +|制品文件 +|从本地上传用于构建镜像的制品文件。 diff --git a/content/en/docs/_custom-en/projectManagement/services/services-para-buildEnvironmentArtifact.adoc b/content/en/docs/_custom-en/projectManagement/services/services-para-buildEnvironmentArtifact.adoc new file mode 100644 index 000000000..ad3201031 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-para-buildEnvironmentArtifact.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: bb82028898a7426f82840b8d9939f2ba +|构建环境 +|容器镜像的构建环境。请根据制品文件的格式和版本选择构建环境。 diff --git a/content/en/docs/_custom-en/projectManagement/services/services-para-buildEnvironmentSourceCode.adoc b/content/en/docs/_custom-en/projectManagement/services/services-para-buildEnvironmentSourceCode.adoc new file mode 100644 index 000000000..82c72e7c6 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-para-buildEnvironmentSourceCode.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 9fd6858a23104720ad86b9b4d8e1c4b4 +|构建环境 +|容器镜像的构建环境。请根据源代码的语言和版本选择构建环境。 diff --git a/content/en/docs/_custom-en/projectManagement/services/services-para-buildSettings.adoc b/content/en/docs/_custom-en/projectManagement/services/services-para-buildSettings.adoc new file mode 100644 index 000000000..354d3ae3e --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-para-buildSettings.adoc @@ -0,0 +1,22 @@ +// :ks_include_id: 9347aaef4f854f5795c2f4a09b932a43 +|代码仓库分支 +|源代码所在的分支。 + +|代码仓库密钥 +|如果您的代码仓库需要验证，请选择包含代码仓库密钥的保密字典。 + +|镜像名称 +|构建生成的目标容器镜像名称。名称只能包含小写字母、数字、连字符（-）、句点（.）、斜钱（/）和冒号（:），并以小写字母或数字开头和结尾。 + +镜像名称应包含镜像的命名空间，例如 **my-namespace/my-image**。如果未输入命名空间，系统将自动添加命名空间 **library**，实际镜像名称为**library/my-image**。 + +|镜像标签 +|构建生成的目标容器镜像标签。 + +|目标镜像服务 +|用于存放目标镜像的镜像服务。请选择包含镜像服务信息的保密字典。 + +|触发令牌 +|客户端通过 Webhook 触发{ks_product-en}镜像构建时所使用的认证令牌。如果已设置的令牌，请求需要提供正确令牌才能触发镜像构建。令牌只能包含大写字母、小写字母和数字。 + +服务创建完成后，{ks_product-en}将创建镜像构建器并提供 URL 可用于第三方应用程序触发镜像构建。您在可以镜像构建器的详情页面获取 URL。有关更多信息，请参阅xref:07-project-management/08-image-builder/03-view-image-builder-details.adoc[查看镜像构建器详情]。 diff --git a/content/en/docs/_custom-en/projectManagement/services/services-para-codeRelativePath.adoc b/content/en/docs/_custom-en/projectManagement/services/services-para-codeRelativePath.adoc new file mode 100644 index 000000000..516c946a3 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-para-codeRelativePath.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 2ccc6559660848e48415b8d10030c5d5 +|代码相对路径 +|源代码在代码仓库中的路径。 diff --git a/content/en/docs/_custom-en/projectManagement/services/services-para-codeRepositoryURL.adoc b/content/en/docs/_custom-en/projectManagement/services/services-para-codeRepositoryURL.adoc new file mode 100644 index 000000000..e062f9723 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-para-codeRepositoryURL.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: f8c32dc78a164b579934671dbbc85d6e +|代码仓库 URL +|源代码仓库的地址。目前仅支持 Git 仓库。 diff --git a/content/en/docs/_custom-en/projectManagement/services/services-para-environmentVariablesArtifact.adoc b/content/en/docs/_custom-en/projectManagement/services/services-para-environmentVariablesArtifact.adoc new file mode 100644 index 000000000..c70cb5c00 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-para-environmentVariablesArtifact.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 28e4e6434a684669a46671184c5d9f5a +|环境变量 +|镜像运行时的环境变量，用于控制镜像运行时的行为。 + +* 有关 JAR 构建环境变量的更多信息，请访问 link:https://github.com/kubesphere/s2i-java-container/tree/master/java/images[s2i-java-container] 仓库。 + +* 有关 WAR 构建环境变量的更多信息，请参阅 link:https://github.com/kubesphere/s2i-java-container/tree/master/tomcat/images/[s2i-java-container] 仓库。 + +* 有关二进制构建环境变量的更多信息，请参阅 link:https://github.com/kubesphere/s2i-binary-container[s2i-binary-container] 仓库。 diff --git a/content/en/docs/_custom-en/projectManagement/services/services-para-environmentVariablesSourceCode.adoc b/content/en/docs/_custom-en/projectManagement/services/services-para-environmentVariablesSourceCode.adoc new file mode 100644 index 000000000..0ca62f245 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-para-environmentVariablesSourceCode.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: a4b173f44b764360bcfae8908577f515 +|环境变量 +|镜像运行时的环境变量，用于控制镜像运行时的行为。 + +* 有关 Java 构建环境变量的更多信息，请访问 link:https://github.com/kubesphere/s2i-java-container/tree/master/java/images[s2i-java-container] 仓库。 + +* 有关 Node.js 构建环境变量的更多信息，请参阅 link:https://github.com/kubesphere/s2i-nodejs-container[s2i-nodejs-container] 仓库。 + +* 有关 Python 构建环境变量的更多信息，请参阅 link:https://github.com/kubesphere/s2i-python-container[s2i-python-container] 仓库。 diff --git a/content/en/docs/_custom-en/projectManagement/services/services-para-serviceVersion.adoc b/content/en/docs/_custom-en/projectManagement/services/services-para-serviceVersion.adoc new file mode 100644 index 000000000..39e75ab4d --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-para-serviceVersion.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: bc156fd69a5d47f7a81e90f30cbf8f4a +| Version +| The version number of the service. Versions can only contain lowercase letters and numbers, with a maximum length of 16 characters. diff --git a/content/en/docs/_custom-en/projectManagement/services/services-para-setServiceInformation.adoc b/content/en/docs/_custom-en/projectManagement/services/services-para-setServiceInformation.adoc new file mode 100644 index 000000000..051763e69 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-para-setServiceInformation.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 5ca206c1516d4f62ae7cf5eba8662626 +Configure the basic information for the service. \ No newline at end of file diff --git a/content/en/docs/_custom-en/projectManagement/services/services-prer-artifact.adoc b/content/en/docs/_custom-en/projectManagement/services/services-prer-artifact.adoc new file mode 100644 index 000000000..cfc70e6b4 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-prer-artifact.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 3d4b6be852084351b5a3379d1242953f +* 您需要提前准备用于构建镜像的制品文件。{ks_product-en}默认支持 JAR、WAR 和二进制格式的制品文件。 diff --git a/content/en/docs/_custom-en/projectManagement/services/services-prer-imageRegistry.adoc b/content/en/docs/_custom-en/projectManagement/services/services-prer-imageRegistry.adoc new file mode 100644 index 000000000..bcd0d16bc --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-prer-imageRegistry.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 33ba2ea4cb7c42df8ab521495320a3a9 +* 您需要具有可用的容器镜像服务用于保存构建生成的容器镜像。有关更多信息，请参阅 link:https://docs.docker.com/registry/[Docker 官方文档]。 + +* 您需要提前在项目中创建保存镜像服务信息的保密字典。有关更多信息，请参阅xref:07-project-management/05-configuration/01-secrets/01-create-a-secret.adoc[创建保密字典]。 diff --git a/content/en/docs/_custom-en/projectManagement/services/services-prer-sourceCodeRepository.adoc b/content/en/docs/_custom-en/projectManagement/services/services-prer-sourceCodeRepository.adoc new file mode 100644 index 000000000..b120acd6d --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/services/services-prer-sourceCodeRepository.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 87f2d9d930e741ff8798083db03186e3 +* 您需要具有可用的代码仓库。{ks_product-en}默认支持 Git 仓库和 Java、Node.js 和 Python 源代码。 + +* 如果您使用私有代码仓库，您需要提前在项目中创建保存代码仓库密钥的保密字典。有关更多信息，请参阅xref:07-project-management/05-configuration/01-secrets/01-create-a-secret.adoc[创建保密字典]。 diff --git a/content/en/docs/_custom-en/projectManagement/workloads/workloads-desc-enableLogCollectionMulticlusterProject.adoc b/content/en/docs/_custom-en/projectManagement/workloads/workloads-desc-enableLogCollectionMulticlusterProject.adoc new file mode 100644 index 000000000..1700f6f03 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/workloads/workloads-desc-enableLogCollectionMulticlusterProject.adoc @@ -0,0 +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 diff --git a/content/en/docs/_custom-en/projectManagement/workloads/workloads-desc-enableLogCollectionProject.adoc b/content/en/docs/_custom-en/projectManagement/workloads/workloads-desc-enableLogCollectionProject.adoc new file mode 100644 index 000000000..494566743 --- /dev/null +++ b/content/en/docs/_custom-en/projectManagement/workloads/workloads-desc-enableLogCollectionProject.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 7318136ea443449a9e862e964a41299f +有关如何在项目中启用**收集卷上的日志**，请参阅xref:07-project-management/10-project-settings/06-log-collection/_index.adoc[日志收集]。 diff --git a/content/en/docs/_custom-en/radondb/radondb-desc-dbProductIntro.adoc b/content/en/docs/_custom-en/radondb/radondb-desc-dbProductIntro.adoc new file mode 100644 index 000000000..b04e73e5a --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondb-desc-dbProductIntro.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: ce297be1cce74ddb87c80bdb65fde7e4 +本节介绍如何管理 RadonDB {ks_db_product} 数据库应用。 + +RadonDB {ks_db_product} 是基于 {ks_db_product} 的企业级数据库产品，现已上架到{ks_product-en}应用商店。您可以在{ks_product-en} Web 控制台安装 RadonDB {ks_db_product} 应用，从而以容器化的方式部署 {ks_db_product} 数据库并通过图形界面对 {ks_db_product} 数据库进行管理。 diff --git a/content/en/docs/_custom-en/radondb/radondb-install-app.adoc b/content/en/docs/_custom-en/radondb/radondb-install-app.adoc new file mode 100644 index 000000000..8a560683c --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondb-install-app.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 6bde291a074f470ea74bb887f7ec61f2 + +. 在**应用信息**页面，点击**安装**。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/radondb/radondb-oper-clickRadondbAppsTab.adoc b/content/en/docs/_custom-en/radondb/radondb-oper-clickRadondbAppsTab.adoc new file mode 100644 index 000000000..63f384d46 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondb-oper-clickRadondbAppsTab.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: a58c1ab91f824dfea967e391137ca1dc +. 在**应用**页面点击 **RadonDB 应用**页签。 diff --git a/content/en/docs/_custom-en/radondb/radondb-oper-openDatabaseUserList.adoc b/content/en/docs/_custom-en/radondb/radondb-oper-openDatabaseUserList.adoc new file mode 100644 index 000000000..94e50d794 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondb-oper-openDatabaseUserList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c93a1471e07842fea7f1f71070066e61 +. 在页面右侧点击**数据库用户**页签打开数据库用户列表。 diff --git a/content/en/docs/_custom-en/radondb/radondb-oper-openRuleGroupDetailsPage.adoc b/content/en/docs/_custom-en/radondb/radondb-oper-openRuleGroupDetailsPage.adoc new file mode 100644 index 000000000..e499921f6 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondb-oper-openRuleGroupDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: b20ded10071a437cb7deb49f31c8ef21 +. 在规则组列表中点击一个规则组的名称打开其详情页面。 diff --git a/content/en/docs/_custom-en/radondb/radondb-oper-openRuleGroupList.adoc b/content/en/docs/_custom-en/radondb/radondb-oper-openRuleGroupList.adoc new file mode 100644 index 000000000..55acd84fa --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondb-oper-openRuleGroupList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 32accc489de14734a39cb120fccac552 +. 在页面右侧点击**告警规则组**页签打开规则组列表。 diff --git a/content/en/docs/_custom-en/radondb/radondb-prer-alerRuleGroupPermissionsManage.adoc b/content/en/docs/_custom-en/radondb/radondb-prer-alerRuleGroupPermissionsManage.adoc new file mode 100644 index 000000000..445048b85 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondb-prer-alerRuleGroupPermissionsManage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 4d279d14badb4232b6542a5da39926b1 +* 您需要在{ks_product-en} Web 控制台加入一个项目，并在项目中具有**应用负载管理**和**规则组管理**权限。 diff --git a/content/en/docs/_custom-en/radondb/radondb-prer-alerRuleGroupPermissionsView.adoc b/content/en/docs/_custom-en/radondb/radondb-prer-alerRuleGroupPermissionsView.adoc new file mode 100644 index 000000000..c6edb848a --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondb-prer-alerRuleGroupPermissionsView.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 514e3f0143bd4c10842526fa9d3ecbcc +* 您需要在{ks_product-en} Web 控制台加入一个项目，并在项目中具有**应用负载查看**和**规则组查看**权限。 diff --git a/content/en/docs/_custom-en/radondb/radondb-prer-enableDmp.adoc b/content/en/docs/_custom-en/radondb/radondb-prer-enableDmp.adoc new file mode 100644 index 000000000..6384a1f9f --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondb-prer-enableDmp.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: fbdee05fed2d4021839cb2ec9bf19339 +ifeval::["{file_output_type}" == "html"] +* {ks_product-en}平台需要启用数据库管理平台扩展组件。 +endif::[] +ifeval::["{file_output_type}" == "pdf"] +* {ks_product-en}平台需要启用数据库管理平台扩展组件。有关更多信息，请参阅《{ks_product-en}平台管理指南》的“扩展组件管理”章节。 +endif::[] diff --git a/content/en/docs/_custom-en/radondb/radondb-prer-requiredPermission.adoc b/content/en/docs/_custom-en/radondb/radondb-prer-requiredPermission.adoc new file mode 100644 index 000000000..a0f9a9d57 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondb-prer-requiredPermission.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: f369e4a204164378b95018c1b0b2483e +* 您需要在{ks_product-en} Web 控制台加入一个项目，并在项目中具有pass:a,q[{ks_permission}]权限。 diff --git a/content/en/docs/_custom-en/radondb/radondbClickhouse/radondbClickhouse-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/radondb/radondbClickhouse/radondbClickhouse-oper-openDetailsPage.adoc new file mode 100644 index 000000000..aa8fb46e6 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbClickhouse/radondbClickhouse-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: dff6e184455b4b33ae79210aba481932 +. 在 RadonDB 应用列表中，点击 RadonDB ClickHouse 应用的名称打开其详情页面。 diff --git a/content/en/docs/_custom-en/radondb/radondbClickhouse/radondbClickhouse-para-usernamePassword.adoc b/content/en/docs/_custom-en/radondb/radondbClickhouse/radondbClickhouse-para-usernamePassword.adoc new file mode 100644 index 000000000..14b3f5443 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbClickhouse/radondbClickhouse-para-usernamePassword.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: 5863aeadd640490bb8494f04252a290a +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|用户名 +|用户名只能包含大写字母、小写字母、数字和下划线（_），必须以大写或小写字母开头，长度为 2 到 26 个字符。 + +|密码 +|密码必须包含至少一个大写字母、一个小写字母、一个数字和一个特殊字符（!@#$%^&*_+-=），长度为 8 到 32 个字符。 +|=== diff --git a/content/en/docs/_custom-en/radondb/radondbClickhouse/radondbClickhouse-prer-databaseStatusRunning.adoc b/content/en/docs/_custom-en/radondb/radondbClickhouse/radondbClickhouse-prer-databaseStatusRunning.adoc new file mode 100644 index 000000000..b923eaeca --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbClickhouse/radondbClickhouse-prer-databaseStatusRunning.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 69f5611b6e834378a32660759919920f +* RadonDB ClickHouse 状态为**运行中**。 diff --git a/content/en/docs/_custom-en/radondb/radondbClickhouse/radondbClickhouse-prer-installRadondbClickHouse.adoc b/content/en/docs/_custom-en/radondb/radondbClickhouse/radondbClickhouse-prer-installRadondbClickHouse.adoc new file mode 100644 index 000000000..4a6f4570c --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbClickhouse/radondbClickhouse-prer-installRadondbClickHouse.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 898aac58171d423c9c51c2aa8c642c5e +* 您需要获取 RadonDB ClickHouse 应用授权，并已安装 RadonDB ClickHouse。有关更多信息，请参阅 xref:19-radondb/01-radondb-clickhouse/01-install-radondb-clickhouse.adoc[安装 RadonDB ClickHouse]。 diff --git a/content/en/docs/_custom-en/radondb/radondbEck/radondbEck-prer-installRadondbEck.adoc b/content/en/docs/_custom-en/radondb/radondbEck/radondbEck-prer-installRadondbEck.adoc new file mode 100644 index 000000000..b7eeeddc1 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbEck/radondbEck-prer-installRadondbEck.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 09b90b003ac64bdb80263e925944e8f3 +* 您需要获取 RadonDB ECK 应用授权，并已安装 RadonDB ECK。有关更多信息，请参阅 xref:19-radondb/07-radondb-eck/02-quickstart/01-install-radondb-eck.adoc[安装 RadonDB ECK]。 diff --git a/content/en/docs/_custom-en/radondb/radondbEck/radondbeck-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/radondb/radondbEck/radondbeck-oper-openDetailsPage.adoc new file mode 100644 index 000000000..b3b03c231 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbEck/radondbeck-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 15b3fc1df70646a9aa9dfe5ba02f8edb +. 在 RadonDB 应用列表中，点击 RadonDB ECK 应用的名称打开其详情页面。 diff --git a/content/en/docs/_custom-en/radondb/radondbEck/radondbeck-prer-createAlertGroup.adoc b/content/en/docs/_custom-en/radondb/radondbEck/radondbeck-prer-createAlertGroup.adoc new file mode 100644 index 000000000..27198ca27 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbEck/radondbeck-prer-createAlertGroup.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 19e21c1cd5ea4ba28bc287ebd9116ff1 +* 您已经创建了告警规则组。 diff --git a/content/en/docs/_custom-en/radondb/radondbEck/radondbeck-prer-databaseStatusRunning.adoc b/content/en/docs/_custom-en/radondb/radondbEck/radondbeck-prer-databaseStatusRunning.adoc new file mode 100644 index 000000000..7382f174c --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbEck/radondbeck-prer-databaseStatusRunning.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 5d06dd730e0e4a5291c9371a777d68d3 +* RadonDB ECK 状态为**运行中**。 diff --git a/content/en/docs/_custom-en/radondb/radondbKafka/radondbkafka-oper-openDatabaseUserList.adoc b/content/en/docs/_custom-en/radondb/radondbKafka/radondbkafka-oper-openDatabaseUserList.adoc new file mode 100644 index 000000000..58b2c50fb --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbKafka/radondbkafka-oper-openDatabaseUserList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d32d5776b2c941dab0287eb4a834533a +. 在页面右侧点击 **Kafka 用户**页签打开数据库用户列表。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/radondb/radondbKafka/radondbkafka-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/radondb/radondbKafka/radondbkafka-oper-openDetailsPage.adoc new file mode 100644 index 000000000..3883a6eee --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbKafka/radondbkafka-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 17b3b61a099b460fbea8886a5f6d43ca +. 在 RadonDB 应用列表中，点击 RadonDB Kafka 应用的名称打开其详情页面。 diff --git a/content/en/docs/_custom-en/radondb/radondbKafka/radondbkafka-prer-databaseStatusRunning.adoc b/content/en/docs/_custom-en/radondb/radondbKafka/radondbkafka-prer-databaseStatusRunning.adoc new file mode 100644 index 000000000..718b30f70 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbKafka/radondbkafka-prer-databaseStatusRunning.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: f8360981ea784a128e8db037604d4687 +* RadonDB Kafka 状态为**运行中**。 diff --git a/content/en/docs/_custom-en/radondb/radondbKafka/radondbkafka-prer-installRadondbkafka.adoc b/content/en/docs/_custom-en/radondb/radondbKafka/radondbkafka-prer-installRadondbkafka.adoc new file mode 100644 index 000000000..8d73e3c71 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbKafka/radondbkafka-prer-installRadondbkafka.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 6b8a73ad04964146b89763171c730adf +* 您需要获取 RadonDB Kafka 应用授权，并已安装 RadonDB Kafka。有关更多信息，请参阅 xref:19-radondb/03-radondb-kafka/02-install-radondb-kafka.adoc[安装 RadonDB Kafka]。 diff --git a/content/en/docs/_custom-en/radondb/radondbMongoDB/radondbmongodb-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/radondb/radondbMongoDB/radondbmongodb-oper-openDetailsPage.adoc new file mode 100644 index 000000000..1aa33d2be --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbMongoDB/radondbmongodb-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 17f87955f1e74216a03d3e1442183171 +. 在 RadonDB 应用列表中，点击 RadonDB MongoDB 应用的名称打开其详情页面。 diff --git a/content/en/docs/_custom-en/radondb/radondbMongoDB/radondbmongodb-prer-createAlertGroup.adoc b/content/en/docs/_custom-en/radondb/radondbMongoDB/radondbmongodb-prer-createAlertGroup.adoc new file mode 100644 index 000000000..382e5c7fd --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbMongoDB/radondbmongodb-prer-createAlertGroup.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 2dc1d3aaa26e4abd847b2ae0e8c34dde +* 您已经创建了告警规则组。 diff --git a/content/en/docs/_custom-en/radondb/radondbMongoDB/radondbmongodb-prer-databaseStatusRunning.adoc b/content/en/docs/_custom-en/radondb/radondbMongoDB/radondbmongodb-prer-databaseStatusRunning.adoc new file mode 100644 index 000000000..6dbb2caf1 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbMongoDB/radondbmongodb-prer-databaseStatusRunning.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 8713a085b4b24c45b87ef1f69629d943 +* RadonDB MongoDB 状态为**运行中**。 diff --git a/content/en/docs/_custom-en/radondb/radondbMongoDB/radondbmongodb-prer-installRadondbmongodb.adoc b/content/en/docs/_custom-en/radondb/radondbMongoDB/radondbmongodb-prer-installRadondbmongodb.adoc new file mode 100644 index 000000000..2f333bb76 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbMongoDB/radondbmongodb-prer-installRadondbmongodb.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 87a8dd123e9645bdb5fd38625088f31c +* 您需要获取 RadonDB MongoDB 应用授权，并已安装 RadonDB MongoDB。有关更多信息，请参阅 xref:19-radondb/08-radondb-mongodb/02-quickstart/01-install-radondb-mongodb.adoc[安装 RadonDB MongoDB]。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/radondb/radondbMySql/radondbmysql-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/radondb/radondbMySql/radondbmysql-oper-openDetailsPage.adoc new file mode 100644 index 000000000..e8babf535 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbMySql/radondbmysql-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 87a744239cbf45f6ab07421f14732d53 +. 在 RadonDB 应用列表中，点击 RadonDB MySQL 应用的名称打开其详情页面。 diff --git a/content/en/docs/_custom-en/radondb/radondbMySql/radondbmysql-para-usernamePassword.adoc b/content/en/docs/_custom-en/radondb/radondbMySql/radondbmysql-para-usernamePassword.adoc new file mode 100644 index 000000000..3052fb989 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbMySql/radondbmysql-para-usernamePassword.adoc @@ -0,0 +1,37 @@ +// :ks_include_id: 42c8a2c0935c4b31839f06a8bf0be613 +[%header,cols="1,5"] +|=== +|参数 |说明 + +|用户名 +a|自定义用户名称。 + +配置要求：用户名只能包含小写字母、数字和下划线（_），必须以小写字母开头，长度为 2 到 26 个字符。 + +|密码   +a|输入用户密码。 + +配置要求：只能包含大小写字母（A～Z，a～z）、数字（0～9）、特殊字符（!@#$%^&*_+-=），长度范围8～32个字符。 + +|授权数据库   +a|输入授权访问的数据库名称。 + +默认为*，表示授权全部数据库。仅支持输入一个数据库名称。 + +|用户权限   +|输入用户帐号权限。可选择普通权限或高级权限。 + +应用创建成功后，将生成默认用户 **root**。支持创建多个高级权限用户帐号和普通权限用户帐号。 + +**root** 是超级管理员用户，拥有对数据库的最高管理权限。该用户帐号默认生成，不支持修改和删除。 + +**普通权限**用户具备数据库操作使用权限，包括 ALTER、ALTER ROUTINE、CREATE、CREATE ROUTINE、CREATE TEMPORARY TABLES、CREATE VIEW、DELETE、DROP、EXECUTE、EVENT、INDEX、INSERT、LOCK TABLES、PROCESS、RELOAD、SELECT、SHOW DATABASES、SHOW VIEW、UPDATE、TRIGGER、REFERENCES 等数据库操作权限。该用户帐号可新增、修改和删除。 + +**高级权限**用户具备数据库高级操作使用权限，除普通权限外，还具备 SUPER 和 GRANT 数据库操作权限。该用户帐号可新增、修改和删除。 + +|授权主机   +a|输入允许访问的主机 IP。 + +默认为 %，表示任意主机可访问。可输入一个或多个主机 IP，以逗号（,）分隔。 + +|=== diff --git a/content/en/docs/_custom-en/radondb/radondbMySql/radondbmysql-prer-createAlertGroup.adoc b/content/en/docs/_custom-en/radondb/radondbMySql/radondbmysql-prer-createAlertGroup.adoc new file mode 100644 index 000000000..813a2d175 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbMySql/radondbmysql-prer-createAlertGroup.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: db623d4f1c0d415d97e137b978c3e158 +* 您已经创建了告警规则组。 diff --git a/content/en/docs/_custom-en/radondb/radondbMySql/radondbmysql-prer-databaseStatusRunning.adoc b/content/en/docs/_custom-en/radondb/radondbMySql/radondbmysql-prer-databaseStatusRunning.adoc new file mode 100644 index 000000000..6ffc728cb --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbMySql/radondbmysql-prer-databaseStatusRunning.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 72954448032c40cc8f0d906fc41cfbec +* RadonDB MySQL 状态为**运行中**。 diff --git a/content/en/docs/_custom-en/radondb/radondbMySql/radondbmysql-prer-installRadondbmysql.adoc b/content/en/docs/_custom-en/radondb/radondbMySql/radondbmysql-prer-installRadondbmysql.adoc new file mode 100644 index 000000000..e5c91c9e1 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbMySql/radondbmysql-prer-installRadondbmysql.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: f82032088d28459b89ab7b6dc3362625 +// :ks_include_id: +* 您需要获取 RadonDB MySQL 应用授权，并已安装 RadonDB MySQL。有关更多信息，请参阅 xref:19-radondb/02-radondb-mysql/01-install-radondb-mysql.adoc[安装 RadonDB MySQL]。 diff --git a/content/en/docs/_custom-en/radondb/radondbOpenSearch/radondbopensearch-oper-openDatabaseUserList.adoc b/content/en/docs/_custom-en/radondb/radondbOpenSearch/radondbopensearch-oper-openDatabaseUserList.adoc new file mode 100644 index 000000000..ac22d4e34 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbOpenSearch/radondbopensearch-oper-openDatabaseUserList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 7875a37b9e2b43b8b107b03bed4aa8f5 +. 在页面右侧点击 **OpenSearch 用户**页签打开数据库用户列表。 diff --git a/content/en/docs/_custom-en/radondb/radondbOpenSearch/radondbopensearch-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/radondb/radondbOpenSearch/radondbopensearch-oper-openDetailsPage.adoc new file mode 100644 index 000000000..bc22df289 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbOpenSearch/radondbopensearch-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 97bdd6d29117459f9e286142fe67d522 +. 在 RadonDB 应用列表中，点击 RadonDB OpenSearch 应用的名称打开其详情页面。 diff --git a/content/en/docs/_custom-en/radondb/radondbOpenSearch/radondbopensearch-prer-databaseStatusRunning.adoc b/content/en/docs/_custom-en/radondb/radondbOpenSearch/radondbopensearch-prer-databaseStatusRunning.adoc new file mode 100644 index 000000000..ecf8d928b --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbOpenSearch/radondbopensearch-prer-databaseStatusRunning.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 6951cd28fc784779b19c4409813b8fb0 +* RadonDB OpenSearch 状态为**运行中**。 diff --git a/content/en/docs/_custom-en/radondb/radondbOpenSearch/radondbopensearch-prer-installRadondbopensearch.adoc b/content/en/docs/_custom-en/radondb/radondbOpenSearch/radondbopensearch-prer-installRadondbopensearch.adoc new file mode 100644 index 000000000..ab64d25ed --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbOpenSearch/radondbopensearch-prer-installRadondbopensearch.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: ee04be00a8c549c9a451e93b67473d41 +* 您需要获取 RadonDB OpenSearch 应用授权，并已安装 RadonDB OpenSearch。有关更多信息，请参阅 xref:19-radondb/04-radondb-opensearch/01-install-radondb-opensearch.adoc[安装 RadonDB OpenSearch]。 diff --git a/content/en/docs/_custom-en/radondb/radondbPostgreSQL/radondbpg-para-usernamePassword.adoc b/content/en/docs/_custom-en/radondb/radondbPostgreSQL/radondbpg-para-usernamePassword.adoc new file mode 100644 index 000000000..ee819d146 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbPostgreSQL/radondbpg-para-usernamePassword.adoc @@ -0,0 +1,19 @@ +// :ks_include_id: 32e0c1e6085d4fd18bb7c2d25ef6522c +[%header,cols="1,5"] +|=== +|参数 |说明 + +|用户名 +a|自定义用户名称。 + +配置要求：用户名只能包含小写字母、数字和下划线（_），必须以小写字母开头，长度为 2 到 26 个字符。 + +|密码   +a|输入用户密码。 + +配置要求：只能包含大小写字母（A～Z，a～z）、数字（0～9）、特殊字符（!@#$%^&*_+-=），长度范围8～32个字符。 + +|用户权限   +|选择用户帐号权限。支持普通权限或高级权限。 + +|=== diff --git a/content/en/docs/_custom-en/radondb/radondbPostgreSQL/radondbpq-oper-openDatabaseUserList.adoc b/content/en/docs/_custom-en/radondb/radondbPostgreSQL/radondbpq-oper-openDatabaseUserList.adoc new file mode 100644 index 000000000..d3cd3b1d7 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbPostgreSQL/radondbpq-oper-openDatabaseUserList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 855e9c8a5ec24671aff7410cdffd8692 +. 在页面右侧点击 **OpenSearch 用户**页签打开数据库用户列表。 diff --git a/content/en/docs/_custom-en/radondb/radondbPostgreSQL/radondbpq-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/radondb/radondbPostgreSQL/radondbpq-oper-openDetailsPage.adoc new file mode 100644 index 000000000..1edff82c3 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbPostgreSQL/radondbpq-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 5213a0f3567e4087adace8424f5ab2e2 +. 在 RadonDB 应用列表中，点击 RadonDB PostgreSQL 应用的名称打开其详情页面。 diff --git a/content/en/docs/_custom-en/radondb/radondbPostgreSQL/radondpq-prer-databaseStatusRunning.adoc b/content/en/docs/_custom-en/radondb/radondbPostgreSQL/radondpq-prer-databaseStatusRunning.adoc new file mode 100644 index 000000000..1cd211ded --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbPostgreSQL/radondpq-prer-databaseStatusRunning.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 01b12b8e4ead4b4eba730d5d592a9f3f +* RadonDB PostgreSQL 状态为**运行中**。 diff --git a/content/en/docs/_custom-en/radondb/radondbPostgreSQL/radondpq-prer-installRadondbpq.adoc b/content/en/docs/_custom-en/radondb/radondbPostgreSQL/radondpq-prer-installRadondbpq.adoc new file mode 100644 index 000000000..055e8f174 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbPostgreSQL/radondpq-prer-installRadondbpq.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 2e37174ddea04c728860513b91a5da81 +* 您需要获取 RadonDB PostgreSQL 应用授权，并已安装 RadonDB PostgreSQL。有关更多信息，请参阅xref:19-radondb/09-radondb-postgresql/03-install-radondb-postgresql.adoc[安装 RadonDB PostgreSQL]。 diff --git a/content/en/docs/_custom-en/radondb/radondbRedisCluster/radondbRedisCluster-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/radondb/radondbRedisCluster/radondbRedisCluster-oper-openDetailsPage.adoc new file mode 100644 index 000000000..c9e97ca2b --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbRedisCluster/radondbRedisCluster-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 4cd4d0e0ec884581930fe2e8ae013cbe +. 在 RadonDB 应用列表中，点击 RadonDB Redis Cluster 应用的名称打开其详情页面。 diff --git a/content/en/docs/_custom-en/radondb/radondbRedisCluster/radondbRedisCluster-para-redisSettings.adoc b/content/en/docs/_custom-en/radondb/radondbRedisCluster/radondbRedisCluster-para-redisSettings.adoc new file mode 100644 index 000000000..4506ba53b --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbRedisCluster/radondbRedisCluster-para-redisSettings.adoc @@ -0,0 +1,18 @@ +// :ks_include_id: 84afac76093d447387917c71cd6369ca +|内核版本 +|Redis 数据库的内核版本。目前支持 Redis 6.2.5 和 Redis 7.0.4。 + +|资源 +|系统为 Redis 数据库预留的 CPU 和内存资源，同时也是 Redis Cluster 数据库可使用的 CPU 和内存资源上限。 + +|存储类 +|Redis 数据库使用的存储系统对应的存储类。如果下拉列表中没有符合需要的存储类，您需要联系平台管理员创建存储类。 + +|卷 +|Redis 数据库使用的卷大小，单位为 GiB。 + +|分片数量 +|Redis 数据库的代理节点数量。取值范围为 3 到 50。 + +|密码 +|Redis 数据库的访问密码。密码只能包含大写字母、小写字母、数字和特殊字符（!@#$%^&*()./;），长度为 6 到 31 个字符。 diff --git a/content/en/docs/_custom-en/radondb/radondbRedisCluster/radondbRedisCluster-prer-createAlertGroup.adoc b/content/en/docs/_custom-en/radondb/radondbRedisCluster/radondbRedisCluster-prer-createAlertGroup.adoc new file mode 100644 index 000000000..b8352b258 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbRedisCluster/radondbRedisCluster-prer-createAlertGroup.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: ccf50c036f65470881029f4b8a95cb86 +* 您已经创建了告警规则组。 diff --git a/content/en/docs/_custom-en/radondb/radondbRedisCluster/radondbRedisCluster-prer-databaseStatusRunning.adoc b/content/en/docs/_custom-en/radondb/radondbRedisCluster/radondbRedisCluster-prer-databaseStatusRunning.adoc new file mode 100644 index 000000000..125c7bd10 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbRedisCluster/radondbRedisCluster-prer-databaseStatusRunning.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 87e4912d18cb4894a1834909e7c8f1ee +* RadonDB Redis Cluster 状态为**运行中**。 diff --git a/content/en/docs/_custom-en/radondb/radondbRedisCluster/radondbRedisCluster-prer-installRadondbRedisCluster.adoc b/content/en/docs/_custom-en/radondb/radondbRedisCluster/radondbRedisCluster-prer-installRadondbRedisCluster.adoc new file mode 100644 index 000000000..b0cb9b98f --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbRedisCluster/radondbRedisCluster-prer-installRadondbRedisCluster.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 210842f52c304d298399d27d9035e49c +* 您需要获取 RadonDB Redis Cluster 应用授权，并已安装 RadonDB Redis Cluster。有关更多信息，请参阅xref:19-radondb/05-radondb-redis-cluster/02-install-radondb-redis-cluster.adoc[安装 RadonDB Redis Cluster]。 diff --git a/content/en/docs/_custom-en/radondb/radondbRedisSentinel/radondbRedisSentinel-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/radondb/radondbRedisSentinel/radondbRedisSentinel-oper-openDetailsPage.adoc new file mode 100644 index 000000000..181b8941b --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbRedisSentinel/radondbRedisSentinel-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: af7c62d166454ab193c42b8965ecfebf +. 在 RadonDB 应用列表中，点击 RadonDB Redis Sentinel 应用的名称打开其详情页面。 diff --git a/content/en/docs/_custom-en/radondb/radondbRedisSentinel/radondbRedisSentinel-para-redisSettings.adoc b/content/en/docs/_custom-en/radondb/radondbRedisSentinel/radondbRedisSentinel-para-redisSettings.adoc new file mode 100644 index 000000000..8d4f8afd2 --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbRedisSentinel/radondbRedisSentinel-para-redisSettings.adoc @@ -0,0 +1,18 @@ +// :ks_include_id: fe9e5aaafc80494881a70b45e74232e4 +|内核版本 +|Redis 数据库的内核版本。目前支持 Redis 6.2.5 和 Redis 7.0.4。 + +|资源 +|系统为 Redis 数据库预留的 CPU 和内存资源，同时也是 Redis Sentinel 数据库可使用的 CPU 和内存资源上限。 + +|存储类 +|Redis 数据库使用的存储系统对应的存储类。如果下拉列表中没有符合需要的存储类，您需要联系平台管理员创建存储类。 + +|卷 +|Redis 数据库使用的卷大小，单位为 GiB。 + +|Redis 节点数量 +|Redis 集群中的节点数量。可选值为 **3**，**5**，**7**。 + +|密码 +|Redis 数据库的访问密码。密码只能包含大写字母、小写字母、数字和特殊字符（!@#$%^&*()./;），长度为 6 到 31 个字符。 diff --git a/content/en/docs/_custom-en/radondb/radondbRedisSentinel/radondbRedisSentinel-prer-databaseStatusRunning.adoc b/content/en/docs/_custom-en/radondb/radondbRedisSentinel/radondbRedisSentinel-prer-databaseStatusRunning.adoc new file mode 100644 index 000000000..1cf153e4b --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbRedisSentinel/radondbRedisSentinel-prer-databaseStatusRunning.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 3b7e825804054abdb9a92bff016bc3b6 +* RadonDB Redis Sentinel 状态为**运行中**。 diff --git a/content/en/docs/_custom-en/radondb/radondbRedisSentinel/radondbRedisSentinel-prer-installRadondbRedisSentinel.adoc b/content/en/docs/_custom-en/radondb/radondbRedisSentinel/radondbRedisSentinel-prer-installRadondbRedisSentinel.adoc new file mode 100644 index 000000000..4f62e566b --- /dev/null +++ b/content/en/docs/_custom-en/radondb/radondbRedisSentinel/radondbRedisSentinel-prer-installRadondbRedisSentinel.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 0a2015d3292a407c98953d8a046038bf +* 您需要获取 RadonDB Redis Sentinel 应用授权，并已安装 RadonDB Redis Sentinel。有关更多信息，请参阅xref:19-radondb/06-radondb-redis-sentinel/02-install-radondb-redis-sentinel.adoc[安装 RadonDB Redis Sentinel]。 diff --git a/content/en/docs/_custom-en/radondb/ruleGroups-oper-editAlertRules.adoc b/content/en/docs/_custom-en/radondb/ruleGroups-oper-editAlertRules.adoc new file mode 100644 index 000000000..aa9fc85db --- /dev/null +++ b/content/en/docs/_custom-en/radondb/ruleGroups-oper-editAlertRules.adoc @@ -0,0 +1,15 @@ +// :ks_include_id: 5c99dc04d93846f3963e8bdf63e85667 +. 在**编辑告警规则**对话框，可以管理告警规则。 ++ +-- +* 添加告警规则：点击已有告警规则下方的**添加告警规则**创建新的告警规则。 + +* 启用/禁用告警规则：将光标悬停在已有的告警规则上，点击切换开关即可启用/禁用告警规则。 + +* 删除告警规则：将光标悬停在已有的告警规则上，点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除告警规则。 + +* 修改告警规则：将光标悬停在已有的告警规则上，点击image:/images/ks-qkcp/zh/icons/pen-light.svg[pen,18,18]可修改告警规则的设置。 + +-- +. 操作完成后，点击**确定**。 + diff --git a/content/en/docs/_custom-en/workspaceManagement/appRepositories/appRepositories-para-createAppRepository.adoc b/content/en/docs/_custom-en/workspaceManagement/appRepositories/appRepositories-para-createAppRepository.adoc new file mode 100644 index 000000000..e3d8b55d4 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appRepositories/appRepositories-para-createAppRepository.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: 9dce53f38c804429a1d874c4d0f635a3 +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|应用仓库的名称。 + +|URL +|Helm Chart 仓库的 URL。点击**验证**可测试 Helm Chart 仓库是否可用。 + +|同步周期 +|应用仓库与 Helm Chart 仓库的自动同步周期。取值范围为 3 分钟到 24 小时。默认值 **0** 表示不自动同步。 + +|描述 +|应用仓库的描述信息。描述可包含任意字符，最长 256 个字符。 +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/workspaceManagement/appRepositories/appRepositories-para-createAppRepository_v4.adoc b/content/en/docs/_custom-en/workspaceManagement/appRepositories/appRepositories-para-createAppRepository_v4.adoc new file mode 100644 index 000000000..c0ec452f3 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appRepositories/appRepositories-para-createAppRepository_v4.adoc @@ -0,0 +1,20 @@ +// :ks_include_id: 9dce53f38c804429a1d874c4d0f635a3 +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Name +|The name of the application repository. + +|Alias +|The alias of the application repository. + +|URL +|The URL of the Helm Chart repository. Click **Validate** to test if the Helm Chart repository is accessible. + +|Sync Interval +|The automatic synchronization interval between the application repository and the Helm Chart repository. Valid values range from 3 minutes to 24 hours. The default value **0** indicates no automatic synchronization. + +|Description +|The description of the application repository. The description can contain any characters, with a maximum length of 256 characters. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc new file mode 100644 index 000000000..a0d58ab32 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 6c2cd879adcb4a5fa3abaf7929167ef7 +. 在应用模板列表中点击一个应用模板的名称打开其详情页面。 diff --git a/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-oper-searchForAppTemplates.adoc b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-oper-searchForAppTemplates.adoc new file mode 100644 index 000000000..edc4da33d --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-oper-searchForAppTemplates.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 2f8bbec5d37b4c239396337ce7576a71 +* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的应用模板。 diff --git a/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-oper-viewAppInstances.adoc b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-oper-viewAppInstances.adoc new file mode 100644 index 000000000..003fc04d9 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-oper-viewAppInstances.adoc @@ -0,0 +1,25 @@ +// :ks_include_id: a04eb03cbce9496996bd54443b6e4d64 +. 在应用模板详情页面右侧点击**应用实例**页签，查看使用应用模板在{ks_product-en}平台安装的应用。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|应用的名称。 + +include::../../projectManagement/apps/apps-para-status.adoc[] + +include::appTemplates-para-version.adoc[] + +|项目 +|应用所属的项目。 + +|集群 +|应用所属的集群。 + +|创建时间 +|应用的创建时间。 +|=== +-- diff --git a/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-oper-viewAttributes.adoc b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-oper-viewAttributes.adoc new file mode 100644 index 000000000..ac2abe5ac --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-oper-viewAttributes.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 97cb07634c9f4b08ab3ebea9f440d8e8 +. 在应用模板详情页面左侧的**属性**区域，查看应用模板的资源属性。 diff --git a/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-oper-viewVersions.adoc b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-oper-viewVersions.adoc new file mode 100644 index 000000000..9869506b0 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-oper-viewVersions.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d78cb35f91534425932451fc1aeb33e2 +. 在应用模板详情页面右侧的**版本**页签，查看应用模板中包含的应用版本。 diff --git a/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-appTemplateName.adoc b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-appTemplateName.adoc new file mode 100644 index 000000000..207d95f27 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-appTemplateName.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: de8b37eae7ea4bdba3f2534f9d1b19c2 +|名称 +|应用模板的名称、图标和描述信息。 diff --git a/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-creationTime.adoc b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-creationTime.adoc new file mode 100644 index 000000000..eb0a7789f --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-creationTime.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: e53d38c7198848ea827f13da3541565e +|创建时间 +|应用模板的创建时间。 diff --git a/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-developer.adoc b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-developer.adoc new file mode 100644 index 000000000..3d20bc5cc --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-developer.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 76c5e6ca0e0d40fb8a75e2ea04ba859a +|开发者 +|上传应用版本的用户。 diff --git a/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-latestVersion.adoc b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-latestVersion.adoc new file mode 100644 index 000000000..675c5899b --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-latestVersion.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 3348c4c6bb6b473e887f8a6b5d1883c9 +|最新版本 +|应用模板中的 Helm Chart 和应用程序的最新版本。每个应用模板可包含应用的多个版本。 diff --git a/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-latestVersion_v4.adoc b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-latestVersion_v4.adoc new file mode 100644 index 000000000..0e17e7937 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-latestVersion_v4.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 3348c4c6bb6b473e887f8a6b5d1883c9 +|最新版本 +|应用模板中 Helm Chart 的最新版本。每个应用模板可包含应用的多个版本。 diff --git a/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-status.adoc b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-status.adoc new file mode 100644 index 000000000..595ec25df --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-status.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: b1063d2135a7413f839d796f93c2afa0 +|状态 +|应用模板当前的状态。 + +* **未发布**：应用模板已创建成功，但是未发布到{ks_product-en}平台的应用商店。 + +* **已发布**：应用模板已创建成功，并且已发布到{ks_product-en}平台的应用商店。 + +* **已下架**：应用模板发布到{ks_product-en}平台的应用商店后被应用商店管理员下架。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-status_v4.adoc b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-status_v4.adoc new file mode 100644 index 000000000..241f53684 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-status_v4.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: b1063d2135a7413f839d796f93c2afa0 +|状态 +|应用模板当前的状态。 + +* **未上架**：应用模板已创建成功，但是未上架到{ks_product-en}平台的应用商店。 + +* **已上架**：应用模板已创建成功，并且已上架到{ks_product-en}平台的应用商店。 + +* **已下架**：应用模板上架到{ks_product-en}平台的应用商店后被应用商店管理员下架。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-type.adoc b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-type.adoc new file mode 100644 index 000000000..80ed6a573 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-type.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 933bd63e86ea4c958e7578f625e38dca +|类型 +|应用模板的类型。 diff --git a/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-version.adoc b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-version.adoc new file mode 100644 index 000000000..91a01157f --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-version.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 942eb298f1394bef9c3269ba02cc1311 +|版本 +|Helm Chart 的版本。 diff --git a/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-versionUpdateTime.adoc b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-versionUpdateTime.adoc new file mode 100644 index 000000000..f26de34c0 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-versionUpdateTime.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 3c207e89fc77423187d81dd47480e0b4 +|更新时间 +|应用版本的更新时间。 diff --git a/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-viewAppInformation.adoc b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-viewAppInformation.adoc new file mode 100644 index 000000000..fdfc3111d --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-viewAppInformation.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 869781900cdb48f19e54811ea9a8abcc +. 在应用模板详情页面右侧点击**应用信息**页签，查看应用模板的介绍、截图和版本信息。 diff --git a/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-viewAppReviewRecords.adoc b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-viewAppReviewRecords.adoc new file mode 100644 index 000000000..6a06b7097 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-viewAppReviewRecords.adoc @@ -0,0 +1,24 @@ +// :ks_include_id: 6bd43a37515948a98375ba0850fee61a +. 在应用模板详情页面右侧点击**应用审核**页签，查看应用版本的审核记录。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|时间 +|应用审核记录的生成时间。 + +|状态 +|应用审核记录对应的应用版本状态。 + +|版本 +|生成审核记录对应的 Helm Chat 和应用程序的版本。 + +|拒绝原因 +|应用版本提交审核后，应用商店管理员拒绝版本发布的原因。仅在应用版本被应用商店管理员拒绝时显示。 + +|操作者 +|操作应用版本的用户。 +|=== +-- diff --git a/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-workspace.adoc b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-workspace.adoc new file mode 100644 index 000000000..d96ff2783 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-para-workspace.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: d2cbf65cb5824a99bf21c210999ce5a7 +|企业空间 +|提交应用模板的企业空间。 diff --git a/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-prer-enableAppManagment.adoc b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-prer-enableAppManagment.adoc new file mode 100644 index 000000000..2fb11efc1 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/appTemplates/appTemplates-prer-enableAppManagment.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: ee9b0f0546704ae1bfc9104d3fa7f5e5 +ifeval::["{file_output_type}" == "html"] + +* {ks_product-en}平台需要启用应用管理扩展组件。 + +endif::[] + +ifeval::["{file_output_type}" == "pdf"] + +* {ks_product-en}平台需要启用应用管理扩展组件。有关更多信息，请参阅《{ks_product-en}平台管理指南》的“扩展组件管理”章节。 + +endif::[] diff --git a/content/en/docs/_custom-en/workspaceManagement/devopsProjects/devopsProject-para-aliasAndDescription.adoc b/content/en/docs/_custom-en/workspaceManagement/devopsProjects/devopsProject-para-aliasAndDescription.adoc new file mode 100644 index 000000000..a808db2bb --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/devopsProjects/devopsProject-para-aliasAndDescription.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 41158ab30242438694d2437566046d38 +|别名 +|DevOps 项目的别名。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|DevOps 项目的描述信息。描述可包含任意字符，最长 256 个字符。 \ No newline at end of file diff --git a/content/en/docs/_custom-en/workspaceManagement/devopsProjects/devopsProject-prer-enableDevops.adoc b/content/en/docs/_custom-en/workspaceManagement/devopsProjects/devopsProject-prer-enableDevops.adoc new file mode 100644 index 000000000..cd59003d1 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/devopsProjects/devopsProject-prer-enableDevops.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: f7fb88afed0545c4b9cefe39062aa225 +ifeval::["{file_output_type}" == "html"] + +* {ks_product-en}平台需要启用 DevOps 扩展组件。 + +endif::[] + +ifeval::["{file_output_type}" == "pdf"] + +* {ks_product-en}平台需要启用 DevOps 扩展组件。有关更多信息，请参阅《{ks_product-en}平台管理指南》的“扩展组件管理”章节。 + +endif::[] diff --git a/content/en/docs/_custom-en/workspaceManagement/projects/projects-desc-viewProjectList.adoc b/content/en/docs/_custom-en/workspaceManagement/projects/projects-desc-viewProjectList.adoc new file mode 100644 index 000000000..1e4b3afa6 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/projects/projects-desc-viewProjectList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 3eeb5c203aae46429d31b7aefa3d19f1 +This section introduces how to view the project list. \ No newline at end of file diff --git a/content/en/docs/_custom-en/workspaceManagement/projects/projects-openListPage.adoc b/content/en/docs/_custom-en/workspaceManagement/projects/projects-openListPage.adoc new file mode 100644 index 000000000..4d543fb31 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/projects/projects-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 72b327c9dfd647bbb5416abd154eab96 +. 在**项目**页面点击**项目**或**多集群项目**打开项目列表。 diff --git a/content/en/docs/_custom-en/workspaceManagement/projects/projects-oper-searchForProjects.adoc b/content/en/docs/_custom-en/workspaceManagement/projects/projects-oper-searchForProjects.adoc new file mode 100644 index 000000000..7d3020600 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/projects/projects-oper-searchForProjects.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: e4d2a0b225a247ccb0285a72a9b4d8b0 +* Click the search box at the top of the list, and enter a keyword to search for projects by name. diff --git a/content/en/docs/_custom-en/workspaceManagement/projects/projects-para-projectList.adoc b/content/en/docs/_custom-en/workspaceManagement/projects/projects-para-projectList.adoc new file mode 100644 index 000000000..4cef68b9a --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/projects/projects-para-projectList.adoc @@ -0,0 +1,16 @@ +// :ks_include_id: 63380fe4a19e47f9adc7412b139ff6bc +|名称 +|项目的名称和描述信息。 + +|状态 +| +include::../../clusterManagement/projects/projects-para-status.adoc[] + +|CPU 用量 +|项目中所有工作负载的实时 CPU 使用量。 + +|内存用量 +|项目中所有工作负载的实时内存使用量。 + +|容器组 +|项目中运行的容器组的数量。 diff --git a/content/en/docs/_custom-en/workspaceManagement/projects/projects-para-projectList_new.adoc b/content/en/docs/_custom-en/workspaceManagement/projects/projects-para-projectList_new.adoc new file mode 100644 index 000000000..377ea5be2 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/projects/projects-para-projectList_new.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 63380fe4a19e47f9adc7412b139ff6bc +|Name +|Name and description of the project. + +|Status +| +include::../../clusterManagement/projects/projects-para-status.adoc[] + diff --git a/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-desc-toolBox.adoc b/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-desc-toolBox.adoc new file mode 100644 index 000000000..638e55f9e --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-desc-toolBox.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 90ec47841f944fafb24efa49dae7b328 +本节介绍如何使用工具箱。 diff --git a/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-desc-useLogQueryTools.adoc b/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-desc-useLogQueryTools.adoc new file mode 100644 index 000000000..fbf166ac9 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-desc-useLogQueryTools.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 11bc8bda3d544c559d443538a8b165cb +本节介绍如何查询容器日志。 + +{ks_product-en}提供日志查询工具。用户可以查询自身权限范围内的日志。{ks_product-en}支持查询以下类型的日志： diff --git a/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-desc-viewKubeconfig.adoc b/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-desc-viewKubeconfig.adoc new file mode 100644 index 000000000..2c1d1488c --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-desc-viewKubeconfig.adoc @@ -0,0 +1,3 @@ +This section introduces how to view and download the kubeconfig file. + +The kubeconfig file contains authentication information for the cluster, enabling other applications to access the cluster. KubeSphere supports automatically generating the kubeconfig file based on the current logged-in user, granting the same access permissions to other applications. For more information, please refer to the link:https://kubernetes.io/zh/docs/concepts/configuration/organize-cluster-access-kubeconfig/[Kubernetes documentation]. \ No newline at end of file diff --git a/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-oper-useLogQueryTools.adoc b/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-oper-useLogQueryTools.adoc new file mode 100644 index 000000000..35dc85b04 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-oper-useLogQueryTools.adoc @@ -0,0 +1,16 @@ +// :ks_include_id: 4193b7c9a87a4a178301d417f9773e57 +. 以具有相关资源查看权限的用户登录{ks_product-en} 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/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-oper-viewKubeconfig.adoc b/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-oper-viewKubeconfig.adoc new file mode 100644 index 000000000..87063016a --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-oper-viewKubeconfig.adoc @@ -0,0 +1,14 @@ +// :ks_include_id: b0e53b8c6b7949668a6b41de9862d4e1 +. Log in to the {ks_product-en} web console. + +. Hover over the image::/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18] icon in the bottom right corner of the page, then click **kubeconfig** from the menu. + +. In the pop-up dialog, view the kubeconfig configuration information. ++ +-- +- The **clusters:cluster:server** field displays a virtual IP address for access, which can only be accessed from within the cluster. If you need to access it from outside the cluster, modify this address to the one exposed by the kube-apiserver. + +- The **contexts:cluster:namespace** field defaults to the project name **default**. Modify this field value to the actual project name that the current user has access to. + +- Click image::/images/ks-qkcp/zh/icons/download-dark.svg[download-dark,18,18] to download the **kubeconfig.yaml** file to your local machine. +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-prer-useLogQueryTools.adoc b/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-prer-useLogQueryTools.adoc new file mode 100644 index 000000000..b7b558cc5 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-prer-useLogQueryTools.adoc @@ -0,0 +1,18 @@ +// :ks_include_id: 767f7ca66b4048cd98a9ff15a50b4d62 +* 您需要获得平台、集群、企业空间或项目的资源查看权限，以查看特定范围的日志。 + +ifeval::["{file_output_type}" == "html"] + +* {ks_product-en}平台需要启用日志、事件和审计扩展组件。 + +* {ks_product-en}集群需要添加 Elasticsearch 日志接收器。 + +endif::[] + +ifeval::["{file_output_type}" == "pdf"] + +* {ks_product-en}平台需要启用日志、事件和审计扩展组件。有关更多信息，请参阅《{ks_product-en}平台管理指南》的“扩展组件管理”章节。 + +* {ks_product-en}集群需要添加 Elasticsearch 日志接收器。有关更多信息，请参阅《{ks_product-en}集群管理指南》的“添加日志接收器”章节。 + +endif::[] diff --git a/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-prer-viewKubeconfig.adoc b/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-prer-viewKubeconfig.adoc new file mode 100644 index 000000000..d58fcf581 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/toolBox/toolBox-prer-viewKubeconfig.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 40808c5525064e71af36e47e96b1d978 +You should have KubeSphere username and password. \ No newline at end of file diff --git a/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-desc-changeEmailLanguagePassword.adoc b/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-desc-changeEmailLanguagePassword.adoc new file mode 100644 index 000000000..3a8330ad0 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-desc-changeEmailLanguagePassword.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 149e9993d7754b0cad7ae5e66b491179 +本节介绍如何修改当前用户的邮箱、语言和密码。 diff --git a/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-note-firstLogin.adoc b/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-note-firstLogin.adoc new file mode 100644 index 000000000..2491344e9 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-note-firstLogin.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 8a815fa5b82845cfa11a8ce3911564e2 +Upon initial login, the system will prompt you to change your password. diff --git a/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-note-goToWorkspace.adoc b/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-note-goToWorkspace.adoc new file mode 100644 index 000000000..48a932484 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-note-goToWorkspace.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: b73ee63b32ed4389bc6d4e01f2522e0c +* 如果当前用户同时具有平台级别的权限，您需要在页面左上角选择**平台管理 > 访问控制**，然后点击一个企业空间的名称进入企业空间。 diff --git a/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-oper-changeEmailLanguagePassword.adoc b/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-oper-changeEmailLanguagePassword.adoc new file mode 100644 index 000000000..a34b861b9 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-oper-changeEmailLanguagePassword.adoc @@ -0,0 +1,25 @@ +// :ks_include_id: 24b68b27cd234dc19c8f3db06ff7be8c +. 登录{ks_product-en} Web 控制台。 + +. 在页面右上角点击当前用户名，然后在下拉列表中选择**用户设置**。 + +. 在**基本信息**页签设置用户的邮箱和语言。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|邮箱 +|用户的邮箱地址。邮箱地址可用于登录{ks_product-en} Web 控制台。 + +|语言 +|{ks_product-en} Web 控制台对当前用户显示的语言。 +|=== +-- + +. 点击**密码设置**页签可修改当前用户的密码。 ++ +-- +密码必须包含数字、大写字母和小写字母，长度为 8 至 64 个字符。 +-- diff --git a/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-oper-logIn.adoc b/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-oper-logIn.adoc new file mode 100644 index 000000000..10cab8091 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-oper-logIn.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: b690a1bf28354fa9a64364d91a595cd7 +. Open a web browser and enter the IP address and port number of the {ks_product-en} web console in the address bar, such as `172.31.85.22:30880`. +. On the login page, enter your username and password and click **Log In**. diff --git a/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-prer-logIn.adoc b/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-prer-logIn.adoc new file mode 100644 index 000000000..a514d751f --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/webConsole/webConsole-prer-logIn.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: b7d4651227e646b1b025777d274f6c4a +* Contact the administrator to obtain the IP address and port number of the {ks_product-en} web console. + +* Depending on your network environment, you may need to configure firewall policies and traffic forwarding strategies. For specific instructions, please contact your network administrator. \ No newline at end of file diff --git a/content/en/docs/_custom-en/workspaceManagement/workspace-quotas/workspaceQuotas-para-cpuMemoryQuotas.adoc b/content/en/docs/_custom-en/workspaceManagement/workspace-quotas/workspaceQuotas-para-cpuMemoryQuotas.adoc new file mode 100644 index 000000000..c4436f404 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/workspace-quotas/workspaceQuotas-para-cpuMemoryQuotas.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: 5ad1ed3919ae46abbe1b16d6a66d149c +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|CPU Limit +|Maximum sum of CPU limits for all containers running in a workspace on a single cluster. + +|CPU Request +|Maximum sum of CPU reservations for all containers running in a workspace on a single cluster. + +|Memory Limit +|Maximum sum of memory limits for all containers running in a workspace on a single cluster. + +|Memory Request +|Maximum sum of memory reservations for all containers running in a workspace on a single cluster. +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc b/content/en/docs/_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc new file mode 100644 index 000000000..aadb0eecf --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9e983855b51f4d47a0318514ec5e4d84 +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission, and access your workspace. \ No newline at end of file diff --git a/content/en/docs/_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc b/content/en/docs/_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc new file mode 100644 index 000000000..6b703a67a --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 05d7ebe027f04cc589e8baa04343e651 +You should join a workspace and have the pass:a,q[{ks_permission}] permission within the workspace. For more information, refer to "Workspace Members" and "Workspace Roles". \ No newline at end of file diff --git a/content/en/docs/_custom-en/workspaceManagement/workspaceMembers/workspaceMembers-desc-initialWorkspaceAdmin.adoc b/content/en/docs/_custom-en/workspaceManagement/workspaceMembers/workspaceMembers-desc-initialWorkspaceAdmin.adoc new file mode 100644 index 000000000..e1e65c493 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/workspaceMembers/workspaceMembers-desc-initialWorkspaceAdmin.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: e84bfd6e91754efa8444c040d1726c11 +The creator of a workspace automatically becomes the workspace administrator. Additionally, the **admin** user in the {ks_product-en} platform has all permissions by default in all workspaces. In the initial state of a workspace, the above users can invite other users to join the workspace and set the roles for these users within the workspace. \ No newline at end of file diff --git a/content/en/docs/_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-aliasAndDescription.adoc b/content/en/docs/_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-aliasAndDescription.adoc new file mode 100644 index 000000000..0c18b05f0 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-aliasAndDescription.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 9cee592273284279a2ca4b2ff0c861a5 +|Alias +|The alias of the workspace role. The alias for different workspace roles can be the same. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), and must not start or end with a hyphen (-), with a maximum length of 63 characters. + +|Description +|The description of the workspace role. The description can contain any characters, with a maximum length of 256 characters. \ No newline at end of file diff --git a/content/en/docs/_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions.adoc b/content/en/docs/_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions.adoc new file mode 100644 index 000000000..3729fb3a7 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions.adoc @@ -0,0 +1,101 @@ +// :ks_include_id: b53ca408cc88447789f75df42c73bcc7 +所有企业空间成员都可以查看企业空间基本信息。其他操作所需的权限如下： + +* 项目 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|项目管理 +|编辑项目信息、删除项目、编辑项目配额。 + +|项目创建 +|创建项目，并成为所创建的项目的管理员。 + +|项目查看 +|查看项目列表、查看项目中的所有资源。 +|=== +-- + +* DevOps 项目 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|DevOps 项目管理 +|编辑 DevOps 项目信息、删除 DevOps 项目。 + +|DevOps 项目创建 +|创建 DevOps 项目，并成为所创建的 DevOps 项目的管理员。 + +|DevOps 项目查看 +|查看 DevOps 项目列表、查看 DevOps 项目中的所有资源。 +|=== +-- + +* 应用 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|应用仓库管理 +|添加应用仓库、编辑应用仓库、使应用仓库和 Helm Chart 仓库同步、删除应用仓库。 + +|应用仓库查看 +|查看应用仓库列表。 + +|应用模板管理 +|创建应用模板、编辑应用模板信息、使用应用模板安装应用、上传应用版本、替换应用版本、删除应用版本、将应用版本发布到应用商店、删除应用模板。 + +|应用模板查看 +|查看应用模板列表、查看应用模板详情、下载 Helm Chart 压缩包。 +|=== +-- + +* 访问控制 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|部门管理 +|设置部门组织结构、将用户分配到部门、移除部门成员。 + +|部门查看 +|查看部门组织结构。 + +|成员管理 +|邀请用户加入企业空间、修改企业空间成员的角色、移除企业空间成员。 + +|成员查看 +|查看企业空间成员列表、查看企业空间成员详情。 + +|角色管理 +|创建企业空间角色、编辑企业空间角色信息、编辑企业空间角色权限、删除企业空间角色。 + +|角色查看 +|查看企业空间角色列表、查看企业空间角色详情。 +|=== +-- + +* 企业空间设置 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|企业空间设置管理 +|编辑企业空间信息、启用和禁用网络隔离、删除企业空间、编辑企业空间配额。 + +|企业空间设置查看 +|查看集群资源用量、查看项目资源用量排行、查看企业空间资源用量、查看企业空间配额。 +|=== +-- diff --git a/content/en/docs/_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions_new.adoc b/content/en/docs/_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions_new.adoc new file mode 100644 index 000000000..11e03fc02 --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions_new.adoc @@ -0,0 +1,101 @@ +// :ks_include_id: b53ca408cc88447789f75df42c73bcc7 +所有企业空间成员都可以查看企业空间基本信息。其他操作所需的权限如下： + +* 项目 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|项目创建 +|创建项目，并成为所创建的项目的管理员。 + +|项目管理 +|创建、编辑和删除企业空间中的项目。 + +|项目查看 +|查看项目列表、查看项目中的所有资源。 +|=== +-- + +* DevOps 项目（需要安装 DevOps 扩展组件） ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|DevOps 项目创建 +|创建 DevOps 项目，并成为所创建的 DevOps 项目的管理员。 + +|DevOps 项目管理 +|创建、编辑和删除企业空间中的 DevOps 项目。 + +|DevOps 项目查看 +|查看 DevOps 项目列表、查看 DevOps 项目中的所有资源。 +|=== +-- + +// * 应用 +// + +// -- +// [%header,cols="1a,4a"] +// |=== +// |权限 |允许操作 + +// |应用仓库管理 +// |添加应用仓库、编辑应用仓库、使应用仓库和 Helm Chart 仓库同步、删除应用仓库。 + +// |应用仓库查看 +// |查看应用仓库列表。 + +// |应用模板管理 +// |创建应用模板、编辑应用模板信息、使用应用模板安装应用、上传应用版本、替换应用版本、删除应用版本、将应用版本发布到应用商店、删除应用模板。 + +// |应用模板查看 +// |查看应用模板列表、查看应用模板详情、下载 Helm Chart 压缩包。 +// |=== +// -- + +* 访问控制 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +// |部门管理 +// |设置部门组织结构、将用户分配到部门、移除部门成员。 + +// |部门查看 +// |查看部门组织结构。 + +// |成员管理 +// |邀请用户加入企业空间、修改企业空间成员的角色、移除企业空间成员。 + +|成员查看 +|查看企业空间成员列表、查看企业空间成员详情。 + +// |角色管理 +// |创建企业空间角色、编辑企业空间角色信息、编辑企业空间角色权限、删除企业空间角色。 + +|角色查看 +|查看企业空间角色列表、查看企业空间角色详情。 +|=== +-- + +// * 企业空间设置 +// + +// -- +// [%header,cols="1a,4a"] +// |=== +// |权限 |允许操作 + +// |企业空间设置管理 +// |编辑企业空间信息、启用和禁用网络隔离、删除企业空间、编辑企业空间配额。 + +// |企业空间设置查看 +// |查看集群资源用量、查看项目资源用量排行、查看企业空间资源用量、查看企业空间配额。 +// |=== +// -- diff --git a/content/en/docs/_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions_v4.adoc b/content/en/docs/_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions_v4.adoc new file mode 100644 index 000000000..0f9a3e23e --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions_v4.adoc @@ -0,0 +1,56 @@ +// :ks_include_id: b53ca408cc88447789f75df42c73bcc7 +All workspace members can view basic information about the workspace. The permissions required for other operations are as follows: + +* Projects ++ +-- +[%header,cols="1a,4a"] +|=== +|Permission | Operations Allowed + +|Project Creation +|Create projects and become an administrator of the created projects. + +|Project Management +|Create, edit, and delete projects in the workspace. + +|Project Viewing +|View all projects and project resources. +|=== +-- + +* Applications ++ +-- +[%header,cols="1a,4a"] +|=== +|Permission | Operations Allowed + +|App Repos Management +|Add app repositories, edit app repositories, delete app repositories. + +|App Repos Viewing +|View the list of app repositories. + +|App/App Version/App Instance Management +|Create app templates, edit app template information, install apps using app templates, upload app versions, delete app versions, publish app versions to the app store, delete app templates. + +|App/App Version/App Instance Viewing +|View the list of app templates, view app template details, download Helm Chart compressed files. +|=== +-- + +* Access Control ++ +-- +[%header,cols="1a,4a"] +|=== +|Permission | Operations Allowed + +|Member Viewing +|View the list of workspace members, view details of workspace members. + +|Role Viewing +|View the list of workspace roles, view details of workspace roles. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-presetRoles.adoc b/content/en/docs/_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-presetRoles.adoc new file mode 100644 index 000000000..d61692d5c --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-presetRoles.adoc @@ -0,0 +1,19 @@ +// :ks_include_id: a438eaa55c9043cbb3d66ebadd42472e +{ks_product-en}平台提供以下预置企业空间角色： + +[%header,cols="1a,4a"] +|=== +|角色 |描述 + +|workspace-admin +|企业空间管理员，在企业空间内具有全部权限。 + +|workspace-self-provisioner +|企业空间自治用户，在企业空间内可以查看和创建项目、多集群项目和 DevOps 项目，查看和管理应用模板，以及查看企业空间设置，同时对自身创建的项目、多集群项目和 DevOps 项目具有管理权限。 + +|workspace-viewer +|企业空间观察员，可以查看企业空间内的所有资源。 + +|workspace-regular +|企业空间普通用户，在企业空间内只具有企业空间设置查看权限。该角色一般授予不需要其他企业空间权限的项目成员。 +|=== \ No newline at end of file diff --git a/content/en/docs/_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-presetRoles_v4.adoc b/content/en/docs/_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-presetRoles_v4.adoc new file mode 100644 index 000000000..ab66453bb --- /dev/null +++ b/content/en/docs/_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-presetRoles_v4.adoc @@ -0,0 +1,19 @@ +// :ks_include_id: a438eaa55c9043cbb3d66ebadd42472e +KubeSphere provides the following preset workspace roles: + +[%header,cols="1a,4a"] +|=== +|Role |Description + +|workspace-admin +|Workspace administrator, has full permissions within the workspace. + +|workspace-self-provisioner +|Workspace self-provisioner, can create projects, view workspace settings, and has management permissions for projects they create. + +|workspace-viewer +|Workspace viewer, can view all resources within the workspace. + +|workspace-regular +|Workspace regular user, only has permission to view workspace settings within the workspace. This role is typically assigned to project members who do not require additional workspace permissions. +|=== \ No newline at end of file diff --git a/content/en/docs/v4.1/01-intro/01-introduction.adoc b/content/en/docs/v4.1/01-intro/01-introduction.adoc new file mode 100644 index 000000000..b81a1720c --- /dev/null +++ b/content/en/docs/v4.1/01-intro/01-introduction.adoc @@ -0,0 +1,70 @@ +--- +title: "KubeSphere LuBan" +linkTitle: "KubeSphere LuBan" +description: "Introduce the background and features of KubeSphere LuBan." +weight: 01 +--- + +{ks_product-en} is a distributed multi-tenant commercial cloud-native operating system based on the Kubernetes kernel. Based on open-source capabilities, it extends functionality across multiple core business scenarios, such as multi-cloud cluster management, microservice governance, and application management. Its extension center - KubeSphere Marketplace is highly modular, catering to various business needs in different scenarios. With its robust enterprise-grade cloud-native foundation, comprehensive professional solutions, and service support, it empowers enterprises for digital transformation and operations on a large scale. + +Since {ks_product-en} v4.0, the all-new KubeSphere architecture: **KubeSphere LuBan** has been introduced, which is built on link:https://kubernetes.io/docs/concepts/extend-kubernetes/[Kubernetes] and is highly configurable and extensible. KubeSphere LuBan, a distributed, open, and scalable cloud-native architecture, provides a pluggable microkernel for extensions. From now on, all KubeSphere functional components and third-party components will seamlessly integrate into the KubeSphere console as extensions based on KubeSphere LuBan, and maintain their versions independently, truly achieving a plug-and-play cloud-native operating system. + +== Why Introduce KubeSphere LuBan + +Since 2018, the KubeSphere multi-cloud container management platform has released over a dozen versions, including three major ones. To meet user demands, KubeSphere integrated numerous enterprise-grade features, such as multi-tenancy management, multi-cluster management, DevOps, GitOps, service mesh, microservices, observability (including monitoring, alerts, logging, auditing, events, notifications, etc.), App Store, edge computing, network, storage, etc. + +While KubeSphere's all-in-one container solution significantly enhances users' experience, it has also brought the following challenges: + +**Long release cycle** + +Before releasing a new version of KubeSphere, we must wait for all extensions to finish development and testing, and pass the integration testing. + +**Delayed user response** + +Since each extension cannot be iterated separately, even when we have solved the issues of extensions submitted by users, we have to wait for the new release of KubeSphere to deliver the solutions to users, resulting in a delayed response. + +**Code coupling** + +Although the old version supports enabling/disabling extensions individually, the frontend and backend code of these extensions are still coupled together, which tends to affect each other and is not architecturally elegant. + +**Excessive resource consumption** + +Some extensions are enabled by default, which may consume excessive system resources for users who do not need them. + +== KubeSphere LuBan Advantages + +**Pluggable framework** + +Support independent development and deployment of extensions to extend the functionality. Extensions can be added, upgraded, or removed as needed without modifying the code of the core framework. + +**Open UI component library** + +Components are open to everyone and can be freely accessed, used, and extended. Users can customize and extend them according to their needs to meet different design and functionality requirements. + +**Real-time updates and fixes** + +Developers can update and fix the frontend and backend in real time while the system is running, improving the efficiency of development and operation while ensuring the availability and user experience of applications. + +**Open extension center** + +An open extension center - KubeSphere Marketplace is provided to encourage third-party developers to add new features or enhance existing ones to the system by extensions. They can develop and integrate their extensions within the system's framework, seamlessly connect their extensions with the system, and collectively build a healthy and thriving ecosystem. + +== How KubeSphere LuBan Can Help You + +The KubeSphere LuBan architecture can benefit the following people: + +**KubeSphere users** + +KubeSphere users are free to choose and enable extensions. They can also seamlessly integrate their applications into the KubeSphere console. In addition, as the ecosystem of KubeSphere extensions is enriched, users can freely select a variety of products and services from the KubeSphere Marketplace, ultimately achieving a highly customized container management platform. + +**KubeSphere maintainers** + +The extension mechanism allows KubeSphere maintainers to pay more attention to the development of KubeSphere Core, make it lighter, and shorten the release cycle. Additionally, since extensions can be iterated independently, user needs can be met more timely. + +**KubeSphere contributors** + +The extension mechanism makes KubeSphere Core and other KubeSphere extensions more loosely coupled and easier to develop. + +**Cloud-native application developers (ISV) or open-source projects** + +Numerous ISVs or open-source projects can seamlessly integrate their products or projects into the KubeSphere ecosystem at a low cost. For example, Karmada/KubeEdge developers can develop a standalone Karmada/KubeEdge console based on KubeSphere LuBan. diff --git a/content/en/docs/v4.1/01-intro/02-architecture.adoc b/content/en/docs/v4.1/01-intro/02-architecture.adoc new file mode 100644 index 000000000..89962e259 --- /dev/null +++ b/content/en/docs/v4.1/01-intro/02-architecture.adoc @@ -0,0 +1,42 @@ +--- +title: "KubeSphere LuBan Architecture" +linkTitle: "KubeSphere LuBan Architecture" +description: "Introduce the architecture and extensions of KubeSphere LuBan." +weight: 02 +--- + +To make KubeSphere flexible and extensible, a `microkernel + extensions` architecture (LuBan) is designed. In this architecture, the core part (KubeSphere Core) contains only essential basic functions for system running, while independent modules are packaged in various components (Extensions). Users can dynamically install, uninstall, enable, or disable extensions while the system is running. + +== KubeSphere LuBan Architecture + +The KubeSphere LuBan architecture is designed as the following diagram. + +image:/images/ks-qkcp/zh/v4.0/4.0-architecture.png[architecture,80%] + +== What Are KubeSphere Extensions? + +KubeSphere extensions are Helm Charts that follow the KubeSphere extension development specification, which extends KubeSphere's functionality and orchestrates using Helm. + +Developers in the cloud-native field no longer have to spend a lot of time learning proprietary application orchestration methods. + +If you are looking for published extensions, please visit link:https://kubesphere.com.cn/extensions/marketplace/[KubeSphere Marketplace]。 + +== What Can KubeSphere Extensions Do? + +From the frontend UI to the backend API, almost every part of KubeSphere can be customized and enhanced by extended APIs. Many of KubeSphere's core features are also built as extensions and use the same extended API. + +Here are some examples of what can be achieved using extended APIs: + +- Injecting new menus and functional pages in the project's left navigation pane to manage more types of resources. +- Injecting functional entries into platform-level menus to enhance platform management capabilities. +- Embedding pages of existing third-party extensions directly into KubeSphere to aggregate dispersed systems. +- Overriding KubeSphere's existing page routes to implement your unique business logic. +- Extending KubeSphere's API. + +If you want a more comprehensive understanding of extended APIs, please refer to link:https://dev-guide.kubesphere.io/extension-dev-guide/en/feature-customization/[Feature Customization]。 + +== How Do I Build Extensions? + +View the link:https://dev-guide.kubesphere.io/extension-dev-guide/en/examples/[Development Examples] section to learn how to build extensions. + +If you have questions about the development process, try getting help at link:https://github.com/kubesphere/kubesphere/issues/new/choose[GitHub Issue]. \ No newline at end of file diff --git a/content/en/docs/v4.1/01-intro/03-scenarios.adoc b/content/en/docs/v4.1/01-intro/03-scenarios.adoc new file mode 100644 index 000000000..7f1290794 --- /dev/null +++ b/content/en/docs/v4.1/01-intro/03-scenarios.adoc @@ -0,0 +1,26 @@ +--- +title: "Usage Scenarios" +linkTitle: "Usage Scenarios" +description: "Get usage scenarios of KubeSphere." +weight: 03 +--- + +{ks_product-en} is suitable for the following scenarios. + +== Resource Quantification Operations + +Resource management of multiple departments often brings huge pressure to the O&M department, which has to spend a lot of time on statistics on resource utilization of each business line, and assessment of the reasonableness of resource utilization. KubeSphere provides multi-dimensional and multi-perspective resource quantitative statistics methods, and resource data can be viewed at a glance. + +== Multi-level Permission Control + +Efficiently coordinating different business lines within a company has always been an age-old challenge. How to achieve tight collaboration between infrastructure operations, application operations, and business developers while implementing access control has become the core requirement of organizational structure. + +KubeSphere provides a "three-level" user permission system, which rationally allocates permissions across platform administrators, cluster operators, and application operators, thereby promoting departmental collaboration. + +== Intelligent Elastic Operations + +Excessive waste of basic resources brings additional operational costs to enterprises. Effectively analyzing the rationality of resource usage and performing efficient resource elasticity management in different scenarios have become challenges for operations personnel. KubeSphere provides intelligent recommendations, periodic analysis, one-click application for business resources, and supports elastic scaling of custom metrics, empowering intelligent operations. + +== One-Stack Transformation + +Many enterprises face challenges when transforming to cloud native, such as difficulties in choosing the right technology solutions to achieve DevOps integration, cloud-native microservice governance, edge-cloud collaboration, AI (Artificial Intelligence), and observability in cloud native. The selection of various technology solutions and operations can be a significant trouble for enterprises. KubeSphere integrates best practices and provides a highly graphical and consistent user experience to help enterprises transform to cloud native at a low cost. \ No newline at end of file diff --git a/content/en/docs/v4.1/01-intro/_index.adoc b/content/en/docs/v4.1/01-intro/_index.adoc new file mode 100644 index 000000000..dc9bfbf18 --- /dev/null +++ b/content/en/docs/v4.1/01-intro/_index.adoc @@ -0,0 +1,11 @@ +--- +title: "Introduction" +linkTitle: "Introduction" +keywords: KubeSphere, KubeSphere LuBan, Introduction +description: Introduce the features, architecture, and usage scenarios of KubeSphere. +layout: "second" +weight: 01 +icon: "/images/docs/common/docs.svg" +--- + +This section introduces the features, architecture, and usage scenarios of {ks_product-en}. \ No newline at end of file diff --git a/content/en/docs/v4.1/02-quickstart/01-install-kubesphere.adoc b/content/en/docs/v4.1/02-quickstart/01-install-kubesphere.adoc new file mode 100644 index 000000000..cb317c413 --- /dev/null +++ b/content/en/docs/v4.1/02-quickstart/01-install-kubesphere.adoc @@ -0,0 +1,125 @@ +--- +title: "Install KubeSphere on Kubernetes" +linkTitle: "Install KubeSphere on Kubernetes" +keywords: 'KubeSphere, Kubernetes, All-in-One, Installation' +description: 'Learn how to quickly deploy Kubernetes and KubeSphere.' +weight: 01 +--- + +This section describes how to quickly deploy Kubernetes and {ks_product-en} on a single node. This installation method is only suitable for testing. For installing {ks_product-en} in a production environment, please refer to link:../../03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere/[Install Kubernetes and {ks_product-en}]. + +== Prerequisites + +* Your linux machine meets the minimum hardware requirements: CPU > 2 cores, memory > 2 GB, disk space > 40 GB. + +* Helm should have been installed in advance. For specific instructions, please refer to link:https://helm.sh/docs/intro/[Helm Installation]. + + +== Steps + +. (Optional) If you don't have an available Kubernetes cluster, run the following command to quickly create one. + +.. If you are accessing GitHub/Googleapis from a restricted location, please log in to any cluster node and run the following command to set the download region. ++ +[,bash] +---- +export KKZONE=cn +---- + +.. Run the following command to install KubeKey. ++ +-- +After the download is complete, a KubeKey binary file **kk** will be generated in the current directory. + +[,bash] +---- +curl -sfL https://get-kk.kubesphere.io | sh - +---- +-- + +.. Run the following command to install dependencies. ++ +[,bash] +---- +apt install socat conntrack -y +---- + +.. Run the following command to quickly create a Kubernetes cluster. ++ +[,bash] +---- +./kk create cluster --with-local-storage --with-kubernetes v1.31.0 --container-manager containerd -y +---- + +. If you already have an available Kubernetes cluster, run the following command to install KubeSphere Core (the core component of KubeSphere) using `helm`. ++ +[,bash] +---- +helm upgrade --install -n kubesphere-system --create-namespace ks-core https://charts.kubesphere.io/main/ks-core-1.1.2.tgz --debug --wait +---- ++ +include::../../../_ks_components-en/admonitions/note.adoc[] + +If you are accessing Docker Hub from a restricted location, add the following configuration after the above command to modify the default image pull address. + +[,bash] +---- +--set global.imageRegistry=swr.cn-southwest-2.myhuaweicloud.com/ks +---- + +[,bash] +---- +--set extension.imageRegistry=swr.cn-southwest-2.myhuaweicloud.com/ks +---- + +include::../../../_ks_components-en/admonitions/admonEnd.adoc[] + +. After the installation is complete, the output will display the IP address and port of the web console, with the default NodePort being 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. +---- + +Run the following command to check the status of the pods. + +[,bash] +---- +kubectl get pods -n kubesphere-system +---- + +When the pod status is **Running**, you can access the {ks_product-en} web console at :30880 using the default account and password (admin/P@88w0rd). + +include::../../../_ks_components-en/admonitions/note.adoc[] + +Depending on your network environment, you may need to configure traffic forwarding rules and allow port 30880 in the firewall. + +include::../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- diff --git a/content/en/docs/v4.1/02-quickstart/03-control-user-permissions.adoc b/content/en/docs/v4.1/02-quickstart/03-control-user-permissions.adoc new file mode 100644 index 000000000..f9ac4261a --- /dev/null +++ b/content/en/docs/v4.1/02-quickstart/03-control-user-permissions.adoc @@ -0,0 +1,212 @@ +--- +title: "Create Workspaces, Projects, Users, and Platform Roles" +linkTitle: "Control User Permissions" +keywords: "Kubernetes, KubeSphere, Quick Start, User Permissions" +description: "Learn how to create users and control their permissions by roles in workspaces and projects." +weight: 03 +--- + +This section explains how to create users and control their permissions by roles in workspaces and projects. +For more information on permission control, please refer to link:../../05-users-and-roles/[Users and Roles]. + +As a multi-tenant system, KubeSphere supports controlling user permissions based on roles at the platform, cluster, workspace, and project levels, achieving logical resource isolation. + + +== Prerequisites + +{ks_product-en} has been installed. + +== Create Users + +. Log in to the {ks_product-en} web console using the default user **admin** and password **P@88w0rd**. ++ +-- +// Note +include::../../../_ks_components-en/admonitions/note.adoc[] + +For security, you will be asked to change your password on your first login, please change it and use the new password for subsequent logins. + +include::../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- + +. Click **Users and Roles**. + +. In the left navigation pane, click **Users**. + +. Click **Create** above the user list. + +. In the **Create User** dialog, enter the following required parameters: ++ +-- +* Username +* Email +* Password +-- + +. Click **OK**. The newly created user will be displayed in the user list. + + +== Create Workspaces + +. Log in to the {ks_product-en} web console. +. Click **Workspace Management**. +. On the list of workspaces page, click **Create** to open the **Create Workspace** dialog. +. On the **Basic Information** tab, enter the name of the workspace (for example, **demo-workspace**), and click **Next**. ++ +-- +[.admon.note,cols="a"] +|=== +|Note + +| +For multi-cluster environments, after setting the basic information, you should select a cluster for the workspace on the **Cluster Settings** tab. + +|=== +-- + +. Click **OK**. The newly created workspace will be displayed in the workspace list. + +== Create Workspace Roles + +. On the list of workspaces page, click **demo-workspace** to enter that workspace. + +. In the left navigation pane, click **Workspace Settings** > **Workspace Roles**. ++ +-- +The Workspace Roles page lists the following four built-in roles by default. + +[%header,cols="1a,2a"] +|=== +|Roles |Description + +|**workspace-viewer** +|A workspace viewer who can view all resources in the workspace. + +|**workspace-self-provisioner** +|A regular member of the workspace who can view workspace settings, and create projects. + +|**workspace-regular** +|A regular member of the workspace who can view workspace settings. + +|**workspace-admin** +|A workspace administrator who can manage all resources in the workspace. + +|=== + +//note +[.admon.note,cols="a"] +|=== +|Note + +| +The names of the built-in roles in a workspace are displayed in the - format. For example, in a workspace named **demo-workspace**, the actual role name for the role **admin** is **demo-workspace-admin**. + +|=== +-- +. On the Workspace Roles page, click **Create**. + +. In the **Create Platform Role** dialog, enter **Name** and click **Edit Permissions** to continue. + +. In the **Edit Permissions** dialog, the permissions are categorized. ++ +-- +Click **Projects** and select **Project Creation**, **Project Management**, and **Project Viewing** for this role. + +//note +[.admon.note,cols="a"] +|=== +|Note + +|**Depends On** means that the current permission depends on the listed authorizations, which will be automatically selected when you check this permission. + +|=== +-- + +. Click **OK**. The newly created role will be displayed in the list of workspace roles. + +== Invite Users to a Workspace + +. In the left navigation pane, click **Workspace Settings** > **Workspace Members**. + +. On the Workspace Members page, click **Invite**. + +. In the **Invite Member** dialog, click image:/images/ks-qkcp/zh/icons/add-dark.svg[add,18,18] to the right of the user and assign the user a role in the current workspace. + +. Click **OK**. The user is invited and will be displayed in the list of workspace members. + + +== Create Projects + +. In the left navigation pane, select **Projects**. + +. On the **Projects** page, click **Create**. + +. In the **Create Project** dialog, enter the **name** of the project (e.g., **demo-project**). + ++ +-- +// Note +include::../../../_ks_components-en/admonitions/note.adoc[] + +For a multi-cluster environment, you should choose the cluster where you want to create the project. + +include::../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- + +. Click **OK**. The project will be displayed in the project list. + +== Create Project Roles + +. On the **Projects** page, click **demo-project** to enter the project. + +. In the left navigation pane, click **Project Settings** > **Project Roles**. + ++ +-- +The Project Roles page displays the following three built-in roles by default. + +[%autowidth] +|=== +| Role | Description + +| **viewer** +| A project viewer who can view all resources in the project. + +| **operator** +| A project operator who can manage resources in the project excluding users and roles. + +| **admin** +| A project administrator who can manage all resources in the project. +|=== +-- + +. On the Project Roles page, click **Create**. + +. In the **Create Role** dialog, enter **Name**, then click **Edit Permissions** to proceed. + +. In the **Edit Permissions** dialog, the permissions are categorized. + ++ +-- +In this example, click **Access Control** and select **Member Viewing** and **Role Viewing** for this role. + +// Note +include::../../../_ks_components-en/admonitions/note.adoc[] + +**Depends On** means that the current permission depends on the listed authorizations, which will be automatically selected when you check this permission. + +include::../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- + +. Click **OK**. The newly created role will be displayed in the list of project roles. + + +== Invite Users to a Project + +. In the left navigation pane, click **Project Settings** > **Project Members**. + +. On the Project Members page, click **Invite**. + +. In the **Invite Member** dialog, click image:/images/ks-qkcp/zh/icons/add-dark.svg[add,18,18] to the right of the user and assign the user a role in the current project. + +. Click **OK**. The user is invited and will be displayed in the list of project members. \ No newline at end of file diff --git a/content/en/docs/v4.1/02-quickstart/04-change-display-language.adoc b/content/en/docs/v4.1/02-quickstart/04-change-display-language.adoc new file mode 100644 index 000000000..416eb6ef5 --- /dev/null +++ b/content/en/docs/v4.1/02-quickstart/04-change-display-language.adoc @@ -0,0 +1,34 @@ +--- +title: "Change Display Language" +linkTitle: "Change Display Language" +keywords: "Kubernetes, KubeSphere, cluster management, web console, change language" +description: "This guide explains how to change the display language of the web console." +weight: 04 +--- + +This section explains how to change the display language of the {ks_product-en} web console. + +== Prerequisites + +You should have the username and password for the {ks_product-en} web console. + +== Steps + +1. Log in to the {ks_product-en} web console. + +2. Click on the current username in the upper right corner of the page, then choose **User Settings** from the dropdown list. + +3. On the **Basic Information** tab, set the email address and language for the user. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Email +| The email address of the user. The email address can be used to log in to the {ks_product-en} web console. + +| Language +| The language displayed in the {ks_product-en} web console for the current user. Supported languages: Simplified Chinese and English. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/02-quickstart/_index.adoc b/content/en/docs/v4.1/02-quickstart/_index.adoc new file mode 100644 index 000000000..e46cc00a1 --- /dev/null +++ b/content/en/docs/v4.1/02-quickstart/_index.adoc @@ -0,0 +1,13 @@ +--- +title: "Quick Start" +linkTitle: "Quick Start" +keywords: "Kubernetes, KubeSphere, Quick Start" +description: "Introduce how to install KubeSphere, as well as how to control user permissions." +layout: "second" +weight: 02 +icon: "/images/docs/common/docs.svg" +--- + +This section provides a brief overview of how to install {ks_product-en}, as well as how to control user permissions, helping you quickly get started with {ks_product-en}. + +For more information on installing and using {ks_product-en}, please refer to other sections in the documentation. \ No newline at end of file diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/01-supported-k8s.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/01-supported-k8s.adoc new file mode 100644 index 000000000..fd207f4cb --- /dev/null +++ b/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/01-supported-k8s.adoc @@ -0,0 +1,199 @@ +--- +title: "Environment Requirements" +linkTitle: "Environment Requirements" +keywords: "Kubernetes, KubeSphere, Components, Support Matrix" +description: "Introduce the environment requirements of KubeSphere." +weight: 01 +--- + + +This section introduces the environment requirements for {ks_product-en}. + +== System Requirements + +[%header,cols="3a,4a,4a"] +|=== +|OS |Minimum Requirements (per node)| Requirements for Production Environment (per node) + +|Ubuntu 16.04, 18.04, 20.04, 22.04 +|CPU: 2 cores, Memory: 4 GB, Disk: 40 GB +|CPU: 8 cores, Memory: 16 GB, Disk: 200 GB + +|Debian Buster, Stretch +|CPU: 2 cores, Memory: 4 GB, Disk: 40 GB +|CPU: 8 cores, Memory: 16 GB, Disk: 200 GB + +|CentOS 7.x, CentOS Stream +|CPU: 2 cores, Memory: 4 GB, Disk: 40 GB +|CPU: 8 cores, Memory: 16 GB, Disk: 200 GB + +|Red Hat Enterprise Linux 7.x, 8.x +|CPU: 2 cores, Memory: 4 GB, Disk: 40 GB +|CPU: 8 cores, Memory: 16 GB, Disk: 200 GB + +|SUSE Linux Enterprise Server 15/openSUSE Leap 15.2 +|CPU: 2 cores, Memory: 4 GB, Disk: 40 GB +|CPU: 8 cores, Memory: 16 GB, Disk: 200 GB +|=== + +== Dependency Requirements + +[%header,cols="1a,4a,4a"] +|=== +|Dependency |Kubernetes Version ≥ 1.18|Kubernetes Version < 1.18 + +|socat +|Required +|Optional, but recommended + +|conntrack +|Required +|Optional, but recommended + +|ebtables +|Optional, but recommended +|Optional, but recommended + +|ipset +|Optional, but recommended +|Optional, but recommended +|=== + +== Container Runtime Requirements + +[%header,cols="4a,4a"] +|=== +|Supported Container Runtimes |Version + +|Docker +|20.10.0+ + +|containerd +|Latest version + +|CRI-O (Experimental, not fully tested) +|Latest version + +|iSula (Experimental, not fully tested) +|Latest version +|=== + +== Network Requirements + +* Ensure that the DNS addresses in **/etc/resolv.conf** are accessible; otherwise, it may cause DNS issues in the cluster. + +* If your network configuration uses firewall rules or security groups, make sure that the infrastructure components can communicate with each other through specific ports. It is recommended to disable the firewall. + +* Supported CNI plugins: Calico and Flannel. Other plugins such as Cilium and Kube-OVN are also compatible, but note that they have not been fully tested. + +== Port Requirements + +Certain ports are used for communication between services. If you have firewall rules in your network configuration, ensure that the infrastructure components can communicate with each other through specific ports. These ports serve as communication endpoints for certain processes or services. + +[%header,cols="2a,2a,2a,2a,2a,3a"] +|=== +|Service +|Protocol +|Action +|Start Port +|End Port +|Remarks + +|ssh +|TCP +|Allow +|22 +|N/A +|N/A + +|etcd +|TCP +|Allow +|2379 +|2380 +|N/A + +|apiserver +|TCP +|Allow +|6443 +|N/A +|N/A + +|calico +|TCP +|Allow +|9099 +|9100 +|N/A + +|bgp +|TCP +|Allow +|179 +|N/A +|N/A + +|nodeport +|TCP +|Allow +|30000 +|32767 +|N/A + +|master +|TCP +|Allow +|10250 +|10258 +|N/A + +|dns +|TCP +|Allow +|53 +|N/A +|N/A + +|dns +|UDP +|Allow +|53 +|N/A +|N/A + +|local-registry +|TCP +|Allow +|5000 +|N/A +|Required for offline environments + +|local-apt +|TCP +|Allow +|5080 +|N/A +|Required for offline environments + +|rpcbind +|TCP +|Allow +|111 +|N/A +|Required when using NFS + +|ipip +|IPENCAP / IPIP +|Allow +|N/A +|N/A +|Calico requires IPIP protocol + +|metrics-server +|TCP +|Allow +|8443 +|N/A +|N/A +|=== \ No newline at end of file diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/03-configure-high-availability.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/03-configure-high-availability.adoc new file mode 100644 index 000000000..395dcf9b5 --- /dev/null +++ b/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/03-configure-high-availability.adoc @@ -0,0 +1,395 @@ +--- +title: "Configure High Availability" +linkTitle: "Configure High Availability" +keywords: "Kubernetes, KubeSphere, Installation, Preparation, High Availability" +description: "Learn how to configure high availability in case of a single control plane node failure." +weight: 03 +--- + + +This section explains how to configure multiple control plane nodes for high availability in a production environment for the KubeSphere cluster. This ensures that the cluster services remain operational even if a single control plane node fails. If your KubeSphere cluster does not require high availability, you can skip this section. + +// Note +include::../../../../_ks_components-en/admonitions/note.adoc[] + +The high availability configuration for KubeSphere is only supported when installing Kubernetes and {ks_product-en} together. If you are installing {ks_product-en} on an existing Kubernetes cluster, {ks_product-en} will utilize the existing high availability configuration of the Kubernetes cluster. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] + +This section explains the following methods for configuring high availability: + +* **Local Load Balancer Configuration**: You can install HAProxy on the worker nodes during the KubeSphere installation process using the KubeKey tool. HAProxy will act as a reverse proxy for the control plane nodes, and the Kubernetes components on the worker nodes will connect to the control plane nodes through HAProxy. This method requires additional health check mechanisms and may reduce efficiency compared to other methods, but can be used in scenarios without a dedicated load balancer and with a limited number of servers. + +* **Dedicated Load Balancer**: You can use a load balancer provided by your cloud environment as a reverse proxy for the control plane nodes. This method requires deploying the KubeSphere cluster in a cloud environment that offers a dedicated load balancer. + +* **Generic Servers as Load Balancers**: You can install Keepalived and HAProxy on Linux servers outside the cluster nodes to act as load balancers. This method requires at least two additional Linux servers. + +== Local Load Balancer Configuration + +To use HAProxy for high availability, you need to configure the following parameters in the installation configuration file **config-sample.yaml** during the installation of {ks_product-en}: + +// YAML +include::../../../../_ks_components-en/code/yaml.adoc[] + +spec: + controlPlaneEndpoint: + internalLoadbalancer: haproxy + domain: lb.kubesphere.local + address: "" + port: 6443 + +---- + +KubeKey will automatically install HAProxy on the worker nodes and complete the high availability configuration, requiring no additional actions. For more information, please refer to link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[Install Kubernetes and {ks_product-en}]. + +== Dedicated Load Balancer + +To achieve high availability using a dedicated load balancer provided by your cloud environment, you need to perform the following steps within your cloud environment: + +. Create a load balancer with a minimum of two replicas in your cloud environment. +. Configure the load balancer to listen on port 6443 of each control plane node in the KubeSphere cluster. +. Obtain the IP address of the load balancer for future use during the installation of {ks_product-en}. + +For specific instructions, please refer to the user guide of your cloud environment or contact your cloud service provider. + +== Generic Servers as Load Balancers + +The following describes how to configure a generic server as a load balancer using Keepalived and HAProxy. + +=== Prerequisites + +* You need to prepare two Linux servers that belong to the same private network as the cluster nodes as load balancers. + +* You need to prepare a Virtual IP address (VIP) to serve as the floating IP address for the two load balancer servers. This address should not be used by any other devices or components to avoid address conflicts. + +=== Configure High Availability + +. Log in to the server that will be used as the load balancer and execute the following command to install HAProxy and Keepalived (the example assumes Ubuntu as the operating system; please replace **apt** with the corresponding package manager for other operating systems): ++ +-- +// Bash +[,bash] +---- + +apt install keepalived haproxy psmisc -y + +---- +-- + +. Execute the following command to edit the HAProxy configuration file: ++ +-- +// Bash +[,bash] +---- + +vi /etc/haproxy/haproxy.cfg + +---- +-- + +. Add the following information to the HAProxy configuration file and save the file (replace with the private IP addresses of the control plane nodes in the KubeSphere cluster): ++ +-- +// Bash +[,bash] +---- + +global + log /dev/log  local0 warning + chroot      /var/lib/haproxy + pidfile     /var/run/haproxy.pid + maxconn     4000 + user        haproxy + group       haproxy + daemon + + stats socket /var/lib/haproxy/stats + +defaults + log global + option  httplog + option  dontlognull + timeout connect 5000 + timeout client 50000 + timeout server 50000 + +frontend kube-apiserver + bind *:6443 + mode tcp + option tcplog + default_backend kube-apiserver + +backend kube-apiserver + mode tcp + option tcplog + option tcp-check + balance roundrobin + default-server inter 10s downinter 5s rise 2 fall 2 slowstart 60s maxconn 250 maxqueue 256 weight 100 + server kube-apiserver-1 :6443 check + server kube-apiserver-2 :6443 check + server kube-apiserver-3 :6443 check + +---- +-- + +. Execute the following command to restart HAProxy: ++ +-- +// Bash +[,bash] +---- + +systemctl restart haproxy + +---- +-- + +. Execute the following command to set HAProxy to run automatically on startup: ++ +-- +// Bash +[,bash] +---- + +systemctl enable haproxy + +---- +-- + +. Execute the following command to edit the Keepalived configuration file: ++ +-- +// Bash +[,bash] +---- + +vi /etc/keepalived/keepalived.conf + +---- +-- + +. Add the following information to the Keepalived configuration file and save the file: ++ +-- +// Bash +[,bash] +---- + +global_defs { + notification_email { + } + router_id LVS_DEVEL + vrrp_skip_check_adv_addr + vrrp_garp_interval 0 + vrrp_gna_interval 0 +} + +vrrp_script chk_haproxy { + script "killall -0 haproxy" + interval 2 + weight 2 +} + +vrrp_instance haproxy-vip { + state BACKUP + priority 100 + interface + virtual_router_id 60 + advert_int 1 + authentication { + auth_type PASS + auth_pass 1111 + } + unicast_src_ip + unicast_peer { + + } + + virtual_ipaddress { + + } + + track_script { + chk_haproxy + } +} + +---- + +Replace the following parameters with actual values: + +[%header,cols="1a,2a"] +|=== +|Parameter |Description + +| +|The network interface card (NIC) of the current load balancer. + +| +|The IP address of the current load balancer. + +| +|The IP address of the other load balancer. + +| +|The virtual IP address used as the floating IP address. +|=== +-- + +. Execute the following command to restart Keepalived: ++ +-- +// Bash +[,bash] +---- + +systemctl restart keepalived + +---- +-- + +. Execute the following command to set Keepalived to run automatically on startup: ++ +-- +// Bash +[,bash] +---- + +systemctl enable keepalived + +---- +-- + +. Repeat the above steps to install and configure HAProxy and Keepalived on the other load balancer server. + +. Record the floating IP address for future use during the installation of {ks_product-en}. + + +=== Verify High Availability + +. Log in to the first load balancer server and execute the following command to check the floating IP address: ++ +-- +// Bash +[,bash] +---- + +ip a s + +---- + +If the system's high availability is functioning properly, the configured floating IP address will be displayed in the command output. For example, in the following command output, **inet 172.16.0.10/24 scope global secondary eth0** indicates that the floating IP address is bound to the eth0 network interface: + +// Bash +[,bash] +---- + +1: lo: mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000 + link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00 + inet 127.0.0.1/8 scope host lo + valid_lft forever preferred_lft forever + inet6 ::1/128 scope host + valid_lft forever preferred_lft forever +2: eth0: mtu 1500 qdisc mq state UP group default qlen 1000 + link/ether 52:54:9e:27:38:c8 brd ff:ff:ff:ff:ff:ff + inet 172.16.0.2/24 brd 172.16.0.255 scope global noprefixroute dynamic eth0 + valid_lft 73334sec preferred_lft 73334sec + inet 172.16.0.10/24 scope global secondary eth0 + valid_lft forever preferred_lft forever + inet6 fe80::510e:f96:98b2:af40/64 scope link noprefixroute + valid_lft forever preferred_lft forever +---- +-- + +. Execute the following command to simulate a failure on the current load balancer server: ++ +-- +// Bash +[,bash] +---- + +systemctl stop haproxy + +---- +-- + +. Execute the following command again to check the floating IP address: ++ +-- +// Bash +[,bash] +---- + +ip a s + +---- + +If the system's high availability is functioning properly, the command output will no longer display the floating IP address, as shown in the following command output: + +// Bash +[,bash] +---- + +1: lo: mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000 + link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00 + inet 127.0.0.1/8 scope host lo + valid_lft forever preferred_lft forever + inet6 ::1/128 scope host + valid_lft forever preferred_lft forever +2: eth0: mtu 1500 qdisc mq state UP group default qlen 1000 + link/ether 52:54:9e:27:38:c8 brd ff:ff:ff:ff:ff:ff + inet 172.16.0.2/24 brd 172.16.0.255 scope global noprefixroute dynamic eth0 + valid_lft 72802sec preferred_lft 72802sec + inet6 fe80::510e:f96:98b2:af40/64 scope link noprefixroute + valid_lft forever preferred_lft forever + +---- +-- + +. Log in to the other load balancer server and execute the following command to view the floating IP address: ++ +-- +// Bash +[,bash] +---- + +ip a s + +---- + +If the system's high availability is functioning properly, the configured floating IP address will be displayed in the command output. For example, in the following command output, **inet 172.16.0.10/24 scope global secondary eth0** indicates that the floating IP address is bound to the eth0 network interface: + +// Bash +[,bash] +---- + +1: lo: mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000 + link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00 + inet 127.0.0.1/8 scope host lo + valid_lft forever preferred_lft forever + inet6 ::1/128 scope host + valid_lft forever preferred_lft forever +2: eth0: mtu 1500 qdisc mq state UP group default qlen 1000 + link/ether 52:54:9e:3f:51:ba brd ff:ff:ff:ff:ff:ff + inet 172.16.0.3/24 brd 172.16.0.255 scope global noprefixroute dynamic eth0 + valid_lft 72690sec preferred_lft 72690sec + inet 172.16.0.10/24 scope global secondary eth0 + valid_lft forever preferred_lft forever + inet6 fe80::f67c:bd4f:d6d5:1d9b/64 scope link noprefixroute + valid_lft forever preferred_lft forever + +---- +-- + +. Execute the following command on the first load balancer server to restore the running of HAProxy: ++ +-- +// Bash +[,bash] +---- + +systemctl start haproxy + +---- +-- diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/01-configure-storage-devices-on-cloud.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/01-configure-storage-devices-on-cloud.adoc new file mode 100644 index 000000000..549d99dd5 --- /dev/null +++ b/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/01-configure-storage-devices-on-cloud.adoc @@ -0,0 +1,91 @@ +--- +title: "Configure Cloud Storage Devices" +linkTitle: "Configure Cloud Storage Devices" +keywords: "Kubernetes, KubeSphere, Installation, Preparation, Persistent Storage, Cloud Storage Devices" +description: "Learn how to configure cloud storage devices for the KubeSphere cluster in a production environment." +weight: 01 +--- + +This section provides instructions on how to configure cloud storage devices for KubeSphere in a production environment. + +To configure cloud storage devices, create an API key in the cloud environment and set up KubeSphere using the API key to integrate with the cloud environment through the Container Storage Interface (CSI). When users create volumes in KubeSphere and mount them to pods, KubeSphere will automatically create storage devices in the cloud environment for pods to use. The following steps outline the specific operations using QingCloud as an example. For instructions related to other cloud environments, please refer to the user guide of the respective cloud environment or contact your cloud service provider. + +== Prerequisites + +Get a QingCloud account and ensure that your account balance is sufficient to create the required storage devices. For more information, visit link:https://www.qingcloud.com/[QingCloud Official Website]. + + +== Steps + +. Log in to the link:https://www.qingcloud.com/[QingCloud] console and click your username in the upper-right corner of the page. Select API Keys from the dropdown list. + +. On the **API Keys** page, click **Create**. + +. In the **Create API Key** dialog, set the name for the key, and click **Submit**. + +. Download the key file to your local machine from the popup dialog. ++ +-- +// Warning +include::../../../../../_ks_components-en/admonitions/warning.adoc[] + +KubeSphere will use this private key to connect with the storage devices in the cloud. Please keep this private key file securely to prevent any leakage of user data. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- + +. Obtain the ID of the API key from the API key list. + +. Log in to the cluster node used for KubeSphere installation and execute the following command to create the storage plugin configuration file: ++ +-- +// Bash +[,bash] +---- + +vi csi-qingcloud.yaml + +---- +-- + +. Add the following information to the configuration file and save it for future use during KubeSphere installation: ++ +-- +// YAML +include::../../../../../_ks_components-en/code/yaml.adoc[] + +config: + qy_access_key_id: "" + qy_secret_access_key: "" + zone: "" +sc: + isDefaultClass: true + +---- + +Replace the following parameters with actual values: + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +| +|The ID of the API key. + +| +|The key text of the API key. + +| +|The availability zone ID of the cloud environment. The zone ID determines the region where the storage devices created by KubeSphere will be located. The ID-value mapping for the availability zones is as follows: + +* **sh1a/sh1b**: Shanghai Zone 1-A/Shanghai Zone 1-B + +* **pek3a/pek3b/pek3c/pek3d**: Beijing Zone 3-A/Beijing Zone 3-B/Beijing Zone 3-C/Beijing Zone 3-D + +* **gd2a/gd2b**: Guangdong Zone 2-A/Guangdong Zone 2-B + +* **ap2a**: Asia Pacific Zone 2-A +|=== + +The above configuration file includes only the necessary parameters to be set. For other parameters, please refer to link:https://github.com/kubesphere/helm-charts/tree/master/src/test/csi-qingcloud#configuration[QingCloud CSI Configuration]. +-- diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/04-configure-neosan-csi.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/04-configure-neosan-csi.adoc new file mode 100644 index 000000000..b0c7cf05f --- /dev/null +++ b/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/04-configure-neosan-csi.adoc @@ -0,0 +1,351 @@ +--- +title: "Configure NeonSAN CSI" +linkTitle: "Configure NeonSAN CSI" +keywords: "Kubernetes, KubeSphere, Installation, Preparation, Persistent Storage, Network File System, NeonSAN CSI" +description: "Learn how to configure NeonSAN CSI for the KubeSphere cluster in a production environment." +weight: 04 +--- + + +NeonSAN is an enterprise-grade distributed block storage system developed by QingCloud. NeonSAN CSI is a storage plugin provided by the NeonSAN team for Kubernetes, which enables dynamic provisioning of persistent storage volumes on the Kubernetes platform. + +This section explains how to configure NeonSAN CSI for KubeSphere +clusters in a production environment. + + +== Prerequisites + +- NeonSAN v2.2.0 or above has been successfully deployed, and each node in the container cluster is connected to NeonSAN by the installed QBD. For specific operations, please consult KubeSphere technical support. +- Kubernetes v1.16 or above has been installed. +- Helm has been installed on the master node of the container cluster. Helm 3 is used as an example in this section. + + +== Steps + +=== Online Installation of NeonSAN CSI + +Online installation is applicable to container cluster that has access to the Internet. + +. Execute the following command to add the Helm repository, such as https://charts.kubesphere.io/test. ++ +-- +// Bash +[,bash] +---- + +$ helm repo add ks-test https://charts.kubesphere.io/test +"ks-test" has been added to your repositories + +---- +-- + +. Execute the following command to check if the repository has been added successfully. ++ +-- +// Bash +[,bash] +---- + +$ helm repo list +NAME URL +ks-test https://charts.kubesphere.io/test + +---- +-- + +. Execute the following command to update the repository's chart list. ++ +-- +// Bash +[,bash] +---- + +$ helm repo update + +---- +-- + +. Execute the following command to search for the installation package of NeonSAN CSI in the repository. ++ +-- +// Bash +[,bash] +---- + +$ helm search repo neonsan +NAME CHART VERSION APP VERSION DESCRIPTION +ks-test/csi-neonsan 1.2.2 1.2.0 A Helm chart for NeonSAN CSI Driver + +---- +-- + +. Check the version of qbd installed on the master node. ++ +-- +// Bash +[,bash] +---- + +$ qbd -v +Package Version: 2.2.0-336092c-202202101432-ubuntu2004 +Loaded Module Version: 2.2.0-336092c-202209010306-testlangchaor01n01 +NeonSAN Static Library Version: 3.0.0-092498bf +NeonSAN Protocol Version: 1 + +---- +-- + +. Execute the following command to install NeonSAN CSI. Set the parameter **driver.repository** based on the qbd version installed on the master node. For example, if the qbd version is 2.2.0, the parameter in the command should be **driver.repository="csiplugin/csi-neonsan-qbd2.2.0"**. ++ +-- +// Bash +[,bash] +---- + +$ helm install csi-neonsan ks-test/csi-neonsan --namespace kube-system --set driver.tag="v1.2.3" --set sc.rep_count=2 --set driver.repository="csiplugin/csi-neonsan-qbd2.2.0" +NAME: csi-neonsan +LAST DEPLOYED: Fri Nov 20 10:28:32 2020 +NAMESPACE: kube-system +STATUS: deployed +REVISION: 1 +TEST SUITE: None + +---- +-- + +. Execute the following command to check if NeonSAN CSI is installed successfully. ++ +-- +// Bash +[,bash] +---- + +$ helm list -n kube-system +NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION +csi-neonsan kube-system 1 2020-11-20 10:28:32.240990384 +0800 CST deployed csi-neonsan-1.2.2 1.2.0 + +---- +-- + +. Check if the pod is in Running state. ++ +-- +// Bash +[,bash] +---- + +$ kubectl get pod -n kube-system | grep csi-neonsan + kube-system csi-neonsan-controller-75dc5cbcff-6gk54 5/5 Running 0 38s + kube-system csi-neonsan-node-8vd8l 2/2 Running 0 38s + kube-system csi-neonsan-node-dxk2z 2/2 Running 0 38s + kube-system csi-neonsan-node-mp2b2 2/2 Running 0 38s + +---- +-- + +. Check if all NeonSAN CSI components are running normally. ++ +==== +* When **READY** equals **AVAILABLE**, the csi-neonsan-controller is normal. ++ +-- +// Bash +[,bash] +---- + +$ kubectl -n kube-system get deployments.apps csi-neonsan-controller +NAME READY UP-TO-DATE AVAILABLE AGE +csi-neonsan-controller 1/1 1 1 66m + +---- +-- + +* When **DESIRED** equals **READY** and **AVAILABLE**, the csi-neonsan-node is normal. ++ +-- +// Bash +[,bash] +---- + +$ kubectl -n kube-system get daemonsets.apps csi-neonsan-node +NAME DESIRED CURRENT READY UP-TO-DATE AVAILABLE NODE SELECTOR AGE + csi-neonsan-node 3 3 3 3 3 66m + +---- +-- +==== + +. Check if the storage class is installed. ++ +-- +// Bash +[,bash] +---- + +$ kubectl get storageclass +NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE +csi-neonsan neonsan.csi.qingstor.com Delete Immediate true 2m56s + +---- +-- + +. View the storage pool used by the storage class. This storage pool must exist in NeonSAN, otherwise you cannot create storage volumes using this storage class. ++ +-- +// Bash +[,bash] +---- + +$ kubectl get storageclass csi-neonsan -o yaml | grep pool_name +pool_name: kube + +---- +-- + +. Log in to the NeonSAN server and check if the storage pool used by the storage class exists. If not, create the storage pool using the **neonsan create_pool** command. ++ +-- +// Bash +[,bash] +---- + +$ neonsan list_pool -pool kube -detail +Pool Count: 1 ++----------+------+---------------------------+ +| ID | NAME | CREATED TIME | ++----------+------+---------------------------+ +| 33554432 | kube | 2020-08-07T14:53:52+08:00 | ++----------+------+---------------------------+ + +---- +-- + + +=== Offline Installation of NeonSAN CSI + +Offline installation is applicable to container clusters that cannot access the Internet. + +. On your local machine, download the NeonSAN CSI installation package and copy the package to the cluster Master node. + ++ +-- +// Bash +[,bash] +---- + +$ helm repo add ks-test https://charts.kubesphere.io/test +"ks-test" has been added to your repositories +$ helm pull ks-test/csi-neonsan +$ ls -l csi-neonsan*.tgz +-rw-r--r--. 1 root root 5196 Nov 20 13:13 csi-neonsan-1.2.2.tgz + +---- +-- + +. Execute the following command to view all image files required by NeonSAN CSI. ++ +-- +// Bash +[,bash] +---- + +$ helm show values ks-test/csi-neonsan +driver: + repository: csiplugin/csi-neonsan + tag: v1.2.0 + node: + repository: csiplugin/csi-neonsan-ubuntu + tag: v1.2.0 +provisioner: + repository: csiplugin/csi-provisioner + tag: v1.5.0 + volumeNamePrefix: pvc +attacher: + repository: csiplugin/csi-attacher + tag: v2.1.1 +resizer: + repository: csiplugin/csi-resizer + tag: v0.4.0 +snapshotter: + repository: csiplugin/csi-snapshotter + tag: v2.0.1 +registrar: + repository: csiplugin/csi-node-driver-registrar + tag: v1.2.0 + +---- +-- + +. Use Docker to download all images locally and package them, or upload them to an internal repository (such as harbor). ++ +-- +// Bash +[,bash] +---- + +docker pull csiplugin/csi-neonsan:v1.2.0 +docker pull csiplugin/csi-neonsan-ubuntu:v1.2.0 +docker pull csiplugin/csi-provisioner:v1.5.0 +docker pull csiplugin/csi-attacher:v2.1.1 +docker pull csiplugin/csi-resizer:v0.4.0 +docker pull csiplugin/csi-snapshotter:v2.0.1 +docker pull csiplugin/csi-node-driver-registrar:v1.2.0 + +---- +-- ++ +-- +// Bash +[,bash] +---- + +docker save csiplugin/csi-neonsan:v1.2.0 \ + csiplugin/csi-neonsan-ubuntu:v1.2.0 \ + csiplugin/csi-provisioner:v1.5.0 \ + csiplugin/csi-attacher:v2.1.1 \ + csiplugin/csi-resizer:v0.4.0 \ + csiplugin/csi-snapshotter:v2.0.1 \ + csiplugin/csi-node-driver-registrar:v1.2.0 \ + -o neonsan-csi-images.tar + +---- +-- + +. Execute the following commands to upload the image package to a directory on all nodes in the cluster, such as the **/tmp** directory, extract it, and install it. ++ +-- +// Bash +[,bash] +---- + +$ scp neonsan-csi-images.tar user@node1:/tmp/ +scp neonsan-csi-images.tar user@node2:/tmp/ +... +---- + +// Bash +[,bash] +---- + +$ tar -xvf /tmp/neonsan-csi-images.tar -C / + +---- +-- + +. Execute the following commands to check if the installation is complete. If you see all the NeonSAN CSI images in the list, the installation is successful. ++ +-- +// Bash +[,bash] +---- + +$ docker images + +---- +-- + +. Refer to the steps 8 - 12 of link:#_online_installation_of_neonsan_csi[online installation] for post-installation checks. ++ +-- +After successfully installing NeonSAN CSI, you can view it in the **Storage** section on the KubeSphere web console. +-- diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/05-configure-nfs.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/05-configure-nfs.adoc new file mode 100644 index 000000000..2b8d29ad7 --- /dev/null +++ b/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/05-configure-nfs.adoc @@ -0,0 +1,218 @@ +--- +title: "Configure NFS" +linkTitle: "Configure NFS" +keywords: "Kubernetes, KubeSphere, Installation, Preparation, Persistent Storage, Network File System, NFS" +description: "Learn how to configure Network File System (NFS) for the KubeSphere cluster in a production environment." +weight: 05 +--- + +This section describes how to configure Network File System (NFS) for the KubeSphere cluster in a production environment. + +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +NFS is incompatible with some applications (such as Prometheus), which may cause pod creation failure. If you do need to use NFS in a production environment, make sure you understand the risks or consult KubeSphere technical support at support@kubesphere.cloud. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] + +== Build NFS Server + +Before configuring NFS for KubeSphere, you need to set up an NFS server first. If you already have an NFS server available, you can skip this step. The following uses the Ubuntu operating system and NFS Kernel Server as an example to introduce how to build an NFS server. For specific operations on other NFS servers and other operating systems, see the user guides for the NFS servers and operating systems. + + +=== Prerequisites + +You need to prepare a Linux server (the Ubuntu operating system is used as an example below), which must be connected to the KubeSphere cluster node network. + + +=== Steps + +. Log in to the server used to build the NFS server and execute the following command to install the NFS Kernel Server: ++ +-- +//Bash +[,bash] +---- + +sudo apt update + +---- + +//Bash +[,bash] +---- + +sudo apt install nfs-kernel-server + +---- +-- + +. Execute the following command to create a directory for use by KubeSphere (replace with the actual directory path, such as **/mnt/demo**): ++ +-- +// Bash +[,bash] +---- + +sudo mkdir -p + +---- +-- + +. Execute the following command to remove access restrictions on the directory (replace with the actual directory path, such as **/mnt/demo**): ++ +-- +//Bash +[,bash] +---- + +sudo chown nobody:nogroup + +---- + +// Bash +[,bash] +---- + +sudo chmod 777 + +---- +-- + +. Execute the following command to edit the configuration file of NFS Kernel Server: ++ +-- +// Bash +[,bash] +---- + +sudo vi /etc/exports + +---- +-- + +. Add the KubeSphere cluster node information to the file to allow the server to access the NFS server, and save the file: ++ +-- +// Bash +[,bash] +---- + + (rw,sync,no_subtree_check) + +---- + +Replace the following parameters with actual values: + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +| +|The directory used by KubeSphere, for example **/mnt/demo**. + +| +|The IP address of the KubeSphere cluster node, for example 192.168.0.2. +|=== + +If there are multiple KubeSphere cluster nodes, please set multiple configuration entries. You can also set to a network segment so that all servers in the network segment can access the NFS server, for example **192.168.0.0/24**. +-- + +. Execute the following command to enable directory sharing: ++ +-- +// Bash +[,bash] +---- + +sudo exportfs -a + +---- +-- + +. Execute the following command to restart the NFS server to make the configuration take effect: ++ +-- +// Bash +[,bash] +---- + +sudo systemctl restart nfs-kernel-server + +---- +-- + +== Configure Cluster Nodes + +After the NFS server is built, you need to install the client tool on the KubeSphere cluster nodes and create a configuration file for subsequent installation of KubeSphere. After KubeSphere is installed, the NFS server specified in the configuration file will be used as persistent storage. The following uses the Ubuntu operating system to install NFS Common as an example to introduce how to install the NFS client and create a configuration file. For specific operations on other NFS clients and other operating systems, see the user guides for the NFS clients and operating systems. + + +=== Prerequisites + +You should set up an NFS server. For more information, see link:#_build_nfs_server[Build NFS Server]. + + +=== Steps + +. Log in to all KubeSphere cluster nodes and execute the following command to install nfs-common: ++ +-- +//Bash +[,bash] +---- + +sudo apt update + +---- + +// Bash +[,bash] +---- + +sudo apt install nfs-common + +---- +-- + +. Log in to the cluster node used to perform the KubeSphere installation and execute the following command to create the configuration file for NFS storage plugin: ++ +-- +// Note +// Bash +[,bash] +---- + +vi nfs-client.yaml + +---- +-- + +. Add the following information to the configuration file and save the file for subsequent installation of KubeSphere: ++ +-- +// YAML +include::../../../../../_ks_components-en/code/yaml.adoc[] + +nfs: + server: "" + path: "" +storageClass: + defaultClass: true + +---- + +Replace the following parameters with actual values: + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +| +|IP address of the NFS server. + +| +|The directory of NFS server used by KubeSphere. +|=== + +The above configuration file only contains the parameters that must be set. To set other parameters, see link:https://github.com/kubesphere/helm-charts/blob/master/src/main/nfs-client-provisioner/values.yaml[NFS Client Configuration]. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/_index.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/_index.adoc new file mode 100644 index 000000000..44e1a5a9c --- /dev/null +++ b/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/_index.adoc @@ -0,0 +1,17 @@ +--- +title: "Configure External Persistent Storage" +linkTitle: "Configure External Persistent Storage" +keywords: "Kubernetes, KubeSphere, Installation, Preparation, Persistent Storage" +description: "Learn how to configure an external persistent storage system for the KubeSphere cluster in a production environment." +layout: "second" +weight: 04 +--- + +This section explains how to configure an external persistent storage system for the KubeSphere cluster in a production environment. A persistent storage system is used to create volumes for storing application data in KubeSphere. If an external persistent storage system is not configured, KubeSphere will default to using the local storage system of the cluster nodes. If your KubeSphere cluster does not require external persistent storage, you can skip this section. + +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +The configuration of external persistent storage for KubeSphere is only supported in scenarios where Kubernetes and KubeSphere are installed together. If you install KubeSphere on an existing Kubernetes cluster, KubeSphere will use the existing persistent storage configuration of the Kubernetes cluster. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/_index.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/_index.adoc new file mode 100644 index 000000000..024cacf20 --- /dev/null +++ b/content/en/docs/v4.1/03-installation-and-upgrade/01-preparations/_index.adoc @@ -0,0 +1,11 @@ +--- +title: "Preparation" +linkTitle: "Preparation" +keywords: "Kubernetes, KubeSphere, installation, preparation" +description: "This section describes the preparation work required before installing KubeSphere." +layout: "second" +weight: 01 +--- + + +This section describes the preparation work required before installing {ks_product-en}. diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc new file mode 100644 index 000000000..06b2e28ab --- /dev/null +++ b/content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc @@ -0,0 +1,435 @@ +--- +title: "Install Kubernetes and KubeSphere on Linux" +linkTitle: "Install Kubernetes and KubeSphere on Linux" +keywords: "Kubernetes, KubeSphere, Installation, Install KubeSphere, Install Kubernetes" +description: "Get how to install Kubernetes and KubeSphere." +weight: 02 +--- + +This section explains how to install Kubernetes and {ks_product-en}. + +The installation process will use the open-source tool KubeKey. For more information about KubeKey, please visit the link:https://github.com/kubesphere/kubekey[GitHub KubeKey repository]. + +[.admon.note,cols="a"] +|=== +|Note + +|You can also run the command in the link:#_install_kubesphere[Install KubeSphere] section to directly upgrade KubeSphere from v4.1.1 to v4.1.2. +|=== + +== Prerequisites + +* Prepare at least 1 Linux server as a cluster node. In a production environment, to ensure high availability of the cluster, it is recommended to prepare at least 5 Linux servers, with 3 servers as control plane nodes and 2 servers as worker nodes. If you are installing {ks_product-en} on multiple Linux servers, make sure all servers belong to the same subnet. + +* The operating system and version of the cluster nodes must be 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, or openSUSE Leap 15. The operating systems of multiple servers can be different. For support of other operating systems and versions, please contact {ks_product-en} technical support. + +* In a production environment, to ensure the cluster has sufficient computing and storage resources, it is recommended that each cluster node be configured with at least 8 CPU cores, 16 GB of memory, and 200 GB of disk space. In addition, it is recommended to mount an additional 200 GB of disk space in the **/var/lib/docker** (for Docker) or **/var/lib/containerd** (for containerd) directory of each cluster node for storing container runtime data. + +* In a production environment, it is recommended to configure high availability for the KubeSphere cluster in advance to avoid service interruption in the event of a single control plane node failure. For more information, please refer to the link:../../../03-installation-and-upgrade/01-preparations/03-configure-high-availability/[Configure High Availability]. ++ +-- +// Note +include::../../../../_ks_components-en/admonitions/note.adoc[] + +If you plan to have multiple control plane nodes, be sure to configure high availability for the cluster in advance. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- + +* By default, KubeSphere uses the local disk space of the cluster nodes as persistent storage. In a production environment, it is recommended to configure an external storage system as persistent storage in advance. For more information, please refer to the link:../../../03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/[Configure External Persistent Storage]. + +* If the cluster nodes do not have a container runtime installed, the installation tool KubeKey will automatically install Docker as the container runtime for each cluster node during the installation process. You can also manually install containerd, CRI-O, or iSula as the container runtime in advance. ++ +-- +// Note +include::../../../../_ks_components-en/admonitions/note.adoc[] + +CRI-O and iSula have not been fully tested for compatibility with KubeSphere, and there may be unknown issues. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- + +* Make sure the DNS server addresses configured in the **/etc/resolv.conf** file on all cluster nodes are available. Otherwise, the KubeSphere cluster may encounter domain name resolution issues. + +* Make sure you can use the **sudo**, **curl**, and **openssl** commands on all cluster nodes. + +* Make sure the time is synchronized on all cluster nodes. + + +== Configure Firewall Rules + +KubeSphere requires specific ports and protocols for communication between services. If your infrastructure environment has enabled a firewall, you need to open the required ports and protocols in the firewall settings. If your infrastructure environment does not have a firewall enabled, you can skip this step. + +The following table lists the ports and protocols that need to be opened in the firewall. + +[%header,cols="1a,1a,1a,1a,2a"] +|=== +|Service |Protocol |Start Port |End Port |Remarks + +|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 +| +|Required for offline environments + +|local-apt +|TCP +|5080 +| +|Required for offline environments + +|rpcbind +|TCP +|111 +| +|Required when using NFS as persistent storage + +|ipip +|IPENCAP/IPIP +| +| +|Required when using Calico +|=== + +== Install Dependencies + +You need to install socat, conntrack, ebtables, and ipset for all cluster nodes. If the above dependencies already exist on each cluster node, you can skip this step. + +On Ubuntu systems, run the following command to install the dependencies on the servers: + +// Bash +[,bash] +---- +sudo apt install socat conntrack ebtables ipset -y +---- + +If the cluster nodes use other operating systems, replace **apt** with the corresponding package management tool for the operating system. + +== Install Kubernetes + +// ifeval::["{file_output_type}" == "pdf"] +// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[] +// endif::[] + +// ifeval::["{file_output_type}" == "html"] +include::../../../_custom-en/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[] +// endif::[] + +. Create the installation configuration file **config-sample.yaml**: ++ +-- +//Bash +[,bash] +---- + ./kk create config --with-kubernetes +---- + +Replace `` with the actual version needed, for example **v1.27.4**. {ks_product-en} by default supports Kubernetes v1.21~1.28. + +After the command completes, the installation configuration file **config-sample.yaml** will be generated. + +include::../../../_custom-en/installationAndUpgrade/installationAndUpgrade-note-doNotDeleteConfig_v4.adoc[] +-- + +. Edit **config-sample.yaml**： ++ +-- +//Bash +[,bash] +---- +vi config-sample.yaml +---- + +The following is a part of the configuration file sample. For a complete example, please refer to link:https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md[this file]. + +// YAML +include::../../../../_ks_components-en/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} # For arm64 nodes, please add the parameter arch: arm64 + - {name: controlplane2, address: 192.168.0.3, internalAddress: 192.168.0.3, user: ubuntu, privateKeyPath: "~/.ssh/id_rsa"} + - {name: worker1, address: 192.168.0.4, internalAddress: 192.168.0.4, user: ubuntu, password: Testing123} + - {name: worker2, address: 192.168.0.5, internalAddress: 192.168.0.5, user: ubuntu, password: Testing123} + - {name: registry, address: 192.168.0.6, internalAddress: 192.168.0.6, user: ubuntu, password: Testing123} + roleGroups: + etcd: + - controlplane1 + - controlplane2 + control-plane: + - controlplane1 + - controlplane2 + worker: + - worker1 + - worker2 + # If you want to use kk to automatically deploy the image registry, please set up the registry (it is recommended that the image registry and cluster nodes be deployed separately to reduce mutual influence) + registry: + -registry + controlPlaneEndpoint: + internalLoadbalancer: haproxy # If you need to deploy a high availability cluster and no load balancer is available, you can enable this parameter to perform load balancing within the cluster. + domain: lb.kubesphere.local + address: "" + port: 6443 + kubernetes: + version: v1.23.15 + clusterName: cluster.local + network: + plugin: calico + kubePodsCIDR: 10.233.64.0/18 + kubeServiceCIDR: 10.233.0.0/18 + ## multus support. https://github.com/k8snetworkplumbingwg/multus-cni + enableMultusCNI: false + registry: + # If you want to use kk to deploy harbor, you can set this parameter to harbor. If you do not set this parameter and you need to use kk to deploy the image registry, docker registry will be deployed by default. + # Harbor does not support arm64. This parameter does not need to be configured when deploying in an arm64 environment. + type: harbor + # If you use kk to deploy harbor or other registries that require authentication, you need to set the auths of the corresponding registries. If you use kk to deploy the default docker registry, you do not need to configure the auths parameter. + # Note: If you use kk to deploy harbor, please set the auths parameter after creating the harbor project. + auths: + "dockerhub.kubekey.local": + username: admin # harbor default username + password: Harbor12345 # harbor default password + plainHTTP: false # If the registry uses http, please set this parameter to true + privateRegistry: "dockerhub.kubekey.local/kse" #Set the private registry address used during cluster deployment + registryMirrors: [] + insecureRegistries: [] + addons: [] +---- +-- + +. Set the information of each server under the **spec:hosts** parameter in **config-sample.yaml**. ++ +-- +include::../../../_custom-en/installationAndUpgrade/installationAndUpgrade-para-hosts.adoc[] +-- + +. Set the server's role under the **spec:roleGroups** parameter in **config-sample.yaml**. ++ +-- +include::../../../_custom-en/installationAndUpgrade/installationAndUpgrade-para-roleGroups.adoc[] +-- + +. If you have multiple control plane nodes, set high availability information under the **spec:controlPlaneEndpoint** parameter in **config-sample.yaml**. ++ +-- +include::../../../_custom-en/installationAndUpgrade/installationAndUpgrade-para-controlPlaneEndpoint.adoc[] +-- + +. If you need to use external persistence storage, set the external persistence storage information under the **spec:addons** parameter in **config-sample.yaml**. ++ +==== +* If using a cloud storage device, set the following parameters under **spec:addons** (replace with the actual path of the storage plugin configuration file): ++ +-- +// Bash +[,bash] +---- + - name: csi-qingcloud + namespace: kube-system + sources: + chart: + name: csi-qingcloud + repo: https://charts.kubesphere.io/test + valuesFile: +---- +-- + +* If using NeonSAN storage, set the following parameters under **spec:addons** (replace with the actual path of the storage plugin configuration file): ++ +-- +// Bash +[,bash] +---- + - name: csi-neonsan + namespace: kube-system + sources: + chart: + name: csi-neonsan + repo: https://charts.kubesphere.io/test + valuesFile: +---- +-- + +* If using an NFS storage system, set the following parameters under **spec:addons** (replace with the actual path of the storage plugin configuration file): ++ +-- +// Bash +[,bash] +---- + - name: nfs-client + namespace: kube-system + sources: + chart: + name: nfs-client-provisioner + repo: https://charts.kubesphere.io/main + valuesFile: +---- +-- +==== + +. Create a Kubernetes cluster. ++ +-- +[,bash] +---- + ./kk create cluster -f config-sample.yaml +---- + +// Note +include::../../../../_ks_components-en/admonitions/note.adoc[] + +If you want to use OpenEBS LocalPV, you can add the `--with-local-storage` parameter after the following command. If you want to integrate with other storage solutions, configure the relevant storage plugins under the **spec:addons** parameter in **config-sample.yaml ** or install them after the Kubernetes deployment. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] + + +If you see the following information, it means that the Kubernetes cluster is successfully created. + +[,yaml] +---- +Pipeline[CreateclusterPipeline] execute successfully +---- +-- + +== Install KubeSphere + +KubeSphere Core (ks-core) is the core component of KubeSphere, providing a foundational runtime environment for extensions. Once KubeSphere Core is installed, you can access the {ks_product-en} web console. + +. `Helm` should have been installed in advance. For specific instructions, please refer to link:https://helm.sh/docs/intro/[Helm Installation]. ++ +[,bash] +---- +curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash +---- + +. Run the following command on the cluster node to install KubeSphere Core. ++ +==== +[,bash] +---- +helm upgrade --install -n kubesphere-system --create-namespace ks-core https://charts.kubesphere.io/main/ks-core-1.1.2.tgz --debug --wait +---- + +include::../../../../_ks_components-en/admonitions/note.adoc[] + +If you are accessing Docker Hub from a restricted location, add the following configuration after the above command to modify the default image pull address. + +[,bash] +---- +--set global.imageRegistry=swr.cn-southwest-2.myhuaweicloud.com/ks +---- + +[,bash] +---- +--set extension.imageRegistry=swr.cn-southwest-2.myhuaweicloud.com/ks +---- + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] + +If you see the following information, it means that ks-core installation is successful: + +[,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. +---- +==== + +. From the successful information, retrieve the **Console**, **Account**, and **Password** parameters to obtain the IP address of the {ks_product-en} web console, the admin username, and the admin password. Use a web browser to log in to the {ks_product-en} web console. ++ +[.admon.note,cols="a"] +|=== +|Note + +| +Depending on your hardware and network environment, you may need to configure traffic forwarding rules and open port 30880 in the firewall. +|=== \ No newline at end of file diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/05-appendix.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/05-appendix.adoc new file mode 100644 index 000000000..edae3e23c --- /dev/null +++ b/content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/05-appendix.adoc @@ -0,0 +1,252 @@ +--- +title: "Appendix: Advanced Configuration of KubeSphere Core" +linkTitle: "Appendix: Advanced Configuration of KubeSphere Core" +keywords: "Kubernetes, KubeSphere, KubeSphere Core, Configuration" +description: "Learn about the advanced configuration of KubeSphere Core." +weight: 05 +--- + + +== Helm Chart Options + +=== Common Options + +[%header,cols="1,1,2"] +|=== +|Option | Default Value | Description +|adminPassword | "" | string - Set a bootstrap password for the first admin user. Admins will need to reset the password upon login. If not set, the built-in default password **P@88w0rd** will be used. +|hostname | "example.com" | string - Fully qualified domain name for the KubeSphere Server. +|ingress.enabled | false | bool - If true, create the KubeSphere ingress. +|ingress.tls.enabled | true | bool - If true, enable HTTPS for the KubeSphere ingress. +|ingress.tls.source | "generation" | string - Source of ingress certificate, options: "generation, importation, letsEncrypt". +|letsEncrypt.email | "" | string - Email address to receive expiration reminders for certificates. +|letsEncrypt.environment | "production" | string - Options: "staging, production". There are rate limit differences between certificates for test and production environments, see details in the link:https://letsencrypt.org/docs/[Let’s Encrypt Documentation]. +|=== + +=== Advanced Options + +[%header,cols="1,1,2"] +|=== +|Option | Default Value | Description + +|telemetry.enabled | true | bool - Whether to participate in the improvement program. If set to true, it indicates that KubeSphere is allowed to collect your data. For more information, please refer to link:../../../24-faq/01-info-collection[Improvement Program]. +|internalTLS | false | bool - If true, enables internal TLS. Both console and apiserver will run HTTPS services. +|ingress.ingressClassName | "" | string - Optional ingress class to use for the ingress, options: "nginx, traefik". +|ingress.secretName | "kubesphere-tls-certs" | string - Secrets containing TLS certificates used by the ingress. +|extension.ingress.ingressClassName | "" | ingressClassName for external ingress used by extensions. +|extension.ingress.domainSuffix | "" | Domain suffix for creating entry points for extensions; based on the external ingress address, it can be LB hostname address (e.g., xx.com), {node_ip}.nip.io, or internal DNS address (e.g., kse.local). +|extension.ingress.httpPort | 80 | http port for extension ingress. +|extension.ingress.httpsPort | 443 | https port for extension ingress. +|certmanager.duration | 2160h | string - Expiry time for certificates generated by cert-manager. +|certmanager.renewBefore | 360h | string - Time interval for cert-manager to renew certificates before expiry. +|global.imageRegistry | registry.cn-beijing.aliyuncs.com | string - Set the global KubeSphere image registry address. +|global.tag | "v4.1.1" | string - Set the global KubeSphere image registry tag. +|apiserver.image.registry | "" | string - Set ks-apiserver image registry address. +|apiserver.image.repository | "kse/ks-apiserver" | string - Set ks-apiserver image name. +|apiserver.image.tag | "" | string - Set ks-apiserver image tag. +|apiserver.nodePort | "" | uint16 - Set NodePort port for ks-apiserver service. +|console.image.registry | "" | string - Set ks-console image registry address. +|console.image.repository | "kse/ks-console" | string - Set ks-console image name. +|console.image.tag | "" | string - Set ks-console image tag. +|console.nodePort | 30880 | uint16 - Set NodePort port for ks-console service. +|controller.image.registry | "" | string - Set ks-controller-manager image registry address. +|controller.image.repository | "kse/ks-controller-manager" | string - Set ks-controller-manager image name. +|controller.image.tag | "" | string - Set ks-controller-manager image tag. +|=== + +== TLS Configuration + +. Select SSL Configuration ++ +-- +KubeSphere security configuration includes **Ingress SSL Configuration** and **Internal SSL Configuration**. The **Ingress SSL Configuration** supports three modes by default to enable SSL/TLS for secure access. +-- + +.. Ingress SSL Configuration ++ +-- +[%header,cols="1,2,1"] +|=== +|Configuration | Helm Chart Option | Cert-manager Required + +|KubeSphere Generated TLS Certificates | ingress.tls.source=generation | No +|Let’s Encrypt | ingress.tls.source=letsEncrypt | Yes +|Import Existing Certificates | ingress.tls.source=importation | No +|=== + +* KubeSphere Generated TLS Certificates: Supports both cert-manager and Helm methods. + +** If cert-manager is already installed in the Kubernetes cluster, it is preferred to use cert-manager to generate certificates. KubeSphere uses cert-manager to issue and maintain certificates. KubeSphere generates its CA certificate, signs a certificate using that CA, and then manages the certificate with cert-manager. + +** If cert-manager is not installed, Helm is used to generate certificates. During the installation process with Helm, KubeSphere generates CA and TLS certificates based on the configured `hostname`. In this option, certificates do not support automatic expiration rotation. + +* Let's Encrypt ++ +When using the Let's Encrypt option, cert-manager must be utilized. In this scenario, cert-manager combines with a special issuer for Let's Encrypt that performs all actions (including request and validation) necessary for getting a Let's Encrypt issued cert. This configuration uses HTTP validation (HTTP-01), so the load balancer must have a public DNS record and be accessible from the internet. + +* Import Existing Certificates ++ +This option allows you to bring your own public- or private-CA signed certificate. KubeSphere will use that certificate to secure websocket and HTTPS traffic. In this case, you must upload this certificate (and associated key) as PEM-encoded files with the name `tls.crt` and `tls.key`. If you are using a private CA, you must also upload that certificate. This is due to the fact that this private CA may not be trusted by your nodes. +-- + +.. Internal SSL Configuration ++ +-- +After enabling internal SSL configuration, both Console UI and Apiserver in KubeSphere will use HTTPS. This configuration inherently supports cert-manager and helm generated certificates. When cert-manager is already installed in the Kubernetes cluster, it is preferred to use cert-manager to generate/manage certificates, and the DNS for certificates defaults to Console UI and Apiserver's Service DNS within the Kubernetes cluster. + +[%header,cols="1,1,1"] +|=== +|Configuration |Helm Chart Option |Cert-manager Required +|Enable Internal SSL |internalTLS=true |No +|=== +-- + +. Install cert-manager ++ +-- +If you are using your own certificate files (ingress.tls.source=importation), you can skip this step. + +Only when using KubeSphere-generated certificates (ingress.tls.source=generation) or Let's Encrypt issued certificates (ingress.tls.source=letsEncrypt), you need to install cert-manager. + +[,bash] +---- +# Add Jetstack Helm repository +helm repo add jetstack https://charts.jetstack.io + +# Update local Helm Chart repository cache +helm repo update + +# Install cert-manager Helm Chart +helm install cert-manager jetstack/cert-manager -n cert-manager --create-namespace --set prometheus.enabled=false +# Or +kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download//cert-manager.yaml +---- + +After installing cert-manager, check the running pods in the cert-manager namespace to verify that it has been deployed correctly: + +[,bash] +---- +kubectl get pods --namespace cert-manager +---- +-- + +. Based on your selected certificate option, enable SSL configuration for KubeSphere using Helm. + +.. Enable Ingress SSL Configuration ++ +-- +* KubeSphere Generated Certificates ++ +[,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 ++ +This option uses cert-manager to automatically request and renew Let's Encrypt certificates. Let's Encrypt is free and a trusted CA, so it can provide valid certificates. ++ +[,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 +---- + +* Import External Certificates ++ +[,bash] +---- +# Import external certificates +kubectl create secret tls tls-ks-core-ingress --cert=tls.crt --key=tls.key -n kubesphere-system + +# Install 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 +---- +-- + +.. Enable Internal SSL Configuration. ++ +[,bash] +---- +helm upgrade --install -n kubesphere-system --create-namespace ks-core +$chart --version $version \ +--set internalTLS=true +---- + +== Configure the ratelimit Limiter + +Once the limiter is enabled, it will independently limit requests for all users in KubeSphere, primarily supporting the following two methods: + +* Setting a rate limit for all users in KubeSphere, without support for setting individual rate limits for each user at the moment; +* Setting a rate limit independently for each ServiceAccount in KubeSphere. + +[discrete] +=== Enable the Limiter + +Enabling the limiter means setting a rate limit for all users in KubeSphere. + +. Modify the `kubesphere-system` configmap. ++ +-- +[,bash] +---- +kubectl -n kubesphere-system edit cm kubesphere-system +---- + +Add the following content: + +[,yaml] +---- +rateLimit: + enable: true # Enable the limiter + driver: memory # Memory mode + QPS: 40.0 # Token recovery rate + burst: 80 # Token bucket capacity +---- +-- + +. Restart the ks-apiserver. ++ +[,bash] +---- +kubectl -n kubesphere-system rollout restart deploy ks-apiserver +---- + +[discrete] +=== Set the ServiceAccount Limiter + +Before setting, you need to enable the limiter as in the previous step. Then execute the following command to set the rate limit for 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] +=== Parameter Description + +[%header,cols="1,1,3a"] +|=== +|Option |Default Value |Description +|rateLimit.enable |false |bool - Enable the limiter. +|rateLimit.driver |memory |string - Limiter storage type, options: "memory". +|rateLimit.QPS |5.0 |float32 - Number of tokens recovered per second in the limiter token bucket algorithm. +|rateLimit.burst |10 |int - Maximum capacity of the token bucket in the limiter token bucket algorithm. +|=== + +[.admon.note,cols="a"] +|=== +|Note + +|The recommended QPS for token recovery rate should be half the burst capacity. +|=== + diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/_index.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/_index.adoc new file mode 100644 index 000000000..deed45648 --- /dev/null +++ b/content/en/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Install KubeSphere" +linkTitle: "Install KubeSphere" +keywords: "Kubernetes, KubeSphere, installation" +description: "Introduce how to install KubeSphere." +layout: "second" +weight: 02 +--- + +This section introduces how to install Kubernetes and {ks_product-en}. diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/01-uninstall-kubesphere-only.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/01-uninstall-kubesphere-only.adoc new file mode 100644 index 000000000..afc810de7 --- /dev/null +++ b/content/en/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/01-uninstall-kubesphere-only.adoc @@ -0,0 +1,33 @@ +--- +title: "Uninstall KubeSphere Only" +linkTitle: "Uninstall KubeSphere Only" +keywords: "Kubernetes, KubeSphere, Uninstall KubeSphere Only" +description: "This section explains how to uninstall KubeSphere." +weight: 01 +--- + +This section explains how to uninstall {ks_product-en}. The Kubernetes running in the current cluster will not be uninstalled. + +// Warning +include::../../../../_ks_components-en/admonitions/warning.adoc[] + +* Although Kubernetes will not be uninstalled, the uninstallation may still cause service interruption if the business running in the current cluster relies on the functionalities provided by KubeSphere. + +* The uninstallation is irreversible. Please proceed with caution. + + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] + + +== Prerequisites + +include::../../../_custom-en/installationAndUpgrade/installationAndUpgrade-prer-backUpData.adoc[] + +== Steps + +Run the following command to uninstall {ks_product-en}. + +[,bash] +---- +helm -n kubesphere-system uninstall ks-core +---- diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/02-uninstall-kubernetes-and-kubesphere.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/02-uninstall-kubernetes-and-kubesphere.adoc new file mode 100644 index 000000000..5a5d78060 --- /dev/null +++ b/content/en/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/02-uninstall-kubernetes-and-kubesphere.adoc @@ -0,0 +1,74 @@ +--- +title: "Uninstall Kubernetes and KubeSphere" +linkTitle: "Uninstall Kubernetes and KubeSphere" +keywords: "Kubernetes, KubeSphere, Uninstall Kubernetes and KubeSphere" +description: "Learn how to uninstall Kubernetes and KubeSphere." +weight: 02 +--- + + +This section explains how to uninstall Kubernetes and {ks_product-en}. + +// Note +include::../../../../_ks_components-en/admonitions/note.adoc[] + +The uninstallation method for Kubernetes described in this section only applies to Kubernetes installed using KubeKey. If your Kubernetes is not installed through KubeKey, please refer to the link:https://kubernetes.io/zh/docs/reference/setup-tools/kubeadm/kubeadm-reset/[Kubernetes Documentation] for uninstallation instructions. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] + +// Warning +include::../../../../_ks_components-en/admonitions/warning.adoc[] + +The uninstallation will cause business interruption to the KubeSphere cluster and cannot be undone. Please proceed with caution. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] + + +== Prerequisites + +* You should get the installation configuration file **config-sample.yaml** and transfer it to the cluster nodes where you will perform the uninstallation. For more information, refer to link:../../../03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere[Install Kubernetes and {ks_product-en}]. ++ +[.admon.note,cols="a"] +|=== +|Note + +| +If you are unable to get the installation configuration file **config-sample.yaml**, you need to refer to link:../../../03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere[Install Kubernetes and {ks_product-en}] to recreate the **config-sample.yaml** file. When recreating the file, make sure that the cluster information in the file matches the current state of the cluster. Otherwise, the uninstallation process may encounter errors. +|=== + +* {empty} +include::../../../_custom-en/installationAndUpgrade/installationAndUpgrade-prer-backUpData.adoc[] + + +== Steps + +// ifeval::["{file_output_type}" == "pdf"] +// include::../../../_custom-en/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[] +// endif::[] + +// ifeval::["{file_output_type}" == "html"] +include::../../../_custom-en/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[] +// endif::[] + ++ +include::../../../_custom-en/installationAndUpgrade/installationAndUpgrade-oper-transferConfig.adoc[] + ++ + +. Run the following command to uninstall {ks_product-en}. ++ +-- +// Bash +[,bash] +---- +./kk delete cluster -f config-sample.yaml +---- + +If you see the following message, it means the uninstallation is successful: + +// Bash +[,bash] +---- +Pipeline[DeleteClusterPipeline] execute successful +---- +-- diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/_index.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/_index.adoc new file mode 100644 index 000000000..a4b8e5a78 --- /dev/null +++ b/content/en/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/_index.adoc @@ -0,0 +1,11 @@ +--- +title: "Uninstall KubeSphere" +linkTitle: "Uninstall KubeSphere" +keywords: "Kubernetes, KubeSphere, Uninstall" +description: "Instructions on how to uninstall KubeSphere." +layout: "second" +weight: 04 +--- + + +This section explains how to uninstall {ks_product-en}. \ No newline at end of file diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/01-add-cluster-nodes.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/01-add-cluster-nodes.adoc new file mode 100644 index 000000000..f03164071 --- /dev/null +++ b/content/en/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/01-add-cluster-nodes.adoc @@ -0,0 +1,130 @@ +--- +title: "Add Cluster Nodes" +linkTitle: "Add Cluster Nodes" +keywords: "Kubernetes, KubeSphere, add cluster nodes" +description: "Introduce how to add KubeSphere cluster nodes." +weight: 01 +--- + + +This section describes how to add KubeSphere cluster nodes. + +The open-source tool KubeKey will be used during the process. For more information about KubeKey, please visit link:https://github.com/kubesphere/kubekey[GitHub KubeKey repository]. + +// Note +include::../../../../_ks_components-en/admonitions/note.adoc[] + +The node addition method described in this section is only applicable to Kubernetes installed through KubeKey. If your Kubernetes is not installed via KubeKey, please refer to link:https://kubernetes.io/zh/docs/concepts/architecture/nodes/[Kubernetes Documentation] to add nodes. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] + +== Prerequisites + +* The operating system and version of the cluster nodes must be 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, or openSUSE Leap 15. The operating systems of multiple servers can be different. For support of other operating systems and versions, please contact {ks_product-en} technical support. + +* In a production environment, to ensure the cluster has sufficient computing and storage resources, it is recommended that each cluster node be configured with at least 8 CPU cores, 16 GB of memory, and 200 GB of disk space. In addition, it is recommended to mount an additional 200 GB of disk space in the **/var/lib/docker** (for Docker) or **/var/lib/containerd** (for containerd) directory of each cluster node for storing container runtime data. + +* In a production environment, it is recommended to configure high availability for the KubeSphere cluster in advance to avoid service interruption in the event of a single control plane node failure. For more information, please refer to the link:../../../03-installation-and-upgrade/01-preparations/03-configure-high-availability/[Configure High Availability]. + + +:relfileprefix: ../../../ + +* You should get the installation configuration file **config-sample.yaml** and transfer it to the cluster node where you will perform this action. For more information, refer to xref:03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc[Install Kubernetes and {ks_product-en}]. + +:relfileprefix: ./ + +-- +// Warning +include::../../../../_ks_components-en/admonitions/warning.adoc[] + +* During the process of adding nodes, it is not allowed to modify the original cluster configuration in **config-sample.yaml**. + +* If you are unable to get the installation configuration file **config-sample.yaml**, you need to refer to link:../../../03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere[Install Kubernetes and {ks_product-en}] to recreate the **config-sample.yaml** file. When recreating the file, make sure that the cluster information in the file matches the current state of the cluster. Otherwise, the uninstallation process may encounter errors. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- + + +== Steps + +include::../../../_custom-en/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[] + + ++ +include::../../../_custom-en/installationAndUpgrade/installationAndUpgrade-oper-transferConfig.adoc[] + ++ + +. Execute the following command to edit the installation configuration file **config-sample.yaml**: ++ +// Bash +[,bash] +---- +vi config-sample.yaml +---- + +. Configure the information of the new node under the **hosts** parameter in **config-sample.yaml**. ++ +-- + +include::../../../_custom-en/installationAndUpgrade/installationAndUpgrade-para-hosts.adoc[] + +// Warning +include::../../../../_ks_components-en/admonitions/warning.adoc[] + +Please do not modify the information of the original node. Otherwise, the cluster may encounter errors after adding nodes. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- + +. Configure the role of the new node in the cluster under the **roleGroups** parameter in **config-sample.yaml**. ++ +-- + +include::../../../_custom-en/installationAndUpgrade/installationAndUpgrade-para-roleGroups.adoc[] + +// Warning +include::../../../../_ks_components-en/admonitions/warning.adoc[] + +Please do not modify the role of the original node. Otherwise, the cluster may encounter errors after adding nodes. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- + +. If a new control plane node is added and the current cluster is not configured for high availability, configure the high availability information under the **controlPlaneEndpoint** parameter in **config-sample.yaml**. ++ +-- + +include::../../../_custom-en/installationAndUpgrade/installationAndUpgrade-para-controlPlaneEndpoint.adoc[] + +// Warning +include::../../../../_ks_components-en/admonitions/warning.adoc[] + +* If the current cluster has been configured with high availability, do not modify the high availability information in the **config-sample.yaml** file. Otherwise, the cluster may encounter errors after adding nodes. + +* If the current cluster uses local load balancing to achieve high availability, you do not need to perform any operations on cluster high availability; if the current cluster uses a load balancer to achieve high availability, you only need to configure the load balancer to listen on port 6443 of all control plane nodes. For more information, see link:../../01-preparations/03-configure-high-availability/[Configure High Availability]. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- + +. Save the configuration file and execute the following command to start adding nodes: ++ +-- +[,bash] +---- + ./kk add nodes -f config-sample.yaml +---- +// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-code-addNodes.adoc[] +-- + +. Execute the following command to view the nodes of the current cluster: ++ +-- +// Bash +[,bash] +---- +kubectl get node +---- + +If it displays the information about the new node, it means the node is added successfully. +-- diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/02-delete-cluster-nodes.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/02-delete-cluster-nodes.adoc new file mode 100644 index 000000000..2c6f8ebbc --- /dev/null +++ b/content/en/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/02-delete-cluster-nodes.adoc @@ -0,0 +1,100 @@ +--- +title: "Remove Cluster Nodes" +linkTitle: "Remove Cluster Nodes" +keywords: "Kubernetes, KubeSphere, delete cluster node" +description: "Introduce how to delete KubeSphere cluster nodes." +weight: 02 +--- + + +This section describes how to delete KubeSphere cluster nodes. + +The open-source tool KubeKey will be used during the process. For more information about KubeKey, please visit link:https://github.com/kubesphere/kubekey[GitHub KubeKey repository]. + +// Note +include::../../../../_ks_components-en/admonitions/note.adoc[] + +The node deletion method described in this section is only applicable to Kubernetes installed through KubeKey. If your Kubernetes is not installed via KubeKey, please refer to link:https://kubernetes.io/zh/docs/concepts/architecture/nodes/[Kubernetes Documentation] to delete nodes. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] + +// Warning +include::../../../../_ks_components-en/admonitions/warning.adoc[] + +* Do not delete control plane nodes, otherwise the cluster may encounter errors. + +* Please ensure that after node deletion, the remaining resources in the cluster are still sufficient to run existing services. Otherwise, service interruption may occur after the node is deleted. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] + + +== Prerequisites + +:relfileprefix: ../../../ + +* You should get the installation configuration file **config-sample.yaml** and transfer it to the cluster node where you will perform this action. For more information, refer to xref:03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc[Install Kubernetes and {ks_product-en}]. + +:relfileprefix: ./ + +-- +// Warning +include::../../../../_ks_components-en/admonitions/warning.adoc[] + +If you are unable to get the installation configuration file **config-sample.yaml**, you need to refer to link:../../../03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere[Install Kubernetes and {ks_product-en}] to recreate the **config-sample.yaml** file. When recreating the file, make sure that the cluster information in the file matches the current state of the cluster. Otherwise, the uninstallation process may encounter errors. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- + + +== Steps + +include::../../../_custom-en/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[] + + +. Execute the following command to get the name of the node that needs to be deleted: ++ +-- +// Bash +[,bash] +---- +kubectl get node +---- +-- + +. Execute the following command to evict the pods running on the node that needs to be deleted to other nodes (replace with the name of the node that needs to be deleted): ++ +-- +// Bash +[,bash] +---- +kubectl drain +---- +-- + ++ + +include::../../../_custom-en/installationAndUpgrade/installationAndUpgrade-oper-transferConfig.adoc[] + ++ + +. Execute the following command to start deleting nodes: ++ +-- +// Bash +[,bash] +---- + ./kk delete node -f config-sample.yaml +---- +-- + +. Execute the following command to view the current cluster nodes: ++ +-- +// Bash +[,bash] +---- +kubectl get node +---- + +If the deleted node is not displayed, it means the node is deleted successfully. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/_index.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/_index.adoc new file mode 100644 index 000000000..cd8e06ad8 --- /dev/null +++ b/content/en/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/_index.adoc @@ -0,0 +1,9 @@ +--- +title: "Add and Remove Cluster Nodes" +linkTitle: "Add and Remove Cluster Nodes" +keywords: "Kubernetes, KubeSphere, Add Cluster Nodes, Remove Cluster Nodes" +description: "Learn how to add and remove cluster nodes in KubeSphere." +weight: 05 +--- + +This section explains how to add and remove cluster nodes in {ks_product-en}. \ No newline at end of file diff --git a/content/en/docs/v4.1/03-installation-and-upgrade/_index.adoc b/content/en/docs/v4.1/03-installation-and-upgrade/_index.adoc new file mode 100644 index 000000000..455444434 --- /dev/null +++ b/content/en/docs/v4.1/03-installation-and-upgrade/_index.adoc @@ -0,0 +1,18 @@ +--- +title: "Installation Guide" +linkTitle: "Installation Guide" +keywords: "Kubernetes, KubeSphere, Installation, Uninstallation" +description: "Learn how to install and uninstall KubeSphere." +layout: "second" +weight: 03 +icon: "/images/docs/common/docs.svg" +--- + +This guide introduces how to install and uninstall {ks_product-en}, as well as how to add and remove cluster nodes. + +// Note +include::../../../_ks_components-en/admonitions/note.adoc[] + +Upgrade from {ks_product-en} v3.x to v4.1 is not supported at present. + +include::../../../_ks_components-en/admonitions/admonEnd.adoc[] diff --git a/content/en/docs/v4.1/04-platform-management/01-platform-features.adoc b/content/en/docs/v4.1/04-platform-management/01-platform-features.adoc new file mode 100644 index 000000000..2f1e64054 --- /dev/null +++ b/content/en/docs/v4.1/04-platform-management/01-platform-features.adoc @@ -0,0 +1,47 @@ +--- +title: "Platform Introduction" +linkTitle: "Platform Introduction" +keywords: "Kubernetes, KubeSphere, Platform, Modules" +description: "Introduce the main functions of each module in KubeSphere." +weight: 01 +--- + +KubeSphere adopts a fine-grained permission control mechanism. The {ks_product-en} web console varies based on the user's role. + +This section, from the perspective of a user with the `platform-admin` role, introduces the modules and functionalities of the {ks_product-en} web console. + + +[%header,cols="1a,4a"] +|=== +|Module |Functionality + +|KubeSphere Marketplace +|The store for extensions, supporting subscription, installation, uninstallation, configuration, and updates of extensions. + +|App Store +|The App Store provides application templates based on Helm Charts, supporting search and installation of applications into a specific project. + +.5+|Workbench +|Cluster Management: Manages resources from an infrastructure perspective, supporting operations such as adding member clusters, editing cluster information, updating kubeconfig, and removing member clusters. + +|Workspace management: Provides the ability to share resources across clusters, supporting operations such as creating, editing, and deleting workspaces. + +|Users and Roles: Create users/platform roles, edit information of users/platform roles, enable and disable users, modify user roles, edit information & permissions of platform roles, and delete users/platform roles. + +|Extensions Center: Manages subscribed extensions, such as installing, uninstalling, configuring, disabling, and updating extensions. + +|Quick Access: Enables quick access to resources such as clusters, workspaces, and projects. + +|Extensions +|Global access entry for platform-level, multi-cluster, and multi-tenant extensions, supporting quick access to installed extensions. + +|Platform Settings +|View platform information. +|=== + + +include::../../../_ks_components-en/admonitions/note.adoc[] + +For detailed information about each modules, please refer to the corresponding guides. + +include::../../../_ks_components-en/admonitions/admonEnd.adoc[] diff --git a/content/en/docs/v4.1/04-platform-management/02-quick-access.adoc b/content/en/docs/v4.1/04-platform-management/02-quick-access.adoc new file mode 100644 index 000000000..e85e4efba --- /dev/null +++ b/content/en/docs/v4.1/04-platform-management/02-quick-access.adoc @@ -0,0 +1,20 @@ +--- +title: "Quick Access" +linkTitle: "Quick Access" +keywords: "Kubernetes, KubeSphere, Quick Access" +description: "Introduce how to add or remove quick access to resources." +weight: 02 +--- + +This section describes how to add or remove quick access to resources such as clusters, workspaces, and projects, allowing for quick navigation to their respective pages. + +== Prerequisites + +You have the username and password to access the {ks_product-en} web console. + +== Steps + +. Log in to the {ks_product-en} web console. +. On the cluster list, workspace list, or project list page, click image:/images/ks-qkcp/zh/icons/star_none.svg[star_none,18,18] to add the corresponding resource to the **Quick Access** area on the **Workbench**. Click image:/images/ks-qkcp/zh/icons/star.svg[star,18,18] to remove the resource from the quick access. ++ +You can also click image:/images/ks-qkcp/zh/icons/star.svg[star,18,18] within the **Quick Access** area to remove the added resource. \ No newline at end of file diff --git a/content/en/docs/v4.1/04-platform-management/03-platform-settings/01-view-and-customize-platform-information.adoc b/content/en/docs/v4.1/04-platform-management/03-platform-settings/01-view-and-customize-platform-information.adoc new file mode 100644 index 000000000..84f160134 --- /dev/null +++ b/content/en/docs/v4.1/04-platform-management/03-platform-settings/01-view-and-customize-platform-information.adoc @@ -0,0 +1,18 @@ +--- +title: "View Platform Information" +linkTitle: "View Platform Information" +keywords: "Kubernetes, KubeSphere, Platform Settings, Platform Information, View Platform Information" +description: "Introduce how to view platform information." +weight: 01 +--- + +This section explains how to view information of the {ks_product-en} web console. + + +== Operation Steps + +. Log in to the {ks_product-en} web console. + +. Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the top right corner of the page to access the **Platform Settings** page. ++ +The **Platform Information** page displays the platform's access address, identifier, title, and description. \ No newline at end of file diff --git a/content/en/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc b/content/en/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc new file mode 100644 index 000000000..cb535e77c --- /dev/null +++ b/content/en/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc @@ -0,0 +1,153 @@ +--- +title: "Configure External Authentication" +linkTitle: "Configure External Authentication" +keywords: "Kubernetes, KubeSphere, Third-party Authentication" +description: "Learn how to set up external authentication on KubeSphere." +weight: 01 +--- + +:ks_navigation: **Configuration > ConfigMap** + +KubeSphere supports setting up external authentication. Platform administrators can configure identity providers through Secrets. + +After configuring external identity providers, users can log in to the {ks_product-en} web console using usernames and passwords from LDAP, CAS, GitHub, Alibaba Cloud IDaaS, or OpenID Connect. + +== Steps + +. Log in to the {ks_product-en} web console with a user having the **platform-admin** role. + +. Navigate to the project **kubesphere-system** under the workspace **system-workspace**. + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + +. In the **Create Secrets** dialog, toggle the **Edit YAML** switch in the top right corner to create a secret using YAML. + +. Modify the YAML file according to the example and configuration instructions below. Once configured, click **Create**. + +. Log out of the KubeSphere web console. On the login page, enter the username and password for LDAP, CAS, GitHub, Alibaba Cloud IDaaS, or OpenID Connect based on the configured external authentication type. + +[.admon.note,cols="a"] +|=== +|Note + +| +In a multi-cluster environment, configuration is only required in the host cluster. +|=== + +== OpenLDAP YAML Sample + +[,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"] +|=== +|Attention + +| +- The secret must be created in the `kubeshere-system` project. +- The secret must include a type. ++ +`type: config.kubesphere.io/identityprovider`. + +- The secret must include a label. ++ +`config.kubesphere.io/type: identityprovider`. +|=== + +== Configuration Explanation + +In the `stringData:configuration.yaml` parameter of the above example: + +- **name**: Specifies the name of the external identity provider, which must be unique to avoid creation failures. + +- **type**: Specifies the type of external identity provider, supporting the following types: ++ +-- +- LDAP: `LDAPIdentityProvider` +- CAS: `CASIdentityProvider` +- GitHub: `GitHubIdentityProvider` +- Alibaba Cloud IDaaS: `AliyunIDaaSProvider` +- OpenID Connect: `OIDCIdentityProvider` +-- + +- **mappingMethod**: Specifies how external identity users are associated with KubeSphere users. ++ +-- +- `auto`: Automatically creates a KubeSphere user with the same name. Fails if a user with the same name already exists in the platform. +- `manual`: Creates a new user with any name after logging in. +- `lookup`: Automatically associates an existing KubeSphere user with the same name. Fails if no user with the specified name exists. +-- + +- **provider**: Contains specific parameters for the external identity authentication. Below are examples of the provider parameters for different authentication types. ++ +-- +- 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' +---- + +For the configuration method of Alibaba Cloud IDaaS provider, refer to the link:https://www.alibabacloud.com/help/zh/idaas/[Alibaba Cloud IDaaS Documentation]. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/_index.adoc b/content/en/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/_index.adoc new file mode 100644 index 000000000..5c368b6fb --- /dev/null +++ b/content/en/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "External Authentication" +linkTitle: "External Authentication" +keywords: "Kubernetes, KubeSphere, Third-party Authentication" +description: "Set up external identity authentication on KubeSphere." +weight: 03 +layout: "second" +--- + +This section demonstrates how to configure third-party authentication on KubeSphere. \ No newline at end of file diff --git a/content/en/docs/v4.1/04-platform-management/03-platform-settings/_index.adoc b/content/en/docs/v4.1/04-platform-management/03-platform-settings/_index.adoc new file mode 100644 index 000000000..58eba75f3 --- /dev/null +++ b/content/en/docs/v4.1/04-platform-management/03-platform-settings/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Platform Settings" +linkTitle: "Platform Settings" +keywords: "Kubernetes, KubeSphere, Platform, Settings, Basic Information" +description: "Introduce how to manage the basic information of the KubeSphere platform." +weight: 03 +layout: "second" +--- + +This section explains how to manage basic information of the {ks_product-en} web console. diff --git a/content/en/docs/v4.1/04-platform-management/_index.adoc b/content/en/docs/v4.1/04-platform-management/_index.adoc new file mode 100644 index 000000000..953d7e702 --- /dev/null +++ b/content/en/docs/v4.1/04-platform-management/_index.adoc @@ -0,0 +1,11 @@ +--- +title: "Platform Management" +linkTitle: "Platform Management" +keywords: "Kubernetes, KubeSphere, Platform Management" +description: "Introduce the functionalities of various modules in KubeSphere and provides instructions on configuring the platform." +layout: "second" +weight: 04 +icon: "/images/docs/common/docs.svg" +--- + +This section introduces the functionalities of various modules in {ks_product-en}, and provides instructions on platform settings. \ No newline at end of file diff --git a/content/en/docs/v4.1/05-users-and-roles/01-users/01-create-a-user.adoc b/content/en/docs/v4.1/05-users-and-roles/01-users/01-create-a-user.adoc new file mode 100644 index 000000000..5ccd96da3 --- /dev/null +++ b/content/en/docs/v4.1/05-users-and-roles/01-users/01-create-a-user.adoc @@ -0,0 +1,47 @@ +--- +title: "Create Users" +linkTitle: "Create Users" +keywords: "Kubernetes, KubeSphere, Access Control, Users, Create Users" +description: "Explain how to create a user." +weight: 01 +--- + +:ks_menu: **Users and Roles** +:ks_navigation: **Users** +:ks_permission: **User Management** + +This section explains how to create a user. + +== Prerequisites + +You should have the pass:a,q[{ks_permission}] permission on the {ks_product-en} platform. For more information, refer to link:../../01-users/[Users] and link:../../02-platform-roles/[Platform Roles]. + +== Steps + +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. +. Click pass:a,q[{ks_menu}]. +. Click pass:a,q[{ks_navigation}] in the left navigation pane. +. Click **Create** on the page. +. In the **Create User** dialog, fill in the user's information, and then click **OK**. ++ +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Username +|The name of the user. The username can only contain lowercase letters, numbers, hyphens (-), and periods (.), must start and end with a lowercase letter or number, and can be up to 32 characters long. + +|Email +|The email address of the user. The email address can be used to log in to the {ks_product-en} web console. + +|Platform Role +|The role of the user on the {ks_product-en} platform. The platform role determines the user's permissions in {ks_product-en}. + +|Password +|The password of the user. The password must contain numbers, uppercase letters, lowercase letters, and special characters, and be between 8 and 64 characters long. + +|Description +|The description of the user. The description can contain any characters and be up to 256 characters long. +|=== + +The user will be displayed in the list after the creation. diff --git a/content/en/docs/v4.1/05-users-and-roles/01-users/02-view-a-user-list.adoc b/content/en/docs/v4.1/05-users-and-roles/01-users/02-view-a-user-list.adoc new file mode 100644 index 000000000..69c4d24f2 --- /dev/null +++ b/content/en/docs/v4.1/05-users-and-roles/01-users/02-view-a-user-list.adoc @@ -0,0 +1,57 @@ +--- +title: "View User List" +linkTitle: "View User List" +keywords: "Kubernetes, KubeSphere, Access Control, Users, View User List" +description: "Explain how to view the user list." +weight: 02 +--- + +:ks_menu: **Users and Roles** +:ks_navigation: **Users** +:ks_permission: **User Viewing** + +This section explains how to view the user list. + +== Prerequisites + +You should have the pass:a,q[{ks_permission}] permission on the {ks_product-en} platform. For more information, refer to link:../../01-users/[Users] and link:../../02-platform-roles/[Platform Roles]. + +== Steps + +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. +. Click pass:a,q[{ks_menu}]. +. Click pass:a,q[{ks_navigation}] in the left navigation pane. + +* The user list provides the following information: ++ +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Name +|The name of the user. + +|Status +|The current status of the user. + +* **Active**: The user's current status is normal. + +* **Waiting**: The system is creating the user. + +* **Disabled**: The user is disabled by the platform administrator and cannot log in to the {ks_product-en} web console. + +* **Restricted**: The user has failed to log in 10 times in 10 minutes and is blocked from logging in to the {ks_product-en} web console for 10 minutes. + +|Platform Role +|The role of the user on the {ks_product-en} platform. + +|Last Login +|The user's last login time on the {ks_product-en} platform. + +|=== + +* Click the search box above the list and enter keywords to search for users whose usernames contain specific keywords. + +* Click image:/images/ks-qkcp/zh/icons/refresh-light.svg[refresh,18,18] in the upper right corner of the list to refresh the list information. + +* Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper right corner of the list to customize the information displayed in the list. diff --git a/content/en/docs/v4.1/05-users-and-roles/01-users/03-view-user-details.adoc b/content/en/docs/v4.1/05-users-and-roles/01-users/03-view-user-details.adoc new file mode 100644 index 000000000..0b4ef97e6 --- /dev/null +++ b/content/en/docs/v4.1/05-users-and-roles/01-users/03-view-user-details.adoc @@ -0,0 +1,61 @@ +--- +title: "View User Details" +linkTitle: "View User Details" +keywords: "Kubernetes, KubeSphere, Access Control, Users, View User Details" +description: "Explain how to view user details." +weight: 03 +--- + +:ks_menu: **Users and Roles** +:ks_navigation: **Users** +:ks_permission: **User Viewing** + +This section explains how to view user details. + +== Prerequisites + +You should have the pass:a,q[{ks_permission}] permission on the {ks_product-en} platform. For more information, refer to link:../../01-users/[Users] and link:../../02-platform-roles/[Platform Roles]. + + +== Steps + +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. +. Click pass:a,q[{ks_menu}]. +. Click pass:a,q[{ks_navigation}] in the left navigation pane. +. In the user list, click the name of a user to open its details page. +. In the **Attributes** area on the left side of the user details page, view the user's attributes. ++ +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Platform Role +|The user's platform role. + +|Email +|The user's email address. + +|Last Login +|The user's last login time on the {ks_product-en} web console. + +|=== + +. On the **Login History** tab on the right side of the user details page, view the user's login history. ++ +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Time +|The user's login time. + +|Status +|Whether the user logged in successfully. + +|Source IP Address +|The client IP address from which the user logged in to the {ks_product-en} web console. + +|Reason +|If the login failed, the reason for the login failure is displayed. + +|=== diff --git a/content/en/docs/v4.1/05-users-and-roles/01-users/04-edit-user-information.adoc b/content/en/docs/v4.1/05-users-and-roles/01-users/04-edit-user-information.adoc new file mode 100644 index 000000000..e26a1a002 --- /dev/null +++ b/content/en/docs/v4.1/05-users-and-roles/01-users/04-edit-user-information.adoc @@ -0,0 +1,43 @@ +--- +title: "Edit User Information" +linkTitle: "Edit User Information" +keywords: "Kubernetes, KubeSphere, Access Control, Users, Edit User Information" +description: "Learn how to edit user information." +weight: 04 +--- + +:ks_menu: **Users and Roles** +:ks_navigation: **Users** +:ks_permission: **User Management** + + +This section explains how to edit user information. + +You can edit the user's email, platform role, and description. KubeSphere does not support editing the name of an already created user. + + +== Prerequisites + +You should have the pass:a,q[{ks_permission}] permission on the {ks_product-en} platform. For more information, see link:../../01-users/[Users] and link:../../02-platform-roles/[Platform Roles]. + +== Steps + +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. +. Click pass:a,q[{ks_menu}]. +. Click pass:a,q[{ks_navigation}] in the left navigation pane. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] to the right of a user, and then choose **Edit** from the dropdown list. +. In the **Edit User** dialog, edit the user's information, and then click **OK**. + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Email +|The user's email address. The email address can be used to log in to the {ks_product-en} web console. + +|Platform Role +|The user's role on the {ks_product-en} platform. The platform role determines the user's permissions in {ks_product-en}. + +|Description +|The description of the user. The description can contain any characters, with a maximum length of 256 characters. +|=== diff --git a/content/en/docs/v4.1/05-users-and-roles/01-users/05-change-the-email-language-and-language.adoc b/content/en/docs/v4.1/05-users-and-roles/01-users/05-change-the-email-language-and-language.adoc new file mode 100644 index 000000000..c84264a4f --- /dev/null +++ b/content/en/docs/v4.1/05-users-and-roles/01-users/05-change-the-email-language-and-language.adoc @@ -0,0 +1,34 @@ +--- +title: "Change Email and Language" +linkTitle: "Change Email and Language" +keywords: "Kubernetes, KubeSphere, Cluster Management, Web Console, Change Email Address, Language" +description: "Explain how to change the email address and language for the current user." +weight: 05 +--- + +This section explains how to change the email address and language for the current user. + +== Prerequisites + +Get the username and password for the {ks_product-en} web console. + +== Steps + +. Log in to the {ks_product-en} web console. + +. Click the current username in the top-right corner, and then select **User Settings** from the dropdown list. + +. On the **Basic Information** tab, change the user's email address and language. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Email +|The user's email address. The email address can be used to log in to the {ks_product-en} web console. + +|Language +|The language displayed in the {ks_product-en} web console for the current user. +|=== +-- diff --git a/content/en/docs/v4.1/05-users-and-roles/01-users/06-change-the-password-of-a-user.adoc b/content/en/docs/v4.1/05-users-and-roles/01-users/06-change-the-password-of-a-user.adoc new file mode 100644 index 000000000..431dc15c2 --- /dev/null +++ b/content/en/docs/v4.1/05-users-and-roles/01-users/06-change-the-password-of-a-user.adoc @@ -0,0 +1,34 @@ +--- +title: "Change User Password" +linkTitle: "Change User Password" +keywords: "Kubernetes, KubeSphere, Access Control, User, Change User Password" +description: "Learn how to change user passwords." +weight: 06 +--- + +:ks_menu: **Users and Roles** +:ks_navigation: **Users** +:ks_permission: **User Management** + +This section explains how to change user passwords. + +== Change Password for the Current User + +. Log in to the {ks_product-en} web console. + +. Click the current username in the top-right corner, then select **User Settings** from the drop-down list. + +. Click the **Password Settings** tab to change the password for the current user. ++ +The password must contain at least one number, one lowercase letter, one uppercase letter, and one special character (~!@#$%^&*()-_=+\|[{}];:'",<.>/? or space). The length must be 8 to 64 characters. + +== Change Password for Other Users + +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. +. Click pass:a,q[{ks_menu}]. +. Click pass:a,q[{ks_navigation}] in the left navigation pane. +. Click the name of a user to open its details page. +. In the top-left corner of the user details page, select **More > Change Password**. +. In the **Change Password** dialog, set a new password and re-enter it, then click **OK**. ++ +The password must contain at least one number, one lowercase letter, one uppercase letter, and one special character (~!@#$%^&*()-_=+\|[{}];:'",<.>/? or space). The length must be 8 to 64 characters. \ No newline at end of file diff --git a/content/en/docs/v4.1/05-users-and-roles/01-users/07-reset-user-password.adoc b/content/en/docs/v4.1/05-users-and-roles/01-users/07-reset-user-password.adoc new file mode 100644 index 000000000..fac487b5d --- /dev/null +++ b/content/en/docs/v4.1/05-users-and-roles/01-users/07-reset-user-password.adoc @@ -0,0 +1,41 @@ +--- +title: "Reset User Password" +linkTitle: "Reset User Password" +keywords: "Kubernetes, KubeSphere, Access Control, User, Reset Password" +description: "Learn how to reset a user's password." +weight: 07 +--- + +This section provides guidance on resetting user passwords. + +If a regular user forgets their password and is unable to log in to the {ks_product-en} web console, please refer to link:../06-change-the-password-of-a-user[this document] for instructions on how the administrator can change the user's password. + +If the platform administrator forgets their password, the following command needs to be executed on the host cluster to change the password for the specified account. + +[,bash] +---- +kubectl patch users -p '{"spec":{"password":""}}' --type='merge' && kubectl annotate users iam.kubesphere.io/password-encrypted- +---- + +[.admon.note,cols="a"] +|=== +|Note + +| +Please replace in the command with the actual username and with the new password. +|=== + +[.admon.attention,cols="a"] +|=== +|Attention + +| +The new password must meet the password requirements. It must contain at least one number, one lowercase letter, one uppercase letter, and one special character (~!@#$%^&*()-_=+\|[{}];:'",<.>/? or space). The length must be 8 to 64 characters. +|=== + +Example: + +[,bash] +---- +kubectl patch users admin -p '{"spec":{"password":"P@88w0rd"}}' --type='merge' && kubectl annotate users admin iam.kubesphere.io/password-encrypted- +---- \ No newline at end of file diff --git a/content/en/docs/v4.1/05-users-and-roles/01-users/09-enable-and-disable-users.adoc b/content/en/docs/v4.1/05-users-and-roles/01-users/09-enable-and-disable-users.adoc new file mode 100644 index 000000000..000c4af48 --- /dev/null +++ b/content/en/docs/v4.1/05-users-and-roles/01-users/09-enable-and-disable-users.adoc @@ -0,0 +1,33 @@ +--- +title: "Enable and Disable Users" +linkTitle: "Enable and Disable Users" +keywords: "Kubernetes, KubeSphere, Access Control, Users, Enable and Disable Users" +description: "Explain how to enable and disable users." +weight: 09 +--- + +:ks_menu: **Users and Roles** +:ks_navigation: **Users** +:ks_permission: **User Management** + +This section explains how to enable and disable users. + +After a user is disabled, it will be unable to log in to the {ks_product-en} web console. + +== Prerequisites + +You should have pass:a,q[{ks_permission}] permission on the {ks_product-en} platform. For more information, see link:../../01-users/[Users] and link:../../02-platform-roles/[Platform Roles]. + +== Enable and Disable a Single User + +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. +. Click pass:a,q[{ks_menu}]. +. Click pass:a,q[{ks_navigation}] in the left navigation pane. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] to the right of a user, and then select **Enable** or **Disable** from the dropdown list. + +== Batch Enable and Disable Users + +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. +. Click pass:a,q[{ks_menu}]. +. Click pass:a,q[{ks_navigation}] in the left navigation pane. +. Check the boxes next to the users you want, and then click **Enable** or **Disable** above the list. diff --git a/content/en/docs/v4.1/05-users-and-roles/01-users/10-delete-users.adoc b/content/en/docs/v4.1/05-users-and-roles/01-users/10-delete-users.adoc new file mode 100644 index 000000000..9a8befba3 --- /dev/null +++ b/content/en/docs/v4.1/05-users-and-roles/01-users/10-delete-users.adoc @@ -0,0 +1,40 @@ +--- +title: "Delete Users" +linkTitle: "Delete Users" +keywords: "Kubernetes, KubeSphere, Access Control, User, Delete User" +description: "Learn how to delete users." +weight: 10 +--- + +:ks_menu: **Users and Roles** +:ks_navigation: **Users** +:ks_permission: **User Management** + +This section explains how to delete users. + +== Prerequisites + +You should have the pass:a,q[{ks_permission}] permission on the {ks_product-en} platform. For more information, please refer to link:../../01-users/[Users] and link:../../02-platform-roles/[Platform Roles]. + +== Delete a Single User + +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. +. Click pass:a,q[{ks_menu}]. +. Click pass:a,q[{ks_navigation}] in the left navigation pane. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] next to the user you want to delete, then choose **Delete** from the drop-down list. +. In the **Delete User** dialog, enter the user's name, then click **OK**. + +== Delete Multiple Users + +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. +. Click pass:a,q[{ks_menu}]. +. Click pass:a,q[{ks_navigation}] in the left navigation pane. +. Check the boxes next to the users you want to delete, then click **Delete** above the list. +. In the **Delete Multiple Users** dialog, enter the names of the users, then click **OK**. ++ +include::../../../../_ks_components-en/admonitions/note.adoc[] + +Please use a comma (,) or space to separate multiple names. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] + diff --git a/content/en/docs/v4.1/05-users-and-roles/01-users/_index.adoc b/content/en/docs/v4.1/05-users-and-roles/01-users/_index.adoc new file mode 100644 index 000000000..de921555c --- /dev/null +++ b/content/en/docs/v4.1/05-users-and-roles/01-users/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "Users" +linkTitle: "Users" +keywords: "Kubernetes, KubeSphere, Access Control, User" +description: "Explain how to manage users." +layout: "second" +weight: 02 +--- + +This section explains how to manage users. + +The default administrator user **admin** in KubeSphere has all permissions and can create other users as needed. Users can be invited to join clusters and workspaces. Workspace members can be invited to join various projects, meaning users can be members under clusters, workspaces, and projects. \ No newline at end of file diff --git a/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/01-create-a-platform-role.adoc b/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/01-create-a-platform-role.adoc new file mode 100644 index 000000000..a56894b88 --- /dev/null +++ b/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/01-create-a-platform-role.adoc @@ -0,0 +1,107 @@ +--- +title: "Create Platform Roles" +linkTitle: "Create Platform Roles" +keywords: "Kubernetes, KubeSphere, Platform Management, Access Control, Platform Roles, Create Platform Roles" +description: "Introduction to creating platform roles." +weight: 01 +--- + +:ks_menu: **Users and Roles** +:ks_navigation: **Platform Roles** + +This section explains how to create platform roles. + +KubeSphere provides the following preset platform roles, and you can also create roles to customize role permissions. + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|platform-admin +|The platform administrator has all permissions on the {ks_product-en} platform. + +|platform-regular +|The role cannot access any resources before joining a workspace, which is typically granted to workspace members who do not need other platform permissions. + +|platform-self-provisioner +|Create workspace and become the administrator of the created workspace. +|=== + +== Prerequisites + +You should have the **platform-admin** role on the {ks_product-en} platform. For more information, see link:../../01-users/[Users] and link:../../02-platform-roles/[Platform Roles]. + +== Steps + +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. +. Click pass:a,q[{ks_menu}]. +. Select **Platform Roles** from the left navigation pane. +. Click **Create** on the page. +. In the **Create Platform Role** dialog, set the name, alias, and description of the platform role, and then click **Edit Permissions**. ++ +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Name +|Name of the platform role. The name can only contain lowercase letters, numbers, and hyphens (-), must start and end with a lowercase letter or number, and can be up to 63 characters long. + +|Alias +|Alias of the platform role. The alias can contain Chinese characters, letters, numbers, and hyphens (-). It must not start or end with a hyphen (-) and can be up to 63 characters long. + +|Description +|Description of the platform role. The description can contain any characters and is limited to 256 characters. +|=== + +. In the **Edit Permissions** dialog, set the permissions for the platform role, and then click **OK**. ++ +Users with the **platform-admin** role can enable and disable extensions. Other required permissions for platform operations are as follows: + ++ +* Workspace ++ + +[%header,cols="1a,4a"] +|=== +|Permission |Operations Allowed + +|Workspace Creation +|Create workspaces and become an administrator of the created projects. + +|Workspace Management +|Manage all workspaces and resources within workspaces. + +|Workspace Viewing +|View all workspaces and resources within workspaces. +|=== + ++ +* Cluster Management ++ + +[%header,cols="1a,4a"] +|=== +|Permission |Operations Allowed + +|Cluster Management +|Create clusters, delete clusters, and manage resources within all clusters. + +|Cluster Viewing +|View all clusters and cluster resources. +|=== + +* Access Control ++ +-- +[%header,cols="1a,4a"] +|=== +|Permission |Operations Allowed + +|User Viewing +|View users. + +|Role Viewing +|View platform roles. + +|=== +-- diff --git a/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/02-view-a-platform-role-list.adoc b/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/02-view-a-platform-role-list.adoc new file mode 100644 index 000000000..cdd394b50 --- /dev/null +++ b/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/02-view-a-platform-role-list.adoc @@ -0,0 +1,25 @@ +--- +title: "View Platform Role List" +linkTitle: "View Platform Role List" +keywords: "Kubernetes, KubeSphere, Platform Management, Access Control, Platform Roles, View Platform Role List" +description: "Explain how to view the platform role list." +weight: 02 +--- + +:ks_menu: **Users and Roles** +:ks_permission: **Role Viewing** +:ks_navigation: **Platform Roles** + +This section explains how to view the platform role list. + +== Prerequisites + +You should have the pass:a,q[{ks_permission}] permission on the {ks_product-en} platform. For more information, see link:../../01-users/[Users] and link:../../02-platform-roles/[Platform Roles]. + +== Steps + +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. +. Click pass:a,q[{ks_menu}]. +. Select **Platform Roles** from the left navigation pane. ++ +The platform role list shows the names, descriptions, and creation times of the roles. diff --git a/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/03-view-platform-role-details.adoc b/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/03-view-platform-role-details.adoc new file mode 100644 index 000000000..cb6cc18e4 --- /dev/null +++ b/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/03-view-platform-role-details.adoc @@ -0,0 +1,30 @@ +--- +title: "View Platform Role Details" +linkTitle: "View Platform Role Details" +keywords: "Kubernetes, KubeSphere, Platform Management, Access Control, Platform Roles, View Platform Role Details" +description: "Explain how to view platform role details." +weight: 03 +--- + +:ks_menu: **Users and Roles** +:ks_permission: **Role Viewing** +:ks_navigation: **Platform Roles** + +This section explains how to view platform role details. + +== Prerequisites + +You should have the pass:a,q[{ks_permission}] permission on the {ks_product-en} platform. For more information, see link:../../01-users/[Users] and link:../../02-platform-roles/[Platform Roles]. + +== Steps + +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. +. Click pass:a,q[{ks_menu}]. +. Select **Platform Roles** from the left navigation pane. +. Click the name of a platform role in the list to open its details page. +. On the **Permissions** tab of the details page, view the permissions owned by the role. +. Click the **Authorized Users** tab to view users who have the current platform role. ++ +-- +include::../../../_custom-en/clusterManagement/clusterRoles/clusterRoles-para-authorizedUsers.adoc[] +-- diff --git a/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/04-edit-platform-role-information.adoc b/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/04-edit-platform-role-information.adoc new file mode 100644 index 000000000..39b2363a5 --- /dev/null +++ b/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/04-edit-platform-role-information.adoc @@ -0,0 +1,35 @@ +--- +title: "Edit Platform Role Information" +linkTitle: "Edit Platform Role Information" +keywords: "Kubernetes, KubeSphere, Platform Management, Access Control, Platform Roles, Edit Platform Role Information" +description: "Introduction to editing platform role information." +weight: 04 +--- + +:ks_menu: **Users and Roles** +:ks_permission: **Role Management** +:ks_navigation: **Platform Roles** + +This section explains how to edit platform role information. + +You can edit the alias and description of platform roles created by users. KubeSphere does not support editing preset platform roles and the names of platform roles. + +== Prerequisites + +You should have the pass:a,q[{ks_permission}] permission on the {ks_product-en} platform. For more information, see link:../../01-users/[Users] and link:../../02-platform-roles/[Platform Roles]. + +== Steps + +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. +. Click pass:a,q[{ks_menu}]. +. Select **Platform Roles** from the left navigation pane. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the platform role, then choose **Edit Information** from the drop-down list. +. In the **Edit Information** dialog, set the alias and description of the platform role, then click **OK**. ++ +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +include::../../../_custom-en/platformManagement/accessControl/platformRoles/platformRoles-para-aliasDescription.adoc[] + +|=== diff --git a/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/05-edit-permissions-of-a-platform-role.adoc b/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/05-edit-permissions-of-a-platform-role.adoc new file mode 100644 index 000000000..5a4d19b9c --- /dev/null +++ b/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/05-edit-permissions-of-a-platform-role.adoc @@ -0,0 +1,76 @@ +--- +title: "Edit Platform Role Permissions" +linkTitle: "Edit Platform Role Permissions" +keywords: "Kubernetes, KubeSphere, Platform Management, Access Control, Platform Roles, Edit Platform Role Permissions" +description: "Introduction to editing platform role permissions." +weight: 05 +--- + +:ks_menu: **Users and Roles** +:ks_permission: **Role Management** +:ks_navigation: **Platform Roles** + +This section explains how to edit platform role permissions. + +== Prerequisites + +You should have the pass:a,q[{ks_permission}] permission on the {ks_product-en} platform. For more information, see link:../../01-users/[Users] and link:../../02-platform-roles/[Platform Roles]. + +== Steps + +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. +. Click pass:a,q[{ks_menu}]. +. Select **Platform Roles** from the left navigation pane. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the platform role, then choose **Edit Permissions** from the drop-down list. +. In the **Edit Permissions** dialog, set the permissions for the platform role, then click **OK**. ++ +Users with the **platform-admin** role can enable and disable extensions. Other required permissions for platform operations are as follows: + ++ +* Workspace ++ + +[%header,cols="1a,4a"] +|=== +|Permission |Operations Allowed + +|Workspace Creation +|Create workspaces and become an administrator of the created projects. + +|Workspace Management +|Manage all workspaces and resources within workspaces. + +|Workspace Viewing +|View all workspaces and resources within workspaces. +|=== + ++ +* Cluster Management ++ + +[%header,cols="1a,4a"] +|=== +|Permission |Operations Allowed + +|Cluster Management +|Create clusters, delete clusters, and manage resources within all clusters. + +|Cluster Viewing +|View all clusters and cluster resources. +|=== + +* Access Control ++ +-- +[%header,cols="1a,4a"] +|=== +|Permission |Operations Allowed + +|User Viewing +|View users. + +|Role Viewing +|View platform roles. + +|=== +-- diff --git a/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/06-delete-platform-roles.adoc b/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/06-delete-platform-roles.adoc new file mode 100644 index 000000000..85569f311 --- /dev/null +++ b/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/06-delete-platform-roles.adoc @@ -0,0 +1,29 @@ +--- +title: "Delete Platform Roles" +linkTitle: "Delete Platform Roles" +keywords: "Kubernetes, KubeSphere, Platform Management, Access Control, Platform Roles, Delete Platform Roles" +description: "Introduction to deleting platform roles." +weight: 06 +--- + +:ks_menu: **Users and Roles** +:ks_permission: **Role Management** +:ks_navigation: **Platform Roles** + +This section explains how to delete platform roles. + +You can delete platform roles created by users. Preset platform roles cannot be deleted. + +== Prerequisites + +* You should have the pass:a,q[{ks_permission}] permission on the {ks_product-en} platform. For more information, see link:../../01-users/[Users] and link:../../02-platform-roles/[Platform Roles]. + +* If the platform role you want to delete has already been assigned to a user, you need to delete the user or modify their role. + +== Steps + +. Log in to the {ks_product-en} web console with a user who has the pass:a,q[{ks_permission}] permission. +. Click pass:a,q[{ks_menu}]. +. Select **Platform Roles** from the left navigation pane. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the platform role you want to delete, then choose **Delete** from the drop-down list. +. In the **Delete Role** dialog, click **OK**. diff --git a/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/_index.adoc b/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/_index.adoc new file mode 100644 index 000000000..457d93e59 --- /dev/null +++ b/content/en/docs/v4.1/05-users-and-roles/02-platform-roles/_index.adoc @@ -0,0 +1,16 @@ +--- +title: "Platform Roles" +linkTitle: "Platform Roles" +keywords: "Kubernetes, KubeSphere, Access Control, Users, Platform Roles" +description: "Explain how to manage platform roles." +layout: "second" +weight: 03 +--- + +This section explains how to manage platform roles. + +Platform roles has specific platform management or viewing permissions. You can authorize users with roles that contain specific permissions to control their platform access. + +include::../../../../_ks_components-en/admonitions/note.adoc[] +The default administrator user **admin** has all permissions on the {ks_product-en} platform. +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] diff --git a/content/en/docs/v4.1/05-users-and-roles/_index.adoc b/content/en/docs/v4.1/05-users-and-roles/_index.adoc new file mode 100644 index 000000000..d15c0a682 --- /dev/null +++ b/content/en/docs/v4.1/05-users-and-roles/_index.adoc @@ -0,0 +1,24 @@ +--- +title: "Users and Roles" +linkTitle: "Users and Roles" +keywords: "Kubernetes, KubeSphere, Access Control, Users, Roles" +description: "Learn how to control access permissions." +layout: "second" +weight: 05 +icon: "/images/docs/common/docs.svg" +--- + + +KubeSphere is a container management platform that supports multi-tenancy. Similar to Kubernetes, it controls user permissions through Role-Based Access Control (RBAC) to achieve logical resource isolation. + +Resources in KubeSphere are divided into four levels: Platform, Workspace, Cluster, and Project. All resources belong to these four levels, and access to resources can be controlled through roles at each level. Each level comes with multiple built-in roles by default, and you can also create custom roles with specific permissions. + +Workspace serves as the smallest tenant unit, providing resource isolation capabilities across clusters. Members within a Workspace can create projects in authorized clusters and collaborate on projects by inviting users. + +This section explains how to manage access permissions in KubeSphere, including user and platform role management. + +For more information about cluster roles, refer to link:../07-cluster-management/09-cluster-settings/04-cluster-roles/[Cluster Roles]. + +For more information about workspace roles, refer to link:../08-workspace-management/06-workspace-settings/04-workspace-roles/[Workspace Roles]. + +For more information about project roles, refer to link:../09-project-management/06-project-settings/02-project-roles/[Project Roles]. \ No newline at end of file diff --git a/content/en/docs/v4.1/06-extension-user-guide/01-install-components-pdf.adoc b/content/en/docs/v4.1/06-extension-user-guide/01-install-components-pdf.adoc new file mode 100644 index 000000000..6c3e05c2f --- /dev/null +++ b/content/en/docs/v4.1/06-extension-user-guide/01-install-components-pdf.adoc @@ -0,0 +1,52 @@ +--- +title: "Install Extensions" +keywords: "Kubernetes, KubeSphere, Installation, Extensions, Multi-cluster" +description: "Instructions on how to install extensions." +weight: 01 +--- + +This section explains how to install extensions. + +== Prerequisites + +You should have the **platform-admin** role on {ks_product-en} platform. For more information, refer to link:../../05-users-and-roles/01-users/[Users] and link:../../05-users-and-roles/02-platform-roles/[Platform Roles]. + + +== Installation Steps + +. Log in to the {ks_product-en} web console with a user having the **platform-admin** role. + +. Click **Extensions Center** to view the list of extensions. + +. Click the name of an uninstalled extension to access the installation page. + +. On the **Version Selection** tab of the installation dialog, select the version of the extension and install all required dependencies (if any). Click **Next**. ++ +-- +//note +[.admon.note,cols="a"] +|=== +|Note + +| +During the installation, it detects whether the extension has dependencies. Dependencies are categorized as required and optional. + +If a required dependency is **Not Ready**, you need to install the required version first to ensure the normal use of the extension. Optional dependencies do not affect the installation of the extension. +|=== +-- + +. On the **Extensions Installation** tab, make optional modifications to the configuration of the extension (if needed), and then click **Start Installation**. ++ +image:/images/ks-qkcp/en/v4.0/install-extensions.png[,100%] + +. On the **Cluster Selection** tab, select clusters by name or identifier. Multiple clusters can be selected. + +. On the **Diff Config** tab, edit the selected cluster's YAML file, or leave it unchanged to use the default configuration. Then click **OK** to start configuring the cluster agent. ++ +include::../../../_ks_components-en/admonitions/note.adoc[] + +Some extensions require the installation of a cluster Agent to enable the full functionality of the extension. + +include::../../../_ks_components-en/admonitions/admonEnd.adoc[] + +Once the installation is complete, the extension is enabled by default. You can configure, upgrade, disable, or uninstall extensions in the Extensions Center. \ No newline at end of file diff --git a/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/01-set-configurations.adoc b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/01-set-configurations.adoc new file mode 100644 index 000000000..021bbefbf --- /dev/null +++ b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/01-set-configurations.adoc @@ -0,0 +1,32 @@ +--- +title: "Configure Extensions" +keywords: "Kubernetes, KubeSphere, Configure, Extensions" +description: "Learn how to configure extensions." +weight: 01 +--- + + +This section explains how to configure extensions. + +In addition to configuring extensions during installation, you can also modify the configuration of extensions on the extension details page. + +== Prerequisites + +* You should have the **platform-admin** role on {ks_product-en} platform. For more information, refer to link:../../../05-users-and-roles/01-users/[Users] and link:../../../05-users-and-roles/02-platform-roles/[Platform Roles]. +* You have successfully installed an extension. + +== Steps + +. Log in to the {ks_product-en} web console with a user having the **platform-admin** role. +. Click **Extensions Center**. +. Click the name of the installed extension to enter the extension details page. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] below the extension icon and select **Extension Config**. +. After editing, click **OK**. + +include::../../../../_ks_components-en/admonitions/note.adoc[] + +Click image:/images/ks-qkcp/zh/icons/upload-dark-white.svg[upload-dark,18,18] to upload the configuration file **config.yaml** of the extension from your local device. + +Click image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download-dark,18,18] to download the configuration file **config.yaml** of the extension to your local device. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/02-set-cluster-agents.adoc b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/02-set-cluster-agents.adoc new file mode 100644 index 000000000..5a967247a --- /dev/null +++ b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/02-set-cluster-agents.adoc @@ -0,0 +1,24 @@ +--- +title: "Configure Cluster Agent" +keywords: "Kubernetes, KubeSphere, Set, Configure, Cluster Agent" +description: "Learn how to configure the cluster agent." +weight: 02 +--- + +This section explains how to configure the cluster agent. + +In addition to configuring the cluster agent during extension installation, you can also modify the configuration of the cluster agent on the extension details page. + +== Prerequisites + +* You should have the **platform-admin** role on {ks_product-en} platform. For more information, refer to link:../../../05-users-and-roles/01-users/[Users] and link:../../../05-users-and-roles/02-platform-roles/[Platform Roles]. +* You have successfully installed an extension configured with a cluster agent. + +== Configure Cluster Agent + +. Log in to the {ks_product-en} web console with a user having the **platform-admin** role. +. Click **Extensions Center**. +. Click the name of the installed extension to enter its details page. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] below the extension icon and select **Cluster Agent Configs**. +. Choose clusters and set configurations for them. +. Click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/03-upgrade-components.adoc b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/03-upgrade-components.adoc new file mode 100644 index 000000000..1cf9ab08e --- /dev/null +++ b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/03-upgrade-components.adoc @@ -0,0 +1,22 @@ +--- +title: "Upgrade Extensions" +keywords: "Kubernetes, KubeSphere, Upgrade, Extensions" +description: "Learn how to upgrade extensions." +weight: 03 +--- + +This section explains how to upgrade extensions. + +When there is a new version of an extension, you can upgrade it in the extension details page. + +== Prerequisites + +You should have the **platform-admin** role on {ks_product-en} platform. For more information, refer to link:../../../05-users-and-roles/01-users/[Users] and link:../../../05-users-and-roles/02-platform-roles/[Platform Roles]. + +== Steps + +. Log in to the {ks_product-en} web console with a user having the **platform-admin** role. +. Click **Extensions Center**. +. Click the name of the installed extension to enter its details page. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] below the extension icon and select **Upgrade**. +. In the update dialog, follow the installation process to complete the upgrade. \ No newline at end of file diff --git a/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/04-disable-components.adoc b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/04-disable-components.adoc new file mode 100644 index 000000000..98028207a --- /dev/null +++ b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/04-disable-components.adoc @@ -0,0 +1,25 @@ +--- +title: "Disable Extensions" +keywords: "Kubernetes, KubeSphere, Enable, Disable, Extensions" +description: "Learn how to disable extensions." +weight: 04 +--- + +This section explains how to disable extensions. + +Once an extension is installed, it is automatically enabled. You can disable extensions on the extension details page in the Extensions Center. + +After disabling, you can re-enable the extension to continue using it in the cluster, workspace, or project. + + +== Prerequisites + +You should have the **platform-admin** role on {ks_product-en} platform. For more information, refer to link:../../../05-users-and-roles/01-users/[Users] and link:../../../05-users-and-roles/02-platform-roles/[Platform Roles]. + +== Steps + +. Log in to the {ks_product-en} web console with a user having the **platform-admin** role. +. Click **Extensions Center**. +. Click the name of the installed extension to enter its details page. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] below the extension icon and select **Disable**. +. After disabling, click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18], then select **Enable** to continue using the extension. \ No newline at end of file diff --git a/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/05-uninstall-components.adoc b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/05-uninstall-components.adoc new file mode 100644 index 000000000..2fd173d1b --- /dev/null +++ b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/05-uninstall-components.adoc @@ -0,0 +1,26 @@ +--- +title: "Uninstall Extensions" +keywords: "Kubernetes, KubeSphere, Uninstall, Force Uninstall, Extensions" +description: "Learn how to uninstall extensions." +weight: 05 +--- + +This section explains how to uninstall extensions. + +You can uninstall extensions on the extension details page in the Extensions Center. + +For multi-cluster environments, when uninstalling, the cluster agent will be uninstalled first, followed by the extension. + +== Prerequisites + +You should have the **platform-admin** role on {ks_product-en} platform. For more information, refer to link:../../../05-users-and-roles/01-users/[Users] and link:../../../05-users-and-roles/02-platform-roles/[Platform Roles]. + +== Steps + +. Log in to the {ks_product-en} web console with a user having the **platform-admin** role. +. Click **Extensions Center**. +. Click the name of the installed extension to enter its details page. +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] below the extension icon and select **Uninstall**. +. Enter the extension name, and click **OK** to start uninstallation. + + diff --git a/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/_index.adoc b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/_index.adoc new file mode 100644 index 000000000..cf143c047 --- /dev/null +++ b/content/en/docs/v4.1/06-extension-user-guide/03-manage-components/_index.adoc @@ -0,0 +1,9 @@ +--- +title: "Manage Extensions" +keywords: "Kubernetes, KubeSphere, Management, Extensions" +description: "Learn how to manage extensions." +layout: "second" +weight: 03 +--- + +This section explains how to configure, upgrade, disable, uninstall extensions, and configure cluster agents. \ No newline at end of file diff --git a/content/en/docs/v4.1/06-extension-user-guide/_index.adoc b/content/en/docs/v4.1/06-extension-user-guide/_index.adoc new file mode 100644 index 000000000..a3a30a1d3 --- /dev/null +++ b/content/en/docs/v4.1/06-extension-user-guide/_index.adoc @@ -0,0 +1,14 @@ +--- +title: "Extension Management" +linkTitle: "Extension Management" +keywords: "Kubernetes, KubeSphere, Install extensions, KubeSphere extensions" +description: "Introduction to installing and managing extensions." +layout: "second" +weight: 06 +icon: "/images/docs/common/docs.svg" +--- + +This section explains how to install and manage extensions. + +KubeSphere extensions are built on KubeSphere LuBan to extend and enhance the capabilities of KubeSphere products, further meeting the diverse business needs of enterprises. After the installation of {ks_product-en}, only the core components are enabled by default. Please install extensions in the Extensions Center to fully utilize the capabilities of {ks_product-en}. + diff --git a/content/en/docs/v4.1/07-cluster-management/01-web-console/01-log-in-and-go-to-a-cluster.adoc b/content/en/docs/v4.1/07-cluster-management/01-web-console/01-log-in-and-go-to-a-cluster.adoc new file mode 100644 index 000000000..603c76fa2 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/01-web-console/01-log-in-and-go-to-a-cluster.adoc @@ -0,0 +1,25 @@ +--- +title: "Log In and Access Clusters" +linkTitle: "Log In and Access Clusters" +keywords: "Kubernetes, KubeSphere, Cluster Management, Web Console, Access Cluster" +description: "This section explains how to log in and access a cluster." +weight: 01 +--- + +This section explains how to log in to the {ks_product-en} web console and access a cluster. + +== Prerequisites + +* You should have the username and password of a cluster member. + +include::../../../_custom-en/workspaceManagement/webConsole/webConsole-prer-logIn.adoc[] + +== Steps + +include::../../../_custom-en/workspaceManagement/webConsole/webConsole-oper-logIn.adoc[] + ++ + +. Click **Cluster Management**. + +. Click the name of a cluster in the **Cluster Management** page to access the cluster. diff --git a/content/en/docs/v4.1/07-cluster-management/01-web-console/_index.adoc b/content/en/docs/v4.1/07-cluster-management/01-web-console/_index.adoc new file mode 100644 index 000000000..21394cece --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/01-web-console/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Access Your Cluster" +linkTitle: "Access Your Cluster" +keywords: "Kubernetes, KubeSphere, Cluster Management, Web Console" +description: "Learn how to access clusters in the web console." +layout: "second" +weight: 01 +--- + +This section explains how to access clusters in the {ks_product-en} web console. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/02-overview/01-view-cluster-overall-information.adoc b/content/en/docs/v4.1/07-cluster-management/02-overview/01-view-cluster-overall-information.adoc new file mode 100644 index 000000000..21e670959 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/02-overview/01-view-cluster-overall-information.adoc @@ -0,0 +1,49 @@ +--- +title: "Cluster Overview" +linkTitle: "Cluster Overview" +keywords: "Kubernetes, KubeSphere, Cluster Management, Overview, Cluster Overview" +description: "Learn how to get an overview of the cluster." +weight: 01 +--- + +:ks_permission: **Cluster Settings Viewing** +:ks_navigation: **Overview** + +This section introduces how to get an overview of the cluster. + +== Prerequisites + +include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +== Steps + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + ++ +-- +[%header,cols="1a,4a"] +|=== +| Items | Description + +| Name, Identifier, and Description +| +The right black part displays the current cluster's name, identifiers, and description. + +* The name of the member cluster is set by the user when adding a member cluster. + +* The identifier of the current cluster is displayed to the right of the cluster name. + +| Basic Information +| Displays the provider, Kubernetes version, KubeSphere version, and the visibility of the current cluster to workspaces. + +| Overview +| Displays the resources in the current cluster, such as the number of projects, Pods, Deployments, StatefulSets, DaemonSets, Jobs, CronJobs, Persistent Volume Claims, Services, Ingresses, etc. + +| Tools +| Displays the command-line tool `kubectl` for controlling the current cluster, and the configuration file `kubeconfig` for configuring the access information of the cluster. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/02-overview/_index.adoc b/content/en/docs/v4.1/07-cluster-management/02-overview/_index.adoc new file mode 100644 index 000000000..488e45a9e --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/02-overview/_index.adoc @@ -0,0 +1,9 @@ +--- +title: "Overview" +linkTitle: "Overview" +keywords: "Kubernetes, KubeSphere, Cluster Management, Overview" +description: "Learn how to get an overview of a cluster." +layout: "second" +weight: 02 +--- + diff --git a/content/en/docs/v4.1/07-cluster-management/03-nodes/01-view-a-node-list.adoc b/content/en/docs/v4.1/07-cluster-management/03-nodes/01-view-a-node-list.adoc new file mode 100644 index 000000000..03655e07a --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/03-nodes/01-view-a-node-list.adoc @@ -0,0 +1,55 @@ +--- +title: "View Node List" +linkTitle: "View Node List" +keywords: "Kubernetes, KubeSphere, Cluster Management, Nodes, View Node List" +description: "Learn how to view the list of nodes." +weight: 01 +--- + +:ks_permission: **Node Viewing** + +This section explains how to view the list of nodes. + +== Prerequisites + +include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +== Steps + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] ++ + +include::../../../_custom-en/clusterManagement/nodes/nodes-oper-openListPage_new.adoc[] + ++ +==== +* The node list displays the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Name +|The host names of each node and their IP addresses within the subnet. +The host names of each node are set by users during the cluster installation in the configuration file **config-sample.yaml**. + +|Status +| +include::../../../_custom-en/clusterManagement/nodes/nodes-para-nodeStatus_new.adoc[] + +If there are taints on the nodes, the **Status** column will also display the number of taints on the node. You can hover the cursor over the taint number to view specific information about the taints. For more information, see link:../05-edit-node-taints/[Set Node Taints]. + +|Role +| +include::../../../_custom-en/clusterManagement/nodes/nodes-para-nodeRole_new.adoc[] + +|=== +-- + +* Click the search box at the top of the list to search for nodes by name. + +include::../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/07-cluster-management/03-nodes/02-view-node-details.adoc b/content/en/docs/v4.1/07-cluster-management/03-nodes/02-view-node-details.adoc new file mode 100644 index 000000000..0373ef64c --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/03-nodes/02-view-node-details.adoc @@ -0,0 +1,108 @@ +--- +title: "View Node Details" +linkTitle: "View Node Details" +keywords: "Kubernetes, KubeSphere, Cluster Management, Nodes, View Node Details" +description: "Learn how to view node details." +weight: 02 +--- + +:ks_permission: **Node Viewing** + +This section explains how to view node details. + +== Prerequisites + +include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + +== Steps + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] ++ + +include::../../../_custom-en/clusterManagement/nodes/nodes-oper-openListPage_new.adoc[] + +. Click the name of a node in the list to open its details page. + +. In the **Attributes** area on the left side of the node details page, view the resource attributes of the node. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Status +| +include::../../../_custom-en/clusterManagement/nodes/nodes-para-nodeStatus_new.adoc[] + +|IP Address +|The IP address of the node. + +|Role +| +include::../../../_custom-en/clusterManagement/nodes/nodes-para-nodeRole_new.adoc[] + +|OS Version +|The operating system and its version on the node. + +|OS Type +|The operating system type on the node. + +|Kernel Version +|The kernel version of the node. + +|Container Runtime +|The type and version of the container runtime used on the node. + +|kubelet Version +|The version of kubelet running on the node. + +|kube-proxy Version +|The version of kube-proxy running on the node. + +|Architecture +|The CPU architecture of the node. + +|Creation Time +|The time when the node joined the current cluster. +|=== +-- + +. On the **Health Status** tab on the right side of the node details page, view the health status and taints of the node. ++ +-- +[%header,cols="1a,4a"] +|=== +|Area |Description + +|Health Status +|Displays the node's network, memory, disk, process pressure, and readiness status. If shown as image:/images/ks-qkcp/zh/icons/check-healthy.svg["healthy",15px,15px], it indicates normal status; if shown as image:/images/ks-qkcp/zh/icons/substract-unhealthy.svg["unhealthy",15px,15px], it indicates an alert. + +* **Network Availability**: Whether the network configuration of the node is correct. + +* **Memory Pressure**: Whether the remaining memory on the node is less than the threshold, with the default threshold being 100 MiB. + +* **Disk Pressure**: Whether the remaining disk space or inode count on the node is less than the threshold, with the default disk space threshold being 10% of the total disk space and the default inode count threshold being 5% of the maximum inode count. + +* **PID Pressure**: Whether the number of processes that can be created on the node is less than the threshold. The newly installed KubeSphere cluster does not set a process count threshold by default. + +* **Readiness**: Whether the node is ready to accept pods. + +|Taints +|Taints configured on the current node. For more information, see link:../05-edit-node-taints/[Edit Node Taints]. +|=== +-- + +. Click the **pods** tab on the right side of the node details page to view all the pods running on the node. ++ +-- +include::../../../_custom-en/clusterManagement/nodes/nodes-para-podList.adoc[] +-- + +. Click the **Metadata** tab on the right side of the node details page to view the labels and annotations of the node. + +. Click the **Events** tab on the right side of the node details page to view the event records of the node. ++ +-- +include::../../../_custom-en/clusterManagement/clusterManagement-para-eventsTab.adoc[] +-- diff --git a/content/en/docs/v4.1/07-cluster-management/03-nodes/03-prevent-and-allow-pod-scheduling.adoc b/content/en/docs/v4.1/07-cluster-management/03-nodes/03-prevent-and-allow-pod-scheduling.adoc new file mode 100644 index 000000000..6e3f009ff --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/03-nodes/03-prevent-and-allow-pod-scheduling.adoc @@ -0,0 +1,34 @@ +--- +title: "Prevent and Allow Pod Scheduling" +linkTitle: "Prevent and Allow Pod Scheduling" +keywords: "Kubernetes, KubeSphere, Cluster Management, Nodes, Cluster Nodes, Pod Scheduling" +description: "Learn how to prevent and allow pod scheduling." +weight: 03 +--- + +:ks_permission: **Node Management** + +This section explains how to prevent pods from being scheduled to nodes. + +== Prerequisites + +include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +== Steps + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../_custom-en/clusterManagement/nodes/nodes-oper-openListPage_new.adoc[] + +. Click image:/images/ks-qkcp/zh/icons/more.svg["More",18,18] on the right side of a node, and select **Cordon** from the dropdown list. The node status will change to **Unschedulable**. + +. On the right side of the node with the status **Unschedulable**, Click image:/images/ks-qkcp/zh/icons/more.svg["More",18,18], and then select **Uncordon** from the dropdown list to allow pods to be scheduled to this node. + +// Note +include::../../../../_ks_components-en/admonitions/note.adoc[] + +When the node status is changed to **Unschedulable**, newly created pods will no longer be scheduled to this node, and existing pods running on the node will not be affected. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/03-nodes/04-access-a-node-terminal.adoc b/content/en/docs/v4.1/07-cluster-management/03-nodes/04-access-a-node-terminal.adoc new file mode 100644 index 000000000..b69c8f615 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/03-nodes/04-access-a-node-terminal.adoc @@ -0,0 +1,34 @@ +--- +title: "Access Node Terminal" +linkTitle: "Access Node Terminal" +keywords: "Kubernetes, KubeSphere, Cluster Management, Nodes, Access Node Terminal" +description: "Explain how to access the terminal on nodes." +weight: 04 +--- + +:ks_permission: **Node Management** + + +This section explains how to use the terminal on nodes. + +== Prerequisites + +include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +== Steps + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../_custom-en/clusterManagement/nodes/nodes-oper-openListPage_new.adoc[] + +. Click image:/images/ks-qkcp/zh/icons/more.svg["More",18,18] on the right side of a node, and select **Open Terminal** from the dropdown list. The terminal window will pop up. ++ +-- +include::../../../../_ks_components-en/admonitions/note.adoc[] + +When opening the terminal for the first time, you may encounter a lack of permissions due to related services not being started. If you have this problem, please try again later. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/03-nodes/05-edit-node-taints.adoc b/content/en/docs/v4.1/07-cluster-management/03-nodes/05-edit-node-taints.adoc new file mode 100644 index 000000000..73a9dcc1d --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/03-nodes/05-edit-node-taints.adoc @@ -0,0 +1,65 @@ +--- +title: "Edit Node Taints" +linkTitle: "Edit Node Taints" +keywords: "Kubernetes, KubeSphere, Cluster Management, Nodes, Edit Node Taints" +description: "Explain how to edit node taints." +weight: 05 +--- + +:ks_permission: **Node Management** + +This section details how to edit node taints. + +Taints are labels created by users on nodes, used in conjunction with tolerations created on pods. When a node has a taint, based on the configured taint effect, all pods with tolerations that do not match the taint will either be prevented from scheduling to the node or will be avoided from being scheduled to the node as much as possible. + +A taint consists of three parts: key, value, and effect. The tolerations of pods must match the key, value, and effect of the taint, so that the pod can be unaffected by the taint. + +// Note +include::../../../../_ks_components-en/admonitions/note.adoc[] + +KubeSphere currently does not support editing pod tolerations. Therefore, by default, node taints take effect on all pods. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] + +== Prerequisites + +include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +== Steps + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../_custom-en/clusterManagement/nodes/nodes-oper-openListPage_new.adoc[] + +. Select the checkbox next to a node, then click **Edit Taints** above the node list. + +. In the **Edit Taints** dialog, set the key, value, and effect of the taint, then click **OK**. ++ +-- +You can choose one of the following effects for a taint: + +[%header,cols="1a,4a"] +|=== +|Taint Effect |Description + +|Prevent scheduling +|Pods with tolerations that do not match the taint will be prevented from scheduling to the node, existing pods on the node remain unaffected. + +|Prevent scheduling if possible +|Pods with tolerations that do not match the taint will be prevented from scheduling to the node as much as possible, existing pods on the node remain unaffected. + +|Prevent scheduling and evict existing pods +|Pods with tolerations that do not match the taint will be prevented from scheduling to the node, existing pods on the node will be immediately evicted if their tolerations do not match the taint. +|=== + +// Note +include::../../../../_ks_components-en/admonitions/note.adoc[] + +* Click **Add** to set multiple taints for a node. + +* If you are editing taints for multiple nodes simultaneously, you can set common taints for multiple nodes as well as individual taints for each node. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/03-nodes/06-edit-node-labels.adoc b/content/en/docs/v4.1/07-cluster-management/03-nodes/06-edit-node-labels.adoc new file mode 100644 index 000000000..379686181 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/03-nodes/06-edit-node-labels.adoc @@ -0,0 +1,40 @@ +--- +title: "Edit Node Labels" +linkTitle: "Edit Node Labels" +keywords: "Kubernetes, KubeSphere, Cluster Management, Nodes, Edit Node Labels" +description: "Explain how to edit node labels." +weight: 06 +--- + +:ks_permission: **Node Management** + +This section explains how to edit node labels. + +Node labels are key-value pairs set by users on nodes and can be used for node selection. For example, when creating workloads, you can specify that a pod should be scheduled on nodes with specific labels. + +== Prerequisites + +include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +== Steps + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../_custom-en/clusterManagement/nodes/nodes-oper-openListPage_new.adoc[] + +. In the node list, click the name of the node you want to edit to open the node details page. + +. In the top left corner of the node details page, select **More > Edit Labels**. + +. In the **Edit Labels** dialog, set the key and value of the node label, then click **OK**. ++ +-- +// Note +include::../../../../_ks_components-en/admonitions/note.adoc[] + +Click **Add** to set multiple labels for a node. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/03-nodes/_index.adoc b/content/en/docs/v4.1/07-cluster-management/03-nodes/_index.adoc new file mode 100644 index 000000000..06e634a7d --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/03-nodes/_index.adoc @@ -0,0 +1,14 @@ +--- +title: "Nodes" +linkTitle: "Nodes" +keywords: "Kubernetes, KubeSphere, Cluster Management, Nodes" +description: "Learn how to manage nodes." +layout: "second" +weight: 03 +--- + +This section explains how to manage cluster nodes. + +KubeSphere supports multiple cluster nodes, and typically, all nodes belong to the same private network. + + diff --git a/content/en/docs/v4.1/07-cluster-management/04-projects/01-create-a-project.adoc b/content/en/docs/v4.1/07-cluster-management/04-projects/01-create-a-project.adoc new file mode 100644 index 000000000..b80e97cf2 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/04-projects/01-create-a-project.adoc @@ -0,0 +1,54 @@ +--- +title: "Create Projects" +linkTitle: "Create Projects" +keywords: "Kubernetes, KubeSphere, Cluster Management, Projects, Create Projects" +description: "Explain how to create projects in a cluster." +weight: 01 +--- + +:ks_permission: **Project Management** +:ks_navigation: **Projects** + +This section explains how to create projects in a cluster. + +== Prerequisites + +include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +== Steps + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_ks_components-en/oper-clickCreate.adoc[] + +. In the **Create Project** dialog, set the parameters for the project, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +include::../../../_custom-en/clusterManagement/projects/projects-para-name.adoc[] + +include::../../../_custom-en/clusterManagement/projects/projects-para-aliasDescription.adoc[] +|=== +-- + +. In the project list, click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the newly created project, then select **Assign Workspace** from the dropdown list. + +. In the **Assign Workspace** dialog, select a workspace to which the project belongs, and choose a member as the project administrator, then click **OK**. + +// Note +include::../../../../_ks_components-en/admonitions/note.adoc[] + +* Once a project is assigned to a workspace, you are not allowed to change its workspace. + +* Once the project is created, you can invite users to join the project and deploy services within it. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/04-projects/02-view-a-project-list.adoc b/content/en/docs/v4.1/07-cluster-management/04-projects/02-view-a-project-list.adoc new file mode 100644 index 000000000..a1573ee6c --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/04-projects/02-view-a-project-list.adoc @@ -0,0 +1,51 @@ +--- +title: "View Project List" +linkTitle: "View Project List" +keywords: "Kubernetes, KubeSphere, Cluster Management, Project, View Project List" +description: "Learn how to view the project list in a cluster." +weight: 02 +--- + +:ks_permission: **Project Viewing** +:ks_navigation: **Projects** + +This section introduces how to view the project list in a cluster. + +== Prerequisites + +include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +== Steps + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../_custom-en/clusterManagement/projects/projects-oper-openListPage.adoc[] + ++ +==== +* The project list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +include::../../../_custom-en/workspaceManagement/projects/projects-para-projectList_new.adoc[] + +|Workspace +|The workspace to which the project belongs. +|=== +-- + +include::../../../_custom-en/workspaceManagement/projects/projects-oper-searchForProjects.adoc[] + +include::../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/04-projects/03-view-project-details.adoc b/content/en/docs/v4.1/07-cluster-management/04-projects/03-view-project-details.adoc new file mode 100644 index 000000000..7f09642b0 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/04-projects/03-view-project-details.adoc @@ -0,0 +1,84 @@ +--- +title: "View Project Details" +linkTitle: "View Project Details" +keywords: "Kubernetes, KubeSphere, Cluster Management, Project, View Project Details" +description: "Learn how to view project details." +weight: 03 +--- + +:ks_permission: **Project Viewing** +:ks_navigation: **Projects** + +This section explains how to view project details. + +== Prerequisites + +include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + +== Steps + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../_custom-en/clusterManagement/projects/projects-oper-openListPage.adoc[] + ++ + +include::../../../_custom-en/clusterManagement/projects/projects-oper-openDetailsPage.adoc[] + +. In the **Attributes** area on the left side of the project details page, view the resource attributes of the project. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Status +| +include::../../../_custom-en/clusterManagement/projects/projects-para-status.adoc[] + +|Cluster +|The cluster to which the project belongs. + +|Workspace +|The workspace to which the project belongs. + +|Creation Time +|The creation time of the project. + +|Creator +|The user who created the project. +|=== +-- + +. On the **Overview** tab on the right side of the project details page, view the current resource status of the project, such as the number of Pods, Deployments, StatefulSets, DaemonSets, Jobs, CronJobs, Persistent Volume Claims, Services, and Ingresses. + +. On the **Pods** tab on the right side of the project details page, view all the pods running in the project. ++ +-- +include::../../../_custom-en/clusterManagement/nodes/nodes-para-podList.adoc[] +-- + +. On the right side of the project details page, click **Quotas** to view the project's quota information. ++ +-- +[%header,cols="1a,4a"] +|=== +|Area |Description + +include::../../../_custom-en/clusterManagement/projects/projects-para-defaultContainerQuotas.adoc[] + +|Project Quotas +|The quantity and actual usage of available resources in the project, including CPU, memory, pods, and deployments, etc. +|=== + +For information on how to set default container quotas and project quotas, refer to link:../07-edit-default-container-quotas/[Edit Default Container Quotas] and link:../06-edit-project-quotas/[Edit Project Quotas]. +-- + +. On the right side of the project details page, click **Metadata** to view the labels and annotations of the project. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/04-projects/04-edit-project-information.adoc b/content/en/docs/v4.1/07-cluster-management/04-projects/04-edit-project-information.adoc new file mode 100644 index 000000000..4e8299c34 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/04-projects/04-edit-project-information.adoc @@ -0,0 +1,48 @@ +--- +title: "Edit Project Information" +linkTitle: "Edit Project Information" +keywords: "Kubernetes, KubeSphere, Cluster Management, Project, Edit Project Information" +description: "Learn how to edit project information." +weight: 04 +--- + +:ks_permission: **Project Management** +:ks_navigation: **Projects** + + +include::../../../_custom-en/clusterManagement/projects/projects-desc-editInformation.adoc[] + +include::../../../_custom-en/clusterManagement/projects/projects-note-editInformation.adoc[] + + +== Prerequisites + +include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + +== Steps + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. On the right side of the project you want to edit, click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18], and then select **Edit** from the drop-down list. + +. In the **Edit Information** dialog, set the alias and description for the project, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Alias +|The alias of the project. Aliases can be the same for different projects. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), and cannot start or end with a hyphen (-). It has a maximum length of 63 characters. + +|Description +|The description of the project. The description can contain any characters, with a maximum length of 256 characters. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/04-projects/05-edit-project-annotations.adoc b/content/en/docs/v4.1/07-cluster-management/04-projects/05-edit-project-annotations.adoc new file mode 100644 index 000000000..4edde3c46 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/04-projects/05-edit-project-annotations.adoc @@ -0,0 +1,39 @@ +--- +title: "Edit Project Annotations" +linkTitle: "Edit Project Annotations" +keywords: "Kubernetes, KubeSphere, Cluster Management, Project, Edit Project Annotations" +description: "Introduction to editing project annotations." +weight: 05 +--- + +:ks_permission: **Project Management** +:ks_navigation: **Projects** + +This section explains how to edit project annotations. + +Project annotations are key-value pairs used to add additional metadata or descriptive information to a project. + + +== Prerequisites + + +include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + +== Steps + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + +. On the right side of the project you want to edit, click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18], and then select **Edit Annotations** from the drop-down list. + +. In the **Edit Annotations** dialog, configure the key-value pair, and then click **OK**. ++ +-- +* Click **Add** to set multiple annotations. + +* To delete an existing annotation, click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] to the right of it. +-- diff --git a/content/en/docs/v4.1/07-cluster-management/04-projects/06-edit-project-quotas.adoc b/content/en/docs/v4.1/07-cluster-management/04-projects/06-edit-project-quotas.adoc new file mode 100644 index 000000000..0a284f98f --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/04-projects/06-edit-project-quotas.adoc @@ -0,0 +1,37 @@ +--- +title: "Edit Project Quotas" +linkTitle: "Edit Project Quotas" +keywords: "Kubernetes, KubeSphere, Cluster Management, Project, Edit Project Quotas" +description: "Learn how to edit project quotas." +weight: 06 +--- + +:ks_permission: **Project Management** +:ks_navigation: **Projects** + + +include::../../../_custom-en/clusterManagement/projects/projects-desc-editQuotas.adoc[] + + +== Prerequisites + +include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + +== Steps + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../_custom-en/clusterManagement/projects/projects-oper-openDetailsPage.adoc[] + +. In the upper-left corner of the project details page, click **More > Edit Project Quotas**. + ++ + +include::../../../_custom-en/clusterManagement/projects/projects-oper-editProjectQuotas.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/04-projects/07-edit-default-container-quotas.adoc b/content/en/docs/v4.1/07-cluster-management/04-projects/07-edit-default-container-quotas.adoc new file mode 100644 index 000000000..7354bf570 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/04-projects/07-edit-default-container-quotas.adoc @@ -0,0 +1,36 @@ +--- +title: "Edit Default Container Quotas" +linkTitle: "Edit Default Container Quotas" +keywords: "Kubernetes, KubeSphere, Cluster Management, Project, Edit Default Container Quotas" +description: "Learn how to edit default container quotas." +weight: 07 +--- + +:ks_permission: **Project Management** +:ks_navigation: **Projects** + +include::../../../_custom-en/clusterManagement/projects/projects-desc-editDefaultContainerQuotas.adoc[] + + +== Prerequisites + +include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + +== Steps + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../_custom-en/clusterManagement/projects/projects-oper-openDetailsPage.adoc[] + +. In the upper-left corner of the project details page, click **More > Edit Default Container Quotas**. + ++ + +include::../../../_custom-en/clusterManagement/projects/projects-oper-editDefaultContainerQuotas.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/04-projects/08-delete-projects.adoc b/content/en/docs/v4.1/07-cluster-management/04-projects/08-delete-projects.adoc new file mode 100644 index 000000000..75a968ddc --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/04-projects/08-delete-projects.adoc @@ -0,0 +1,44 @@ +--- +title: "Delete Projects" +linkTitle: "Delete Projects" +keywords: "Kubernetes, KubeSphere, Cluster Management, Project, Delete Project" +description: "Learn how to delete projects." +weight: 08 +--- + +:ks_permission: **Project Management** +:ks_navigation: **Projects** + + +include::../../../_custom-en/clusterManagement/projects/projects-desc-deleteProjects.adoc[] + + +== Prerequisites + +include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + +== Delete a Single Project + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../_custom-en/clusterManagement/projects/projects-oper-deleteASingleProject.adoc[] + + +== Delete Multiple Projects + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../_custom-en/clusterManagement/projects/projects-oper-deleteMultipleProjects.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/04-projects/_index.adoc b/content/en/docs/v4.1/07-cluster-management/04-projects/_index.adoc new file mode 100644 index 000000000..f32e9ad5b --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/04-projects/_index.adoc @@ -0,0 +1,16 @@ +--- +title: "Projects" +linkTitle: "Projects" +keywords: "Kubernetes, KubeSphere, Cluster Management, Projects" +description: "Introduce how to manage projects in a cluster." +layout: "second" +weight: 04 +--- + +This section explains how to manage projects in a cluster. + +In KubeSphere, projects are used to group and manage resources. You can create resources within a project, invite users to join the project, and set different permissions for different users. There are two types of projects in KubeSphere: + +- User Projects: Projects created by users for managing their resources. + +- System Projects: Projects automatically created by KubeSphere for managing system resources. It is generally not recommended to create user resources in the system projects. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/01-create-a-workload.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/01-create-a-workload.adoc new file mode 100644 index 000000000..f62a75bd9 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/01-create-a-workload.adoc @@ -0,0 +1,247 @@ +--- +title: "Create Workloads" +linkTitle: "Create Workloads" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Workloads, Create Workloads" +description: "Introduction to creating workloads." +weight: 01 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Workloads** + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-createAWorkload.adoc[] + + +== Prerequisites + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + +== Steps + +Please refer to link:#_parameter_description[Parameter Description] for configuring the parameters of a workload. + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-createAWorkload.adoc[] + + +== Parameter Description + +The following explains how to configure parameters for the workload. + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-basicInformation.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podReplicas.adoc[] + +* Pod Settings > Add Container ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] +-- + + +* Pod Settings > Add Container > Container Settings ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] + + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] + +include::../../../../_custom-en/clusterManagement/projects/projects-para-containerQuotas.adoc[] +|=== +-- + +* Pod Settings > Add Container > Port Settings ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] +-- + +* Pod Settings > Add Container > Image Pull Policy ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] +-- + +* Pod Settings > Add Container > Health Check ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] +-- + +* Pod Settings > Add Container > Health Check > Add Probe ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc[] +-- + +* Pod Settings > Add Container > Lifecycle Management ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] +-- + +* Pod Settings > Add Container > Lifecycle Management > Add Action ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] +-- + +* Pod Settings > Add Container > Start Command ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] +-- + +* Pod Settings > Add Container > Environment Variables ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] +-- + +* Pod Settings > Add Container > Container Security Context ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] +-- + +* Pod Settings > Add Container > Synchronize Host Timezone ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] +-- + +* Pod Settings > Update Strategy ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc[] +-- + +* Pod Settings > Update Policy > Rolling Update Settings ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc[] +-- + +* Pod Settings > Pod Security Context ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podSecurityContext.adoc[] +-- + +* Pod Settings > Pod Scheduling Rules ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc[] +-- + +* Pod Settings > Pod Scheduling Rules > Custom Rules ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc[] +-- + +* Pod Settings > Pod Graceful Period ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc[] +-- + +* Pod Settings > Add Metadata ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-PodMetadata.adoc[] +-- + +* Storage Settings ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] +|=== + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume.adoc[] +-- + +* Storage Settings > Add Persistent Volume Claim Template ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc[] +-- + +* Storage Settings > Mount Volume > Persistent Volume ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] +-- + +* Storage Settings > Mount Volume > Temporary Volume ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume_new.adoc[] +-- + +* Storage Settings > Mount Volume > HostPath Volume ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] +-- + +* Storage Settings > Mount ConfigMap or Secret ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] +-- + +* Advanced Settings ++ +-- +Specify nodes for the pods managed by the workload and set metadata for the workload. + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc[] + +| Add Metadata +| +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-setWorkloadMetadata.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc[] +|=== +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/02-view-a-workload-list.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/02-view-a-workload-list.adoc new file mode 100644 index 000000000..ef31d0ad4 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/02-view-a-workload-list.adoc @@ -0,0 +1,43 @@ +--- +title: "View Workload List" +linkTitle: "View Workload List" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Workloads, View Workload List" +description: "Learn how to view the list of workloads." +weight: 02 +--- + +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Workloads** + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-viewAWorkloadList.adoc[] + +== Prerequisites + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openListPage.adoc[] + ++ +==== +include::../../../../_custom-en/clusterManagement/workloads/workloads-para-workloadList.adoc[] + +* In the dropdown list at the top left of the list, select a project to view the workloads of that project. + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-searchForWorkloads.adoc[] + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/03-view-workload-details.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/03-view-workload-details.adoc new file mode 100644 index 000000000..084f22204 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/03-view-workload-details.adoc @@ -0,0 +1,34 @@ +--- +title: "View Workload Details" +linkTitle: "View Workload Details" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Workloads, View Workload Details" +description: "Learn how to view workload details." +weight: 03 +--- + +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Workloads** + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-viewWorkloadDetails.adoc[] + +== Prerequisites + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-viewWorkloadDetails_new.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/04-edit-workload-information.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/04-edit-workload-information.adoc new file mode 100644 index 000000000..024273d8c --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/04-edit-workload-information.adoc @@ -0,0 +1,35 @@ +--- +title: "Edit Workload Information" +linkTitle: "Edit Workload Information" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Workloads, Edit Workload Information" +description: "Learn how to edit workload information." +weight: 04 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Workloads** + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-editWorkloadInformation.adoc[] + + +== Prerequisites + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-editWorkloadInformation.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/06-adjust-the-number-of-pod-replicas.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/06-adjust-the-number-of-pod-replicas.adoc new file mode 100644 index 000000000..b6f576054 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/06-adjust-the-number-of-pod-replicas.adoc @@ -0,0 +1,37 @@ +--- +title: "Adjust Pod Replicas Count" +linkTitle: "Adjust Pod Replicas Count" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Workloads, Adjust Pod Replicas" +description: "Learn how to adjust the replica count of pods in a workload." +weight: 06 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Workloads** + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-adjustTheNumberOfPodReplicas.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-adjustTheNumberOfPodReplicas.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/07-re-create-a-workload.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/07-re-create-a-workload.adoc new file mode 100644 index 000000000..57fbd90fa --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/07-re-create-a-workload.adoc @@ -0,0 +1,37 @@ +--- +title: "Recreate Workloads" +linkTitle: "Recreate Workloads" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Workloads, Recreate Workload" +description: "Learn how to recreate a workload." +weight: 07 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Workloads** + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-recreateAWorkload.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-recreateAWorkload.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/08-roll-back-workload-settings.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/08-roll-back-workload-settings.adoc new file mode 100644 index 000000000..0cf57ef8b --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/08-roll-back-workload-settings.adoc @@ -0,0 +1,38 @@ +--- +title: "Roll Back Workload Settings" +linkTitle: "Roll Back Workload Settings" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Workloads, Rollback Workload Settings" +description: "Learn how to rollback workload settings." +weight: 08 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Workloads** + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-rollBackWorkloadSettings.adoc[] + + +== Prerequisites + +* {empty} +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/workloads-prer-workloadEdited.adoc[] + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-rollBackWorkloadSettings.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/09-edit-auto-scaling-settings.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/09-edit-auto-scaling-settings.adoc new file mode 100644 index 000000000..bdc26c9b0 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/09-edit-auto-scaling-settings.adoc @@ -0,0 +1,37 @@ +--- +title: "Edit Autoscaling Settings" +linkTitle: "Edit Autoscaling Settings" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Workloads, Edit Autoscaling" +description: "Learn how to edit autoscaling settings for workloads." +weight: 09 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Workloads** + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-editAutoScaling.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-editAutoScalingSettings.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/10-edit-workload-settings.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/10-edit-workload-settings.adoc new file mode 100644 index 000000000..a2bc848ec --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/10-edit-workload-settings.adoc @@ -0,0 +1,189 @@ +--- +title: "Edit Workload Settings" +linkTitle: "Edit Workload Settings" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Workloads, Edit Workload Settings" +description: "Learn how to edit settings for created workloads." +weight: 10 +--- + + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Workloads** + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-editWorkloadSettings.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-editWorkloadSettings.adoc[] + ++ + +. In the **Edit Settings** dialog, set the workload's update strategy, containers, storage, pod scheduling rules (not available for DaemonSets), and pod graceful period. Then, click **OK**. For specific parameter settings, refer to link:#_Parameter_Description[Parameter Description]. + + +== Parameter Description + +* Update Strategy ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc[] +-- + +* Update Strategy > Rolling Update Settings ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc[] +-- + +* Containers > Add Container ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] +-- + +* Containers > Container Settings ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] + +include::../../../../_custom-en/clusterManagement/projects/projects-para-containerQuotas.adoc[] +|=== +-- + +* Containers > Container Settings > Port Settings ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] +-- + +* Containers > Container Settings > Image Pull Policy ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] +-- + +* Containers > Container Settings > Health Check ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] +-- + +* Containers > Container Settings > Lifecycle Management ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] +-- + +* Containers > Container Settings > Start Command ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] +-- + +* Containers > Container Settings > Environment Variables ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] +-- + +* Containers > Container Settings > Container Security Context ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] +-- + +* Containers > Container Settings > Synchronize Host Timezone ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] +-- + +* Storage ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] +|=== + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume_new.adoc[] +-- + +* Storage > Mount Volume > Persistent Volume ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] +-- + +* Storage > Mount Volume > Temporary Volume ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume_new.adoc[] +-- + +* Storage > Mount Volume > HostPath Volume ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] +-- + +* Storage > Mount ConfigMap or Secret ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] +-- + +* Pod Scheduling Rules ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc[] +-- + +* Pod Scheduling Rules > Custom Rules ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc[] +-- + +* Pod Graceful Period ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc[] +-- diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/11-stop-workloads.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/11-stop-workloads.adoc new file mode 100644 index 000000000..80c73a3ff --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/11-stop-workloads.adoc @@ -0,0 +1,37 @@ +--- +title: "Stop Workloads" +linkTitle: "Stop Workloads" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Workloads, Stop Workloads" +description: "Learn how to stop workloads." +weight: 11 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Workloads** + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-stopWorkloads.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-stopWorkloads.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/12-delete-workloads.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/12-delete-workloads.adoc new file mode 100644 index 000000000..ccbc9a520 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/12-delete-workloads.adoc @@ -0,0 +1,59 @@ +--- +title: "Delete Workloads" +linkTitle: "Delete Workloads" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Workloads, Delete Workload" +description: "Learn how to delete a workload." +weight: 12 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Workloads** + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-deleteWorkloads.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Delete a Single Workload + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-deleteASingleWorkload.adoc[] + ++ + +. In the **Delete Workload** dialog, confirm and select the names of the resources related to the workloads to be deleted, then click **OK**. + + +== Delete Multiple Workloads + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-deleteMultipleWorkloads.adoc[] + diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/_index.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/_index.adoc new file mode 100644 index 000000000..24d4cf164 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "Workloads" +linkTitle: "Workloads" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Workloads" +description: "Introduction to managing workloads." +layout: "second" +weight: 01 +--- + + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-workloads.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/01-create-a-job.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/01-create-a-job.adoc new file mode 100644 index 000000000..b0327876f --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/01-create-a-job.adoc @@ -0,0 +1,200 @@ +--- +title: "Create Jobs" +linkTitle: "Create Jobs" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Job, Create Job" +description: "Learn how to create jobs." +weight: 01 +--- + + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Jobs** + + +include::../../../../_custom-en/clusterManagement/jobs/jobs-desc-createAJob.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +Please refer to link:#_Parameter_Description[Parameter Description] for configuring job parameters. + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-openListPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-createAJob.adoc[] + + +== Parameter Description + +The following explains how to configure parameters for the job. + +include::../../../../_custom-en/clusterManagement/jobs/jobs-para-basicInformation.adoc[] + +include::../../../../_custom-en/clusterManagement/jobs/jobs-para-strategySettings.adoc[] + +include::../../../../_custom-en/clusterManagement/jobs/jobs-para-restartPolicy.adoc[] + +* Pod Settings > Add Container ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] +-- + +* Pod Settings > Add Container > Container Settings ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] + +include::../../../../_custom-en/clusterManagement/projects/projects-para-containerQuotas.adoc[] +|=== +-- + +* Pod Settings > Add Container > Port Settings ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] +-- + +* Pod Settings > Add Container > Image Pull Policy ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] +-- + +* Pod Settings > Add Container > Health Check ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] +-- + +* Pod Settings > Add Container > Health Check > Add Probe ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc[] +-- + +* Pod Settings > Add Container > Lifecycle Management ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] +-- + +* Pod Settings > Add Container > Lifecycle Management > Add Action ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] +-- + +* Pod Settings > Add Container > Start Command ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] +-- + +* Pod Settings > Add Container > Environment Variables ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] +-- + +* Pod Settings > Add Container > Container Security Context ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] +-- + +* Pod Settings > Add Container > Synchronize Host Timezone ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] +-- + +* Storage Settings ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] +|=== + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume_new.adoc[] +-- + +* Storage Settings > Mount Volume > Persistent Volume ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] +-- + +* Storage Settings > Mount Volume > Temporary Volume ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume_new.adoc[] +-- + +* Storage Settings > Mount Volume > HostPath Volume ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] +-- + +* Storage Settings > Mount ConfigMap or Secret ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] +-- + +* Advanced Settings ++ +-- +Specify nodes for the pods managed by the job and set metadata for the job. + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc[] + +| Add Metadata +| +include::../../../../_custom-en/clusterManagement/jobs/jobs-desc-setJobMetadata.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc[] +|=== +-- diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/02-view-a-job-list.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/02-view-a-job-list.adoc new file mode 100644 index 000000000..b3528178c --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/02-view-a-job-list.adoc @@ -0,0 +1,44 @@ +--- +title: "View Job List" +linkTitle: "View Job List" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Job, View Job List" +description: "Learn how to view the job list." +weight: 02 +--- + +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Jobs** + + +include::../../../../_custom-en/clusterManagement/jobs/jobs-desc-viewAJobList.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-openListPage.adoc[] ++ +==== +include::../../../../_custom-en/clusterManagement/jobs/jobs-para-jobList.adoc[] + +* Choose a project from the drop-down list at the top left of the list to view jobs specific to that project. + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-searchForJobs.adoc[] + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/03-view-job-details.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/03-view-job-details.adoc new file mode 100644 index 000000000..7d6df9ae4 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/03-view-job-details.adoc @@ -0,0 +1,37 @@ +--- +title: "View Job Details" +linkTitle: "View Job Details" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Job, View Job Details" +description: "Learn how to view job details." +weight: 03 +--- + +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Jobs** + + +include::../../../../_custom-en/clusterManagement/jobs/jobs-desc-viewJobDetails.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-viewJobDetails_new.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/04-edit-job-information.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/04-edit-job-information.adoc new file mode 100644 index 000000000..f69c9fc7e --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/04-edit-job-information.adoc @@ -0,0 +1,38 @@ +--- +title: "Edit Job Information" +linkTitle: "Edit Job Information" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application jobs, Job, Edit Job Information" +description: "Learn how to edit job information." +weight: 04 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Jobs** + + +include::../../../../_custom-en/clusterManagement/jobs/jobs-desc-editJobInformation.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-openListPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-editJobInformation.adoc[] + diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/05-delete-jobs.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/05-delete-jobs.adoc new file mode 100644 index 000000000..9006b6504 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/05-delete-jobs.adoc @@ -0,0 +1,54 @@ +--- +title: "Delete Jobs" +linkTitle: "Delete Jobs" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Jobs, Delete Job" +description: "Learn how to delete a job." +weight: 05 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Jobs** + + +include::../../../../_custom-en/clusterManagement/jobs/jobs-desc-deleteJobs.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Delete a Single Job + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-openListPage.adoc[] + ++ +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-deleteASingleJob.adoc[] + + + +== Delete Multiple Jobs + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-openListPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-deleteMultipleJobs.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/06-re-run-a-job.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/06-re-run-a-job.adoc new file mode 100644 index 000000000..a67e5e464 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/06-re-run-a-job.adoc @@ -0,0 +1,34 @@ +--- +title: "Re-run Jobs" +linkTitle: "Re-run Jobs" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Job, Re-run Job" +description: "Instructions on how to re-run a job." +weight: 06 +--- + + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Jobs** + + +include::../../../../_custom-en/clusterManagement/jobs/jobs-desc-rerunAJob.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-rerunAJob.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/07-pause-a-cronjob.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/07-pause-a-cronjob.adoc new file mode 100644 index 000000000..09806c2c4 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/07-pause-a-cronjob.adoc @@ -0,0 +1,38 @@ +--- +title: "Pause CronJobs" +linkTitle: "Pause CronJobs" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Jobs, Pause CronJob" +description: "Instructions on how to pause a CronJob." +weight: 07 +--- + + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Jobs** + + +include::../../../../_custom-en/clusterManagement/jobs/jobs-desc-pauseACronjob.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. On the **Jobs** page, click **Cronjobs** to open the list of scheduled jobs. + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-pauseACronjob.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/_index.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/_index.adoc new file mode 100644 index 000000000..338b4c2a1 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "Jobs" +linkTitle: "Jobs" +keywords: "Kubernetes, KubeSphere, Cluster Management, Jobs" +description: "Learn how to manage jobs." +layout: "second" +weight: 02 +--- + + + +include::../../../../_custom-en/clusterManagement/jobs/jobs-desc-jobs.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/01-view-a-pod-list.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/01-view-a-pod-list.adoc new file mode 100644 index 000000000..4c654dd35 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/01-view-a-pod-list.adoc @@ -0,0 +1,42 @@ +--- +title: "View Pod List" +linkTitle: "View Pod List" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Pods, Viewing Pod Lists" +description: "Explain how to view the list of pods." +weight: 01 +--- + + +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Pods** + + +include::../../../../_custom-en/clusterManagement/pods/pods-desc-viewAPodList.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +==== +include::../../../../_custom-en/clusterManagement/pods/pods-para-podList.adoc[] + +* Choose a project from the drop-down list at the top left of the list to view pods specific to that project. + +include::../../../../_custom-en/clusterManagement/pods/pods-oper-searchForPods.adoc[] + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/02-view-pod-details.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/02-view-pod-details.adoc new file mode 100644 index 000000000..ca2e21ba3 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/02-view-pod-details.adoc @@ -0,0 +1,38 @@ +--- +title: "View Pod Details" +linkTitle: "View Pod Details" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Pods, Viewing Pod Details" +description: "Explain how to view the details of a pod." +weight: 02 +--- + + +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Pods** + + +include::../../../../_custom-en/clusterManagement/pods/pods-desc-viewPodDetails.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/pods/pods-oper-openDetails.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/pods/pods-oper-viewPodDetails_new.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/03-view-container-details.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/03-view-container-details.adoc new file mode 100644 index 000000000..16edbf574 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/03-view-container-details.adoc @@ -0,0 +1,38 @@ +--- +title: "View Container Details" +linkTitle: "View Container Details" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Pods, View Container Details" +description: "Learn how to view container details." +weight: 03 +--- + + +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Pods** + + +include::../../../../_custom-en/clusterManagement/pods/pods-desc-viewContainerDetails.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/pods/pods-oper-openDetails.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/pods/pods-oper-viewContainerDetails_new.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/04-access-a-container-terminal.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/04-access-a-container-terminal.adoc new file mode 100644 index 000000000..20b218412 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/04-access-a-container-terminal.adoc @@ -0,0 +1,38 @@ +--- +title: "Access Container Terminal" +linkTitle: "Access Container Terminal" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Pods, Access Container Terminal" +description: "Learn how to access the container terminal." +weight: 04 +--- + + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Pods** + + +include::../../../../_custom-en/clusterManagement/pods/pods-desc-accessAContainerTerminal.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/pods/pods-oper-openDetails.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/pods/pods-oper-accessAContainerTerminal.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/05-delete-pods.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/05-delete-pods.adoc new file mode 100644 index 000000000..2493230b8 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/05-delete-pods.adoc @@ -0,0 +1,46 @@ +--- +title: "Delete Pods" +linkTitle: "Delete Pods" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Pods, Delete Pods" +description: "Learn how to delete a pod." +weight: 05 +--- + + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Pods** + +include::../../../../_custom-en/clusterManagement/pods/pods-desc-deletePods.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Delete a Single Pod + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/pods/pods-oper-deleteASinglePod.adoc[] + + +== Delete Multiple Pods + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/pods/pods-oper-deleteMultiplePods.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/_index.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/_index.adoc new file mode 100644 index 000000000..a4fdcddeb --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/_index.adoc @@ -0,0 +1,11 @@ +--- +title: "Pods" +linkTitle: "Pods" +keywords: "Kubernetes, KubeSphere, Cluster Management, Pod" +description: "Instructions on how to manage pods." +layout: "second" +weight: 03 +--- + + +include::../../../../_custom-en/clusterManagement/pods/pods-desc-pods.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/01-create-a-service.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/01-create-a-service.adoc new file mode 100644 index 000000000..b02d97762 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/01-create-a-service.adoc @@ -0,0 +1,58 @@ +--- +title: "Create Services" +linkTitle: "Create Services" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Services, Create Services" +description: "Learn how to create services." +weight: 01 +--- + + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Services** + + +include::../../../../_custom-en/clusterManagement/services/services-desc-createAService.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom-en/projectManagement/services/services-oper-setBasicInformation.adoc[] ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +include::../../../../_custom-en/clusterManagement/services/services-para-serviceName.adoc[] + +include::../../../../_custom-en/clusterManagement/services/services-para-serviceAlias.adoc[] + +| Project +| The project to which the service belongs. System projects are typically used for managing system resources, and it is recommended to choose a user project. + +include::../../../../_custom-en/clusterManagement/services/services-para-serviceDescription.adoc[] +|=== +-- + ++ + +include::../../../../_custom-en/clusterManagement/services/services-oper-createAService.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/02-view-a-service-list.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/02-view-a-service-list.adoc new file mode 100644 index 000000000..21b0fa279 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/02-view-a-service-list.adoc @@ -0,0 +1,67 @@ +--- +title: "View Service List" +linkTitle: "View Service List" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Services, View Service List" +description: "Learn how to view the service list." +weight: 02 +--- + + +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Services** + + +include::../../../../_custom-en/clusterManagement/services/services-desc-viewServiceList.adoc[] + + +== Prerequisites + + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +==== +* The service list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +include::../../../../_custom-en/clusterManagement/services/services-para-name.adoc[] + +| Project +| The project to which the service belongs. + +| Internal Access +| +include::../../../../_custom-en/clusterManagement/services/services-para-internalAccess.adoc[] + +include::../../../../_custom-en/clusterManagement/services/services-para-virtualip-headless.adoc[] + +include::../../../../_custom-en/clusterManagement/services/services-para-externalName.adoc[] + +include::../../../../_custom-en/clusterManagement/services/services-para-externalAccess.adoc[] + +include::../../../../_custom-en/clusterManagement/services/services-para-creationTime.adoc[] +|=== +-- + +* Choose a project from the drop-down list at the top left of the list to view services in a specific project. + +include::../../../../_custom-en/clusterManagement/services/services-oper-searchForServices.adoc[] + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/03-view-service-details.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/03-view-service-details.adoc new file mode 100644 index 000000000..a61a80b6a --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/03-view-service-details.adoc @@ -0,0 +1,38 @@ +--- +title: "View Service Details" +linkTitle: "View Service Details" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Services, View Service Details" +description: "Learn how to view service details." +weight: 03 +--- + + +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Services** + + +include::../../../../_custom-en/clusterManagement/services/services-desc-viewServiceDetails.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/services/services-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/services/services-oper-viewServiceDetails.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/04-edit-service-information.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/04-edit-service-information.adoc new file mode 100644 index 000000000..60d0dde83 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/04-edit-service-information.adoc @@ -0,0 +1,33 @@ +--- +title: "Edit Service Information" +linkTitle: "Edit Service Information" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Services, Edit Service Information" +description: "Learn how to edit service information." +weight: 04 +--- + + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Services** + +include::../../../../_custom-en/clusterManagement/services/services-desc-editServiceInformation.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/services/services-oper-editServiceInformation.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/05-edit-service-settings.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/05-edit-service-settings.adoc new file mode 100644 index 000000000..b09069584 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/05-edit-service-settings.adoc @@ -0,0 +1,32 @@ +--- +title: "Edit Service Settings" +linkTitle: "Edit Service Settings" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Services, Edit Service Settings" +description: "Learn how to edit service settings." +weight: 05 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Services** + +include::../../../../_custom-en/clusterManagement/services/services-desc-editServiceSettings.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/services/services-oper-editServiceSettings.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/06-edit-service-external-access-settings.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/06-edit-service-external-access-settings.adoc new file mode 100644 index 000000000..36db1d47a --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/06-edit-service-external-access-settings.adoc @@ -0,0 +1,34 @@ +--- +title: "Edit External Access" +linkTitle: "Edit External Access" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Services, Edit Service External Access Settings" +description: "Learn how to edit service external access settings." +weight: 06 +--- + + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Services** + + +include::../../../../_custom-en/clusterManagement/services/services-desc-editServiceExternalAccessSettings.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/services/services-oper-editServiceExternalAccessSettings.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/08-delete-services.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/08-delete-services.adoc new file mode 100644 index 000000000..dc0db9925 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/08-delete-services.adoc @@ -0,0 +1,51 @@ +--- +title: "Delete Services" +linkTitle: "Delete Services" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads, Services, Delete Services" +description: "Learn how to delete a service." +weight: 08 +--- + + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Services** + + +include::../../../../_custom-en/clusterManagement/services/services-desc-deleteServices.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Delete a Single Service + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/services/services-oper-deleteASingleService.adoc[] + ++ + +. In the **Delete Service** dialog, confirm and select the names of the resources related to the services to be deleted, then click **OK**. + + +== Delete Multiple Services + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/services/services-oper-deleteMultipleServices.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/_index.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/_index.adoc new file mode 100644 index 000000000..097730127 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/04-services/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "Services" +linkTitle: "Services" +keywords: "Kubernetes, KubeSphere, Cluster Management, Services" +description: "Learn how to manage services." +layout: "second" +weight: 04 +--- + + + +include::../../../../_custom-en/clusterManagement/services/services-desc-services.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/05-application-workloads/_index.adoc b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/_index.adoc new file mode 100644 index 000000000..69814abed --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/05-application-workloads/_index.adoc @@ -0,0 +1,11 @@ +--- +title: "Application Workloads" +linkTitle: "Application Workloads" +keywords: "Kubernetes, KubeSphere, Cluster Management, Application Workloads" +description: "Introduction to managing workloads, jobs, pods, and services." +layout: "second" +weight: 05 +--- + + +This section explains how to manage workloads, jobs, pods, and services. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/01-create-a-secret.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/01-create-a-secret.adoc new file mode 100644 index 000000000..dfcf1cd57 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/01-create-a-secret.adoc @@ -0,0 +1,38 @@ +--- +title: "Create Secrets" +linkTitle: "Create Secrets" +keywords: "Kubernetes, KubeSphere, Cluster Management, Secret" +description: "Learn how to create Secrets." +weight: 01 +--- + + +:ks_permission: **Project Resource Management** +:ks_navigation: **Configuration > Secrets** + + +include::../../../../_custom-en/clusterManagement/secrets/secrets-desc-createASecret.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/secrets/secrets-oper-createASecret.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/02-view-a-secret-list.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/02-view-a-secret-list.adoc new file mode 100644 index 000000000..d902928e5 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/02-view-a-secret-list.adoc @@ -0,0 +1,41 @@ +--- +title: "View Secrets List" +linkTitle: "View Secrets List" +keywords: "Kubernetes, KubeSphere, Cluster Management, Secrets" +description: "Introduction to viewing the list of Secrets." +weight: 02 +--- + +:ks_permission: **Project Resource Viewing** +:ks_navigation: **Configuration > Secrets** + + +include::../../../../_custom-en/clusterManagement/secrets/secrets-desc-viewASecretList.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +==== +include::../../../../_custom-en/clusterManagement/secrets/secrets-para-secretList.adoc[] + +* In the dropdown list at the top left of the list, select a project to view the Secrets of that project. + +include::../../../../_custom-en/clusterManagement/secrets/secrets-oper-searchForSecrets.adoc[] + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/03-view-secret-details.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/03-view-secret-details.adoc new file mode 100644 index 000000000..6883f3d72 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/03-view-secret-details.adoc @@ -0,0 +1,38 @@ +--- +title: "View Secret Details" +linkTitle: "View Secret Details" +keywords: "Kubernetes, KubeSphere, Cluster Management, Secret" +description: "Introduction to viewing secret details." +weight: 03 +--- + + +:ks_permission: **Project Resource Viewing** +:ks_navigation: **Configuration > Secrets** + + +include::../../../../_custom-en/clusterManagement/secrets/secrets-desc-viewSecretDetails.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/secrets/secrets-oper-openSecretDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/secrets/secrets-oper-viewSecretDetails.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/04-edit-secret-information.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/04-edit-secret-information.adoc new file mode 100644 index 000000000..96fff96f9 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/04-edit-secret-information.adoc @@ -0,0 +1,34 @@ +--- +title: "Edit Secret Information" +linkTitle: "Edit Secret Information" +keywords: "Kubernetes, KubeSphere, Cluster Management, Secret, Edit Secret Information" +description: "Introduction to editing key-value pair data of a Secret." +weight: 04 +--- + + +:ks_permission: **Project Resource Management** +:ks_navigation: **Configuration > Secrets** + + +include::../../../../_custom-en/clusterManagement/secrets/secrets-desc-editSecretInformation.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/secrets/secrets-oper-editSecretInformation.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/05-edit-secret-settings.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/05-edit-secret-settings.adoc new file mode 100644 index 000000000..73b40cc22 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/05-edit-secret-settings.adoc @@ -0,0 +1,34 @@ +--- +title: "Edit Secret Settings" +linkTitle: "Edit Secret Settings" +keywords: "Kubernetes, KubeSphere, Cluster Management, Secret, Edit Secret Settings" +description: "Introduction to editing settings of a Secret." +weight: 05 +--- + + +:ks_permission: **Project Resource Management** +:ks_navigation: **Configuration > Secrets** + + +include::../../../../_custom-en/clusterManagement/secrets/secrets-desc-editSecretSettings.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/secrets/secrets-oper-editSecretSettings.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/06-delete-secrets.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/06-delete-secrets.adoc new file mode 100644 index 000000000..b892a4343 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/06-delete-secrets.adoc @@ -0,0 +1,47 @@ +--- +title: "Delete Secrets" +linkTitle: "Delete Secrets" +keywords: "Kubernetes, KubeSphere, Cluster Management, Secret, Delete Secret" +description: "Introduction to deleting a Secret." +weight: 06 +--- + + +:ks_permission: **Project Resource Management** +:ks_navigation: **Configuration > Secrets** + + +include::../../../../_custom-en/clusterManagement/secrets/secrets-desc-deleteSecrets.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Delete a Single Secret + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/secrets/secrets-oper-deleteASingleSecret.adoc[] + + +== Delete Multiple Secrets + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/secrets/secrets-oper-deleteMultipleSecrets.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/_index.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/_index.adoc new file mode 100644 index 000000000..b5f5d70cd --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/01-secrets/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "Secrets" +linkTitle: "Secrets" +keywords: "Kubernetes, KubeSphere, Cluster Management, Configuration, Secret" +description: "Introduction to managing Secrets." +layout: "second" +weight: 01 +--- + + + +include::../../../../_custom-en/clusterManagement/secrets/secrets-desc-secrets.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/01-create-a-configmap.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/01-create-a-configmap.adoc new file mode 100644 index 000000000..1a01fce20 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/01-create-a-configmap.adoc @@ -0,0 +1,38 @@ +--- +title: "Create ConfigMaps" +linkTitle: "Create ConfigMaps" +keywords: "Kubernetes, KubeSphere, Cluster Management, ConfigMap, Create ConfigMap" +description: "Learn how to create a ConfigMap." +weight: 01 +--- + + +:ks_permission: **Project Resource Management** +:ks_navigation: **Configuration > ConfigMaps** + + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-desc-createAConfigmap.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-oper-createAConfigmap.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/02-view-a-configmap-list.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/02-view-a-configmap-list.adoc new file mode 100644 index 000000000..f4a5f18fd --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/02-view-a-configmap-list.adoc @@ -0,0 +1,42 @@ +--- +title: "View ConfigMaps List" +linkTitle: "View ConfigMaps List" +keywords: "Kubernetes, KubeSphere, Cluster Management, ConfigMaps" +description: "Introduction to viewing the list of ConfigMaps." +weight: 02 +--- + + +:ks_permission: **Project Resource Viewing** +:ks_navigation: **Configuration > ConfigMaps** + + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-desc-viewAConfigmapList.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +==== +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-para-configmapList.adoc[] + +* In the dropdown list at the top left of the list, select a project to view the ConfigMaps of that project. + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-oper-searchForConfigmaps.adoc[] + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/03-view-configmap-details.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/03-view-configmap-details.adoc new file mode 100644 index 000000000..85645a2e4 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/03-view-configmap-details.adoc @@ -0,0 +1,38 @@ +--- +title: "View ConfigMap Details" +linkTitle: "View ConfigMap Details" +keywords: "Kubernetes, KubeSphere, Cluster Management, ConfigMap, View ConfigMap Details" +description: "Instructions on how to view ConfigMap details." +weight: 03 +--- + + +:ks_permission: **Project Resource Viewing** +:ks_navigation: **Configuration > ConfigMaps** + + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-desc-viewConfigmapDetails.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-oper-viewConfigmapDetails.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/04-edit-configmap-information.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/04-edit-configmap-information.adoc new file mode 100644 index 000000000..c666ab136 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/04-edit-configmap-information.adoc @@ -0,0 +1,34 @@ +--- +title: "Edit ConfigMap Information" +linkTitle: "Edit ConfigMap Information" +keywords: "Kubernetes, KubeSphere, Cluster Management, ConfigMap, Edit ConfigMap Information" +description: "Learn how to edit ConfigMap information." +weight: 04 +--- + + +:ks_permission: **Project Resource Management** +:ks_navigation: **Configuration > ConfigMaps** + + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-desc-editConfigmapInformation.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-oper-editConfigmapInformation.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/05-edit-configmap-settings.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/05-edit-configmap-settings.adoc new file mode 100644 index 000000000..942db920a --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/05-edit-configmap-settings.adoc @@ -0,0 +1,34 @@ +--- +title: "Edit ConfigMap Settings" +linkTitle: "Edit ConfigMap Settings" +keywords: "Kubernetes, KubeSphere, Cluster Management, ConfigMap, Edit ConfigMap Settings" +description: "Learn how to edit ConfigMap data." +weight: 05 +--- + + +:ks_permission: **Project Resource Management** +:ks_navigation: **Configuration > ConfigMaps** + + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-desc-editConfigmapSettings.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-oper-editConfigmapSettings.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/06-delete-configmaps.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/06-delete-configmaps.adoc new file mode 100644 index 000000000..98f3a8f35 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/06-delete-configmaps.adoc @@ -0,0 +1,45 @@ +--- +title: "Delete ConfigMaps" +linkTitle: "Delete ConfigMaps" +keywords: "Kubernetes, KubeSphere, Cluster Management, ConfigMap, Delete ConfigMap" +description: "Learn how to delete a ConfigMap." +weight: 06 +--- + +:ks_permission: **Project Resource Management** +:ks_navigation: **Configuration > ConfigMaps** + + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-desc-deleteConfigmaps.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + +== Delete a Single ConfigMap + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-oper-deleteASingleConfigmap.adoc[] + + +== Delete Multiple ConfigMaps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-oper-deleteMultipleConfigmaps.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/_index.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/_index.adoc new file mode 100644 index 000000000..1d272b22c --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/_index.adoc @@ -0,0 +1,14 @@ +--- +title: "ConfigMaps" +linkTitle: "ConfigMaps" +keywords: "Kubernetes, KubeSphere, Cluster Management, ConfigMap" +description: "Introduction to managing ConfigMaps." +layout: "second" +weight: 02 +--- + + + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-desc-configmaps.adoc[] + +ConfigMaps are only used to store non-sensitive data. If you need to store sensitive data, please use link:../01-secrets/[Secrets]. diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/01-create-a-service-account.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/01-create-a-service-account.adoc new file mode 100644 index 000000000..a83b102f3 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/01-create-a-service-account.adoc @@ -0,0 +1,34 @@ +--- +title: "Create Service Accounts" +linkTitle: "Create Service Accounts" +keywords: "Kubernetes, KubeSphere, Cluster Management, Service Account" +description: "Learn how to create a service account." +weight: 01 +--- + + +:ks_permission: **Project Resource Management** +:ks_navigation: **Configuration > Service Accounts** + + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-createAServiceAccount.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-createAServiceAccount.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/02-view-a-service-account-list.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/02-view-a-service-account-list.adoc new file mode 100644 index 000000000..ad1e2f517 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/02-view-a-service-account-list.adoc @@ -0,0 +1,42 @@ +--- +title: "View Service Account List" +linkTitle: "View Service Account List" +keywords: "Kubernetes, KubeSphere, Cluster Management, Service Accounts" +description: "Explain how to view the list of service accounts in the cluster." +weight: 02 +--- + + +:ks_permission: **Project Resource Viewing** +:ks_navigation: **Configuration > Service Accounts** + + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-viewAServiceAccountList.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +==== +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-para-serviceAccountList.adoc[] + +* In the dropdown list at the top left of the list, select a project to view the service accounts of that project. + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-searchForServiceAccounts.adoc[] + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/03-view-service-account-details.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/03-view-service-account-details.adoc new file mode 100644 index 000000000..01020b065 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/03-view-service-account-details.adoc @@ -0,0 +1,38 @@ +--- +title: "View Service Account Details" +linkTitle: "View Service Account Details" +keywords: "Kubernetes, KubeSphere, Cluster Management, Service Accounts, View Service Account Details" +description: "Explain how to view details of a service account." +weight: 03 +--- + + +:ks_permission: **Project Resource Viewing** +:ks_navigation: **Configuration > Service Accounts** + + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-viewServiceAccountDetails.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-viewServiceAccountDetails.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/04-edit-service-account-information.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/04-edit-service-account-information.adoc new file mode 100644 index 000000000..193bcb90e --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/04-edit-service-account-information.adoc @@ -0,0 +1,34 @@ +--- +title: "Edit Service Account Information" +linkTitle: "Edit Service Account Information" +keywords: "Kubernetes, KubeSphere, Cluster Management, Service Accounts" +description: "Explain how to edit the alias and description of a service account." +weight: 04 +--- + + +:ks_permission: **Project Resource Management** +:ks_navigation: **Configuration > Service Accounts** + + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-editServiceAccountInformation.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-editServiceAccountInformation.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/05-change-the-role-of-a-service-account.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/05-change-the-role-of-a-service-account.adoc new file mode 100644 index 000000000..b19ee03a9 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/05-change-the-role-of-a-service-account.adoc @@ -0,0 +1,35 @@ +--- +title: "Change Service Account Role" +linkTitle: "Change Service Account Role" +keywords: "Kubernetes, KubeSphere, Cluster Management, Service Accounts, Change Service Account Role" +description: "Explain how to change the role of a service account." +weight: 05 +--- + + + +:ks_permission: **Project Resource Management** +:ks_navigation: **Configuration > Service Accounts** + + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-changeTheRoleOfAServiceAccount.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-changeTheRoleOfAServiceAccount.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/06-delete-service-accounts.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/06-delete-service-accounts.adoc new file mode 100644 index 000000000..0291c45a4 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/06-delete-service-accounts.adoc @@ -0,0 +1,47 @@ +--- +title: "Delete Service Accounts" +linkTitle: "Delete Service Accounts" +keywords: "Kubernetes, KubeSphere, Cluster Management, Service Account, Delete Service Account" +description: "Learn how to delete a service account." +weight: 06 +--- + + +:ks_permission: **Project Resource Management** +:ks_navigation: **Configuration > Service Accounts** + + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-deleteServiceAccounts.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Delete a Single Service Account + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-deleteASingleServiceAccount.adoc[] + + +== Delete Multiple Service Accounts + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-deleteMultipleServiceAccounts.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/_index.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/_index.adoc new file mode 100644 index 000000000..d1c16e7d2 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "Service Accounts" +linkTitle: "Service Accounts" +keywords: "Kubernetes, KubeSphere, Cluster Management, Service Accounts" +description: "Learn how to manage service accounts." +layout: "second" +weight: 03 +--- + + + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-serviceAccounts.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/06-configuration/_index.adoc b/content/en/docs/v4.1/07-cluster-management/06-configuration/_index.adoc new file mode 100644 index 000000000..e71883d85 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/06-configuration/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "Configuration" +linkTitle: "Configuration" +keywords: "Kubernetes, KubeSphere, Cluster Management, Configuration" +description: "Introduction to managing Secrets, ConfigMaps, and Service Accounts." +layout: "second" +weight: 06 +--- + + + +include::../../../_custom-en/clusterManagement/clusterManagement-desc-configuration.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/07-crds/01-view-a-crd-list.adoc b/content/en/docs/v4.1/07-cluster-management/07-crds/01-view-a-crd-list.adoc new file mode 100644 index 000000000..3ecd6b7fd --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/07-crds/01-view-a-crd-list.adoc @@ -0,0 +1,60 @@ +--- +title: "View CRD List" +linkTitle: "View CRD List" +keywords: "Kubernetes, KubeSphere, Cluster Management, Custom Resource Definitions, View Custom Resource Definitions List" +description: "Explain how to view the list of custom resource definitions." +weight: 01 +--- + +:ks_permission: **Custom Resource Definition Viewing** +:ks_navigation: **CRDs** + + +This section explains how to view the list of custom resource definitions. + + +== Prerequisites + + +include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + ++ +==== +* The custom resource definition list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +|Category +|The category and API version of the custom resource definition. + +|Name +|The name of the custom resource definition. + +|Scope +| +include::../../../_custom-en/clusterManagement/crds/crds-para-scope.adoc[] + +|Creation Time +|The creation time of the custom resource definition. +|=== +-- + +* Click on the search box at the top of the list and enter keywords to search for custom resource definitions by name. + +include::../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/07-cluster-management/07-crds/02-view-crd-details.adoc b/content/en/docs/v4.1/07-cluster-management/07-crds/02-view-crd-details.adoc new file mode 100644 index 000000000..3bb68de96 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/07-crds/02-view-crd-details.adoc @@ -0,0 +1,77 @@ +--- +title: "View CRD Details" +linkTitle: "View CRD Details" +keywords: "Kubernetes, KubeSphere, Cluster Management, Custom Resource Definitions, View Custom Resource Definitions List" +description: "Explain how to view details of a custom resource definition." +weight: 02 +--- + + +:ks_permission: **Custom Resource Definition Viewing** +:ks_navigation: **CRDs** + + +This section explains how to view details of a custom resource definition. + + + +== Prerequisites + + +include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../_custom-en/clusterManagement/crds/crds-oper-openDetailsPage.adoc[] + ++ + +. View the resource attributes of the custom resource definition in the **Attributes** section on the left side of the CRD details page. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +|Cluster +|The cluster to which the custom resource definition belongs. + +|Scope +| +include::../../../_custom-en/clusterManagement/crds/crds-para-scope.adoc[] + +|Creation Time +|The creation time of the custom resource definition. + +|Creator +|The user who created the custom resource definition. +|=== +-- + +. View the custom resources created using the custom resource definition on the **Resource Status** tab on the right side of the custom resource definition details page. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +|Name +|The name of the custom resource. + +|Project/DevOps Project +|The project or DevOps project to which the custom resource belongs. + +|Creation Time +|The creation time of the custom resource. +|=== +-- diff --git a/content/en/docs/v4.1/07-cluster-management/07-crds/03-edit-a-custom-resource.adoc b/content/en/docs/v4.1/07-cluster-management/07-crds/03-edit-a-custom-resource.adoc new file mode 100644 index 000000000..52c93085e --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/07-crds/03-edit-a-custom-resource.adoc @@ -0,0 +1,53 @@ +--- +title: "Edit Custom Resource" +linkTitle: "Edit Custom Resource" +keywords: "Kubernetes, KubeSphere, Cluster Management, Custom Resource Definitions, Edit Custom Resource" +description: "Explain how to edit a custom resource." +weight: 04 +--- + + +:ks_permission: **Custom Resource Definition Management** +:ks_navigation: **CRDs** + + +This section explains how to edit a custom resource. + + +== Prerequisites + + +include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../_custom-en/clusterManagement/crds/crds-oper-openDetailsPage.adoc[] + ++ + +. On the **CRDs** tab, click on image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the custom resource you want to edit, and then select **Edit YAML** from the dropdown list. + +. In the **Edit YAML** dialog, modify the YAML settings of the custom resource, and then click **OK**. ++ +-- +* Click on image:/images/ks-qkcp/zh/icons/upload-dark-white.svg[upload-dark-white,18,18] in the upper right corner of the dialog to upload a local YAML configuration file. + +* Click on image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download-dark-white,18,18] in the upper right corner of the dialog to download the YAML configuration file to your local machine. + +// Note +include::../../../../_ks_components-en/admonitions/note.adoc[] + +You need to modify the settings of the custom resource according to the specifications of the custom resource definition and the API provided by the controller. For more information, refer to the link:https://kubernetes.io/zh/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/[Kubernetes Documentation]. + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- diff --git a/content/en/docs/v4.1/07-cluster-management/07-crds/04-delete-a-custom-resource.adoc b/content/en/docs/v4.1/07-cluster-management/07-crds/04-delete-a-custom-resource.adoc new file mode 100644 index 000000000..abd2b2b1d --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/07-crds/04-delete-a-custom-resource.adoc @@ -0,0 +1,47 @@ +--- +title: "Delete Custom Resources" +linkTitle: "Delete Custom Resources" +keywords: "Kubernetes, KubeSphere, Cluster Management, Custom Resource Definition, Delete Custom Resources" +description: "Instructions on how to delete custom resources." +weight: 05 +--- + +:ks_permission: **Custom Resource Definition Management** +:ks_navigation: **CRDs** + + +This section explains how to delete a custom resource. + +//warning +[.admon.warning,cols="a"] +|=== +|Warning + +|Deleting custom resources may cause interruptions to related services. Please proceed with caution. +|=== + + +== Prerequisites + + +include::../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../_custom-en/clusterManagement/crds/crds-oper-openDetailsPage.adoc[] + ++ + +. On the **CRDs** tab, click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the custom resource you want to delete, then choose **Delete** from the dropdown list. + +. In the **Delete CRD** dialog, enter the name of the custom resource, then click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/07-crds/_index.adoc b/content/en/docs/v4.1/07-cluster-management/07-crds/_index.adoc new file mode 100644 index 000000000..89e0ef968 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/07-crds/_index.adoc @@ -0,0 +1,15 @@ +--- +title: "Custom Resource Definitions" +linkTitle: "Custom Resource Definitions" +keywords: "Kubernetes, KubeSphere, Cluster Management, Custom Resource Definitions" +description: "Explain how to manage custom resource definitions in the cluster." +layout: "second" +weight: 07 +--- + + +This section explains how to manage custom resource definitions. + +Custom resource definitions (CRD) are used to extend existing APIs in Kubernetes. You can create custom resources using custom resource definitions and implement custom business logic by having additional controllers listen to various events related to these custom resources. + +The {ks_product-en} web console currently only supports viewing custom resource definitions and custom resources, as well as editing existing custom resources. It does not support directly creating custom resource definitions and custom resources. You can refer to the link:https://kubernetes.io/zh/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/[Kubernetes Documentation] to create custom resource definitions and custom resources via the command line. diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/01-create-a-persistent-volume-claim.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/01-create-a-persistent-volume-claim.adoc new file mode 100644 index 000000000..bf75c3a66 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/01-create-a-persistent-volume-claim.adoc @@ -0,0 +1,38 @@ +--- +title: "Create PVCs" +linkTitle: "Create PVCs" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage, Persistent Volume Claim, Persistent Volume, Create Persistent Volume Claim" +description: "Explain how to create a Persistent Volume Claim." +weight: 01 +--- + + +:ks_permission: **Persistent Volume Claim Management** +:ks_navigation: **Storage > Persistent Volume Claims** + + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAPersistentVolumeClaim.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim_new.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/02-view-a-persistent-volume-claim-list.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/02-view-a-persistent-volume-claim-list.adoc new file mode 100644 index 000000000..5c15ad11e --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/02-view-a-persistent-volume-claim-list.adoc @@ -0,0 +1,42 @@ +--- +title: "View PVC List" +linkTitle: "View PVC List" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage, Persistent Volume Claim, Persistent Volume, View Persistent Volume Claim List" +description: "Explain how to view the list of Persistent Volume Claims." +weight: 02 +--- + + +:ks_permission: **Persistent Volume Claim Viewing** +:ks_navigation: **Storage > Persistent Volume Claims** + + +include::../../../../_custom-en/clusterManagement/pods/pods-desc-viewAPersistentVolumeList.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +==== +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-persistentVolumeClaimList.adoc[] + +* In the dropdown list at the top left of the list, select a project to view the Persistent Volume Claims of that project. + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-searchForPersistentVolumeClaims.adoc[] + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/03-view-persistent-volume-claim-details.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/03-view-persistent-volume-claim-details.adoc new file mode 100644 index 000000000..f5db96d82 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/03-view-persistent-volume-claim-details.adoc @@ -0,0 +1,37 @@ +--- +title: "View PVC Details" +linkTitle: "View PVC Details" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage, Persistent Volume Claim, Persistent Volume, View Persistent Volume Claim Details" +description: "Explain how to view details of a Persistent Volume Claim." +weight: 03 +--- + +:ks_permission: **Persistent Volume Claim Viewing** +:ks_navigation: **Storage > Persistent Volume Claims** + + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-viewPersistentVolumeClaimDetails.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails_new.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/04-clone-a-persistent-volume.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/04-clone-a-persistent-volume.adoc new file mode 100644 index 000000000..a7a702933 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/04-clone-a-persistent-volume.adoc @@ -0,0 +1,42 @@ +--- +title: "Clone Persistent Volumes" +linkTitle: "Clone Persistent Volumes" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage, Persistent Volume Claim, Persistent Volume, Clone Persistent Volume" +description: "Explain how to clone a Persistent Volume." +weight: 04 +--- + + +:ks_permission: **Persistent Volume Claim Management** +:ks_navigation: **Storage > Persistent Volume Claims** + + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-cloneAPersistentVolume.adoc[] + + +== Prerequisites + +* {empty} +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc[] + +* Ensure that the backend storage system supports volume cloning, and the storage class corresponding to the Persistent Volume Claim has enabled volume cloning. For more information, please refer to link:../../02-storage-classes/05-enable-and-disable-volume-operations/[Enable and Disable Volume Operations]. + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-cloneAPersistentVolume.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/05-expand-a-persistent-volume.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/05-expand-a-persistent-volume.adoc new file mode 100644 index 000000000..3a556e7c5 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/05-expand-a-persistent-volume.adoc @@ -0,0 +1,42 @@ +--- +title: "Expand Persistent Volumes" +linkTitle: "Expand Persistent Volumes" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage, Persistent Volume Claim, Persistent Volume, Expand Persistent Volume" +description: "Learn how to expand the capacity of a Persistent Volume." +weight: 05 +--- + + +:ks_permission: **Persistent Volume Claim Management** +:ks_navigation: **Storage > Persistent Volume Claims** + + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-expandAPersistentVolumeClaim.adoc[] + + +== Prerequisites + +* {empty} +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc[] + +* Ensure that the backend storage system supports volume cloning, and the storage class corresponding to the Persistent Volume Claim has enabled volume cloning. For more information, please refer to link:../../02-storage-classes/05-enable-and-disable-volume-operations/[Enable and Disable Volume Operations]. + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-expandAPersistentVolume.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/08-edit-persistent-volume-claim-information.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/08-edit-persistent-volume-claim-information.adoc new file mode 100644 index 000000000..61dfbf894 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/08-edit-persistent-volume-claim-information.adoc @@ -0,0 +1,34 @@ +--- +title: "Edit PVC Information" +linkTitle: "Edit PVC Information" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage, Persistent Volume Claim, Persistent Volume, Edit Persistent Volume Claim Information" +description: "Introduce how to edit the basic information of a Persistent Volume Claim." +weight: 08 +--- + + +:ks_permission: **Persistent Volume Claim Management** +:ks_navigation: **Storage > Persistent Volume Claims** + + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-editPersistentVolumeClaimInformation.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-editPersistentVolumeClaimInformation.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/09-delete-persistent-volume-claim.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/09-delete-persistent-volume-claim.adoc new file mode 100644 index 000000000..301b0fa25 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/09-delete-persistent-volume-claim.adoc @@ -0,0 +1,49 @@ +--- +title: "Delete PVCs" +linkTitle: "Delete PVCs" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage, Persistent Volume Claim, Persistent Volume, Delete Persistent Volume Claim" +description: "Introduce how to delete a Persistent Volume Claim." +weight: 09 +--- + +:ks_permission: **Persistent Volume Claim Management** +:ks_navigation: **Storage > Persistent Volume Claims** + + + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-deletePersistentVolumeClaims.adoc[] + + +== Prerequisites + +* {empty} +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-backData.adoc[] + + +== Delete a Single Persistent Volume Claim + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteASinglePersistentVolumeClaim.adoc[] + + +== Delete Multiple Persistent Volume Claims + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteMultiplePersistentVolumeClaims.adoc[] + diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/10-view-a-persistent-volume-list.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/10-view-a-persistent-volume-list.adoc new file mode 100644 index 000000000..134a358d6 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/10-view-a-persistent-volume-list.adoc @@ -0,0 +1,74 @@ +--- +title: "View Persistent Volume List" +linkTitle: "View Persistent Volume List" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage, Persistent Volume Claim, Persistent Volume, View Persistent Volume List" +description: "Introduce how to view the list of Persistent Volumes." +weight: 10 +--- + + +:ks_permission: **Persistent Volume Claim Viewing** +:ks_navigation: **Storage > Persistent Volume Claims** + + +This section introduces how to view the list of Persistent Volumes. + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumes/persistentVolumes-oper-openListPage.adoc[] + ++ +==== +* The Persistent Volume list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Name +|The name, alias, and storage class of the Persistent Volume. Automatically provisioned Persistent Volumes have names generated by the system. For more information about storage classes, refer to the link:../../02-storage-classes/[Storage Classes]. + +|Status +| +include::../../../../_custom-en/clusterManagement/persistentVolumes/persistent-volume-status.adoc[] + +|Capacity +| +include::../../../../_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-volumeSize.adoc[] + +|Access Modes +| +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-accessMode.adoc[] + +|Reclaim Policy +| +include::../../../../_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-reclaimPolicy.adoc[] + +|Creation Time +|The creation time of the Persistent Volume. +|=== +-- + +* Click the search box above the list and search for Persistent Volumes by name or status. + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/11-view-persistent-volume-details.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/11-view-persistent-volume-details.adoc new file mode 100644 index 000000000..17eaf86f0 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/11-view-persistent-volume-details.adoc @@ -0,0 +1,86 @@ +--- +title: "View Persistent Volume Details" +linkTitle: "View Persistent Volume Details" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage, Persistent Volume Claim, Persistent Volume, View Persistent Volume Details" +description: "Introduce how to view details of Persistent Volumes in the cluster." +weight: 11 +--- + +:ks_permission: **Persistent Volume Claim Viewing** +:ks_navigation: **Storage > Persistent Volume Claims** + +This section explains how to view details of Persistent Volumes in the cluster. + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. On the **Persistent Volume Claims** page, click **Persistent Volume** to open the list of Persistent Volumes. Then, click the name of a Persistent Volume to open its details page. + +. On the left side of the Persistent Volume details page, in the **Attributes** section, view the resource attributes of the Persistent Volume. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Status +| +include::../../../../_custom-en/clusterManagement/persistentVolumes/persistent-volume-status.adoc[] + +|Capacity +| +include::../../../../_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-volumeSize.adoc[] + +|Access Mode +| +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-accessMode.adoc[] + +|Storage Class +|The storage class corresponding to the Persistent Volume claim. For more information about storage classes, refer to link:../../02-storage-classes/[Storage Classes]. + +|Volume Handle +|The unique identifier of the Persistent Volume in the backend storage system. + +|Reclaim Policy +| +include::../../../../_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-reclaimPolicy.adoc[] + +|Volume Mode +|The device type of the Persistent Volume. + +* **Filesystem**: The Persistent Volume is mounted to containers in the form of a filesystem. + +* **Block Device**: The Persistent Volume is provided to containers in the form of a block device. + +|Creation Time +|The creation time of the Persistent Volume. +|=== +-- + +. Click the **Resource Status** tab on the right side of the Persistent Volume details page to view information about the Persistent Volume Claim associated with the Persistent Volume. ++ +-- +include::../../../../_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-pvcInformation.adoc[] +-- + +. Click the **Metadata** tab on the right side of the Persistent Volume details page to view the labels and annotations of the Persistent Volume. + +. Click the **Events** tab on the right side of the Persistent Volume details page to view the events of the Persistent Volume. ++ +-- +include::../../../../_custom-en/clusterManagement/clusterManagement-para-eventsTab.adoc[] +-- diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/12-edit-persistent-volume-information.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/12-edit-persistent-volume-information.adoc new file mode 100644 index 000000000..a6ab2e795 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/12-edit-persistent-volume-information.adoc @@ -0,0 +1,55 @@ +--- +title: "Edit Persistent Volume Information" +linkTitle: "Edit Persistent Volume Information" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage, Persistent Volume Claim, Persistent Volume, Edit Persistent Volume Information" +description: "Introduce how to edit information of a Persistent Volume." +weight: 12 +--- + + +:ks_permission: **Persistent Volume Claim Management** +:ks_navigation: **Storage > Persistent Volume Claims** + + +This section explains how to edit Persistent Volume information. + +You can edit the alias and description of the Persistent Volume. KubeSphere does not support editing the name of an already created Persistent Volume. + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumes/persistentVolumes-oper-openListPage.adoc[] + ++ + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the Persistent Volume you want to edit, then choose **Edit Information** from the dropdown list. + +. In the **Edit Information** dialog, set the alias and description for the Persistent Volume, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Alias +| The alias of the Persistent Volume. Aliases can be the same for different Persistent Volumes. An alias can only contain Chinese characters, letters, numbers, and hyphens (-). It cannot start or end with a hyphen (-) and has a maximum length of 63 characters. + +| Description +| The description of the Persistent Volume. The description can contain any characters, with a maximum length of 256 characters. +|=== +-- diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/13-delete-a-persistent-volume.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/13-delete-a-persistent-volume.adoc new file mode 100644 index 000000000..68cdec3d5 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/13-delete-a-persistent-volume.adoc @@ -0,0 +1,54 @@ +--- +title: "Delete Persistent Volumes" +linkTitle: "Delete Persistent Volumes" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage, Persistent Volume Claim, Persistent Volume, Delete Persistent Volume" +description: "Introduce how to delete a Persistent Volume." +weight: 13 +--- + + +:ks_permission: **Persistent Volume Claim Management** +:ks_navigation: **Storage > Persistent Volume Claims** + + +This section explains how to delete a Persistent Volume. + +The default reclaim policy for storage classes in KubeSphere is **Delete**, meaning that by default, the system automatically deletes the Persistent Volume after the Persistent Volume Claim is deleted. If you create a storage class with a reclaim policy of **Retain** using command-line tools, there may be situations where the Persistent Volume Claim is deleted, but the Persistent Volume is not. For more information, refer to the link:https://kubernetes.io/docs/concepts/storage/storage-classes/[Kubernetes Documentation]. + +//warning +[.admon.warning,cols="a"] +|=== +| Warning + +| +Deleting a Persistent Volume is irreversible, and the backend storage area corresponding to the Persistent Volume will also be deleted. Please proceed with caution to avoid data loss. +|=== + + +== Prerequisites + +* {empty} +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +* The status of the Persistent Volume is **Available**, **Released**, or **Failed**. + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-backData.adoc[] + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumes/persistentVolumes-oper-openListPage.adoc[] + ++ + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the Persistent Volume you want to delete, then choose **Delete** from the dropdown list. + +. In the **Delete Persistent Volume** dialog, enter the name of the Persistent Volume, then click **OK**. diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/_index.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/_index.adoc new file mode 100644 index 000000000..297569e03 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "Persistent Volume Claims" +linkTitle: "Persistent Volume Claims" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage, Persistent Volume Claim, Persistent Volume" +description: "Explain how to manage volumes." +layout: "second" +weight: 01 +--- + +This section explains how to manage Persistent Volume Claims (PVC) and Persistent Volumes (PV). + +A Persistent Volume Claim defines the requirements for storage resources. The system creates a storage area in the backend storage system based on the Persistent Volume Claim, making it available for containers. Each storage area corresponds to a Persistent Volume in KubeSphere. diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/01-create-a-storage-class.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/01-create-a-storage-class.adoc new file mode 100644 index 000000000..6ba625b06 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/01-create-a-storage-class.adoc @@ -0,0 +1,105 @@ +--- +title: "Create Storage Classes" +linkTitle: "Create Storage Classes" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage, Storage Class, Create Storage Class" +description: "Instructions on how to create a storage class." +weight: 01 +--- + +:ks_permission: **Storage Class Management** +:ks_navigation: **Storage > Storage Classes** + +This section explains how to create a storage class. + +== Prerequisites + +* {empty} +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + +* To ensure that the storage class can provide storage resources properly, you need to pre-configure the storage system and install the storage plugin corresponding to the storage system. For more information, please contact your storage system provider. + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +. On the **Basic Information** tab, set the basic information for the storage class, then click **Next**. ++ +-- +[%header,cols="1,4"] +|=== +| Parameter | Description + +| Name +| The name of the storage class. The name can only contain lowercase letters, numbers, and hyphens (-), must start and end with a lowercase letter or number, and can be up to 63 characters long. + +| Alias +| The alias of the storage class. The aliases of different storage classes can be the same. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), should not start or end with a hyphen (-), and can be up to 63 characters long. + +| Description +| Description information for the storage class. The description can contain any characters and can be up to 256 characters long. +|=== +-- + +. On the **Storage System** tab, select a system or **Custom**, then click **Next**. + +. On the **Storage Class Settings** tab, set the parameters for the storage class, then click **Create**. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Volume Expansion +| +include::../../../../_custom-en/clusterManagement/storageClasses/systemClasses-para-allowVolumeExpansion.adoc[] + +|Reclaim Policy +| +include::../../../../_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-reclaimPolicy.adoc[] + +|Access Mode +| +The modes in which the volume can be accessed. + +* **ReadWriteOnce**: Allows a single node to read from and write to the volume. + +* **ReadOnlyMany**: Allows multiple nodes to read from the volume. + +* **ReadWriteMany**: Allows multiple nodes to read from and write to the volume. + +You can select one or more access modes from the dropdown list. Some storage systems may not support certain access modes. + +|Provisioner +| +include::../../../../_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-provisioner.adoc[] + +|Volume Binding Mode +|Specifies whether a Persistent Volume is immediately created and bound to a Persistent Volume Claim upon the creation of the Persistent Volume Claim. The following modes are supported: + +* **Immediate Binding**: Creates the Persistent Volume immediately after the Persistent Volume Claim is created and binds them. + +* **Delayed Binding**: Creates the Persistent Volume and binds it to the Persistent Volume Claim after the container mounting the Persistent Volume is created. + +|Parameter +|Key-value pairs that match the parameters expected by the backend storage system and the storage plugin. + +* Click **Add** to set multiple parameters. + +* To delete a parameter, click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] next to the parameter. + +For more information, please contact your storage system provider. +|=== + +Once the storage class is created, it will be displayed in the storage class list. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/02-view-a-storage-class-list.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/02-view-a-storage-class-list.adoc new file mode 100644 index 000000000..324151477 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/02-view-a-storage-class-list.adoc @@ -0,0 +1,79 @@ +--- +title: "View Storage Class List" +linkTitle: "View Storage Class List" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage, Storage Class, View Storage Class List" +description: "Instructions on how to view the storage class list." +weight: 02 +--- + +:ks_permission: **Storage Class Viewing** +:ks_navigation: **Storage > Storage Classes** + +This section explains how to view the storage class list. + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ +==== +* The storage class list provides the following information: + +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Name +| The name, alias, and description information of the storage class. + +| Default Storage Class +| +include::../../../../_custom-en/clusterManagement/storageClasses/systemClasses-para-defaultStorageClass.adoc[] + +| PVCs +| The number of Persistent Volume Claims created through the storage class. + +|Volume Clone Allowed +| +include::../../../../_custom-en/clusterManagement/storageClasses/systemClasses-para-allowVolumeCloning.adoc[] + +|Volume Snapshot Allowed +| +include::../../../../_custom-en/clusterManagement/storageClasses/systemClasses-para-allowVolumeSnapshot.adoc[] + +|Volume Expansion Allowed +| +include::../../../../_custom-en/clusterManagement/storageClasses/systemClasses-para-allowVolumeExpansion.adoc[] + +|Provisioner +| +include::../../../../_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-provisioner.adoc[] +|=== + +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +**Volume Clone Allowed**, **Volume Snapshot Allowed** and **Volume Expansion Allowed** simply indicate whether users are permitted to perform these operations in the {ks_product-en} web console. The actual support for these operations by Persistent Volume Claims depends on the backend storage system. For more information, refer to link:../05-enable-and-disable-volume-operations/[Set Volume Operations]. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- + +* Click the search box at the top of the list to search for storage classes by name. + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/03-view-storage-class-details.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/03-view-storage-class-details.adoc new file mode 100644 index 000000000..ed5d0006d --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/03-view-storage-class-details.adoc @@ -0,0 +1,97 @@ +--- +title: "View Storage Class Details" +linkTitle: "View Storage Class Details" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage, Storage Class, View Storage Class Details" +description: "Instructions on how to view storage class details." +weight: 03 +--- + +:ks_permission: **Storage Class Viewing** +:ks_navigation: **Storage > Storage Classes** + +This section explains how to view storage class details. + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/storageClasses/systemClasses-oper-openDetailsPage.adoc[] + ++ + +. In the **Attributes** section on the left side of the details page, view the resource attributes of the storage class. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +|Provisioner +| +include::../../../../_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-provisioner.adoc[] + +|Default Storage Class +| +include::../../../../_custom-en/clusterManagement/storageClasses/systemClasses-para-defaultStorageClass.adoc[] + +|Volume Expansion Allowed +| +include::../../../../_custom-en/clusterManagement/storageClasses/systemClasses-para-allowVolumeExpansion.adoc[] + +|Reclaim Policy +| +include::../../../../_custom-en/clusterManagement/persistentVolumes/persistentVolumes-para-reclaimPolicy.adoc[] + +|Volume Snapshot Allowed +| +include::../../../../_custom-en/clusterManagement/storageClasses/systemClasses-para-allowVolumeSnapshot.adoc[] +|=== +-- + +. On the right side of the details page, click the **Persistent Volume Claims** tab to view the Persistent Volume Claims created using the storage class . ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Name +| The name and alias of the volume. + +| Status +| +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-status.adoc[] + +| Capacity +| The capacity size requested by the volume. + +| Mount Status +| Indicates whether the volume has been mounted to a pod. + +| Project +| The project to which the volume belongs. + +|Creation Time +|The creation time of the volume. +|=== + +* Click the search box at the top of the list to search for volumes by name. + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +-- diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/04-set-a-default-storage-class.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/04-set-a-default-storage-class.adoc new file mode 100644 index 000000000..5457be12e --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/04-set-a-default-storage-class.adoc @@ -0,0 +1,39 @@ +--- +title: "Set Default Storage Class" +linkTitle: "Set Default Storage Class" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage, Storage Class, Set Default Storage Class" +description: "Instructions on how to set the default storage class." +weight: 04 +--- + +:ks_permission: **Storage Class Management** +:ks_navigation: **Storage > Storage Classes** + + +This section explains how to set the default storage class. Once a default storage class is set, the system will use it to create Persistent Volume Claims if no specific storage class is designated. Only one default storage class is allowed in a KubeSphere cluster. + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/storageClasses/systemClasses-oper-openDetailsPage.adoc[] + ++ + +. In the top-left corner of the details page, select **More > Set as Default Storage Class**. + +. In the **Set as Default Storage Class** dialog, click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/05-enable-and-disable-volume-operations.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/05-enable-and-disable-volume-operations.adoc new file mode 100644 index 000000000..bd07a909e --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/05-enable-and-disable-volume-operations.adoc @@ -0,0 +1,67 @@ +--- +title: "Enable and Disable Volume Operations" +linkTitle: "Enable and Disable Volume Operations" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage, Storage Class, Enable and Disable Volume Operations" +description: "Instructions on how to enable and disable volume operations." +weight: 05 +--- + +:ks_permission: **Storage Class Management** +:ks_navigation: **Storage > Storage Classes** + + +This section explains how to enable and disable volume operations. + +You can configure whether users can clone and expand Persistent Volume Claims created using specific storage classes in the {ks_product-en} web console. + +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +The steps outlined in this section only control whether users can take these operations in the {ks_product-en} web console. The actual support for these operations by Persistent Volume Claims depends on the backend storage system. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] + + +== Prerequisites + +* {empty} +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +* Ensure that the backend storage system actually supports the feature before enabling it. + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/storageClasses/systemClasses-oper-openDetailsPage.adoc[] + ++ + +. In the top-left corner of the details page, select **More > Set Volume Operations**. + +. In the **Set Volume Operations** dialog, enable or disable Volume Cloning and Volume Expansion, then click **OK**. ++ +-- +[%header,cols="1,4"] +|=== +| Feature | Description + +| Volume Cloning +| +include::../../../../_custom-en/clusterManagement/storageClasses/systemClasses-para-allowVolumeCloning.adoc[] + +// |Volume Snapshot +// | +// include::../../../../_custom-en/clusterManagement/storageClasses/systemClasses-para-allowVolumeSnapshot.adoc[] + +|Volume Expansion +| +include::../../../../_custom-en/clusterManagement/storageClasses/systemClasses-para-allowVolumeExpansion.adoc[] +|=== +-- diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/06-edit-storage-class-information.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/06-edit-storage-class-information.adoc new file mode 100644 index 000000000..3eea43d01 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/06-edit-storage-class-information.adoc @@ -0,0 +1,49 @@ +--- +title: "Edit Storage Class Information" +linkTitle: "Edit Storage Class Information" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage Class" +description: "Instructions on how to edit the alias and description of a storage class." +weight: 06 +--- + +:ks_permission: **Storage Class Management** +:ks_navigation: **Storage > Storage Classes** + + +This section explains how to edit storage class information. + +You can edit the alias and description of the storage class. KubeSphere does not support editing the name of an already created storage class. + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the storage class you want to edit, then choose **Edit Information** from the dropdown list. + +. In the **Edit Information** dialog, set the alias and description for the storage class, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Alias +| The alias of the storage class. Aliases can be the same for different storage classs. An alias can only contain Chinese characters, letters, numbers, and hyphens (-). It cannot start or end with a hyphen (-) and has a maximum length of 63 characters. + +| Description +| The description of the storage class. The description can contain any characters, with a maximum length of 256 characters. +|=== +-- diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/07-delete-a-storage-class.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/07-delete-a-storage-class.adoc new file mode 100644 index 000000000..cbc2b0029 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/07-delete-a-storage-class.adoc @@ -0,0 +1,59 @@ +--- +title: "Delete Storage Classes" +linkTitle: "Delete Storage Classes" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage Class" +description: "Instructions on how to delete a storage class." +weight: 07 +--- + +:ks_permission: **Storage Class Management** +:ks_navigation: **Storage > Storage Classes** + + +This section explains how to delete a storage class. + +// Warning +include::../../../../../_ks_components-en/admonitions/warning.adoc[] + +After deleting a storage class, Persistent Volume Claims and Persistent Volumes created based on this storage class will not be deleted. Containers can still use the mounted Persistent Volumes, but users will no longer be able to use volume cloning, volume snapshots, and volume expansion features. Additionally, it will not be possible to create storage areas in the backend storage system using this storage class. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] + + +== Prerequisites + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + +== Delete a Single Storage Class + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the storage class you want to delete, then choose **Delete** from the dropdown list. + +. In the **Delete storage class** dialog, enter the name of the storage class, then click **OK**. + + +== Delete Multiple Storage Classes + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. Select the checkbox on the left of the storage classes you want to delete, then click **Delete** above the storage class list. + +. In the **Delete Multiple Storage Classes** dialog, enter the name of the storage classes, then click **OK**. ++ +-- +include::../../../../_custom-en/note-separateNamesByComma.adoc[] +-- diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/_index.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/_index.adoc new file mode 100644 index 000000000..0274b2567 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "Storage Classes" +linkTitle: "Storage Classes" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage, Storage Classes" +description: "Instructions on how to manage storage classes." +layout: "second" +weight: 02 +--- + +This section explains how to manage storage classes. + +Storage classes define a class of storage volumes that containers can use. If you did not set up an external persistent storage system during the installation of {ks_product-en}, {ks_product-en} will use the local storage system of the cluster nodes as the persistent storage system and automatically create the corresponding **local** storage class. If you are using an external persistent storage system, you need to install a storage plugin for the KubeSphere cluster and create storage classes to define the classes of storage volumes that can be used. For information on how to install storage plugins, please contact your storage system provider. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/08-storage/_index.adoc b/content/en/docs/v4.1/07-cluster-management/08-storage/_index.adoc new file mode 100644 index 000000000..1dff12379 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/08-storage/_index.adoc @@ -0,0 +1,20 @@ +--- +title: "Storage" +linkTitle: "Storage" +keywords: "Kubernetes, KubeSphere, Cluster Management, Storage" +description: "Explain how to manage storage resources." +layout: "second" +weight: 08 +--- + + + +This section explains how to manage storage resources. + +KubeSphere supports the management of the following storage resources: + +* Storage Class: Defines a class of Persistent Volume Claims available for containers. + +* Persistent Volume Claim: Defines the storage space requirements for a Persistent Volume. + +* Persistent Volume: Represents a storage area in the backend storage system. The system creates a storage area available for containers in the backend storage system based on the parameters in the Persistent Volume Claim. Each storage area corresponds to a Persistent Volume in the KubeSphere platform. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/01-view-cluster-basic-information.adoc b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/01-view-cluster-basic-information.adoc new file mode 100644 index 000000000..0be1861d4 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/01-view-cluster-basic-information.adoc @@ -0,0 +1,30 @@ +--- +title: "View Cluster Basic Information" +linkTitle: "View Cluster Basic Information" +keywords: "Kubernetes, KubeSphere, Cluster Management, Basic Information, View Cluster Basic Information" +description: "Instructions on how to view cluster basic information." +weight: 01 +--- + +:ks_permission: **Cluster Settings Viewing** +:ks_navigation: **Cluster Settings > Basic Information** + + +This section explains how to view cluster basic information. + + +== Prerequisites + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. On the **Basic Information** page, view the cluster's name, provider, and Kubernetes version. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/02-edit-cluster-basic-information.adoc b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/02-edit-cluster-basic-information.adoc new file mode 100644 index 000000000..c0dc45f20 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/02-edit-cluster-basic-information.adoc @@ -0,0 +1,58 @@ +--- +title: "Edit Cluster Basic Information" +linkTitle: "Edit Cluster Basic Information" +keywords: "Kubernetes, KubeSphere, Cluster Management, Basic Information, Edit Cluster Basic Information" +description: "Instructions on how to edit cluster basic information." +weight: 02 +--- + +:ks_permission: **Cluster Settings Management** +:ks_navigation: **Cluster Settings > Basic Information** + + +This section explains how to edit cluster basic information. + +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +KubeSphere does not support changing the name of an already added cluster. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. On the right side of the **Basic Information** page, click **Edit Information**. + +. In the **Edit Information** dialog, set the cluster's tag, provider, and description, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Tag +| Used to identify the purpose of the cluster. Values can be **Production**, **Development**, **Testing**, or **Demo**. + +| Provider +| The provider of the cluster infrastructure. + +| Description +| The description of the cluster. The description can contain any characters, up to 256 characters in length. +|=== +-- diff --git a/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/_index.adoc b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/_index.adoc new file mode 100644 index 000000000..169aace2e --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Basic Information" +linkTitle: "Basic Information" +keywords: "Kubernetes, KubeSphere, Cluster Management, Basic Information" +description: "Instructions on how to view and edit cluster basic information." +layout: "second" +weight: 01 +--- + +This section explains how to view and edit cluster basic information. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/01-view-cluster-visibility.adoc b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/01-view-cluster-visibility.adoc new file mode 100644 index 000000000..09814e8c0 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/01-view-cluster-visibility.adoc @@ -0,0 +1,47 @@ +--- +title: "View Cluster Visibility" +linkTitle: "View Cluster Visibility" +keywords: "Kubernetes, KubeSphere, Cluster Management, Cluster Visibility, View Cluster Visibility" +description: "Instructions on how to view which workspaces a cluster is authorized to." +weight: 01 +--- + +:ks_permission: **Cluster Settings Viewing** +:ks_navigation: **Cluster Settings > Cluster Visibility** + +This section explains how to view which workspaces a cluster is authorized to. + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Cluster Visibility +| Whether the cluster is visible to all workspaces. + +| Workspaces +| Authorized workspaces. + +| Administrators +| Administrators of the workspace. + +| Authorization Time +| The time when the workspace was granted authorization. +|=== +-- diff --git a/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/02-edit-cluster-visibility.adoc b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/02-edit-cluster-visibility.adoc new file mode 100644 index 000000000..36c35ccab --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/02-edit-cluster-visibility.adoc @@ -0,0 +1,51 @@ +--- +title: "Edit Cluster Visibility" +linkTitle: "Edit Cluster Visibility" +keywords: "Kubernetes, KubeSphere, Cluster Management, Cluster Visibility, Edit Cluster Visibility" +description: "Instructions on how to edit cluster visibility." +weight: 02 +--- + +:ks_permission: **Cluster Settings Management** +:ks_navigation: **Cluster Settings > Cluster Visibility** + +This section explains how to edit cluster visibility. + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. Click **Edit Visibility** on the right side of the page. + +. In the **Edit Visibility** dialog, authorize or revoke authorization to workspaces, then click **OK**. ++ +-- +* Clicking on a workspace in the **Unauthorized** list will authorize the cluster to that workspace. + +* Clicking on a workspace in the **Authorized** list will revoke authorization to that workspace. + +* Toggle on **Set as Public Cluster** to authorize the cluster to all workspaces on the {ks_product-en} platform. + +// Warning +include::../../../../../_ks_components-en/admonitions/warning.adoc[] + +* Please avoid authorizing the host cluster to workspaces, as high load on the host cluster can lead to decreased stability of the multi-cluster system. + +* Removing authorization to a workspace will result in the deletion of all resources of that workspace in the current cluster. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/_index.adoc b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/_index.adoc new file mode 100644 index 000000000..7d5833fee --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/_index.adoc @@ -0,0 +1,15 @@ +--- +title: "Cluster Visibility" +linkTitle: "Cluster Visibility" +keywords: "Kubernetes, KubeSphere, Cluster Management, Cluster Visibility" +description: "Instructions on how to manage cluster visibility." +layout: "second" +weight: 02 +--- + +This section explains how to manage cluster visibility. Cluster visibility controls the cluster authorization to workspaces. After a cluster is authorized to workspaces, you can view and manage the cluster resources in the workspaces. + +* A cluster can be authorized to multiple workspaces, allowing resources within the workspaces to run on that cluster. + +* Multiple clusters can be authorized to one workspace, enabling the creation of multi-cluster projects within the workspace. +// For more information on multi-cluster projects, refer to link:../../../11-use-extensions/04-kubefed[Multi-cluster Projects]. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/01-invite-a-user-to-a-cluster.adoc b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/01-invite-a-user-to-a-cluster.adoc new file mode 100644 index 000000000..7c909defa --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/01-invite-a-user-to-a-cluster.adoc @@ -0,0 +1,42 @@ +--- +title: "Invite Users to Join Cluster" +linkTitle: "Invite Users to Join Cluster" +keywords: "Kubernetes, KubeSphere, Cluster Management, Cluster Settings, Cluster Members, Invite Users to Join Cluster" +description: "Instructions on how to invite users to join a cluster." +weight: 01 +--- + +:ks_permission: **Member Management** +:ks_navigation: **Cluster Settings > Cluster Members** + +This section explains how to invite users to join a cluster. + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-clickInvite.adoc[] + ++ + +. In the **Invite Members** dialog, click image:/images/ks-qkcp/zh/icons/add-dark.svg[add-dark,18,18] next to the user you want to invite, select the role for the user in the cluster from the dropdown list, and then click **OK**. ++ +-- +include::../../../../_custom-en/clusterManagement/clusterMembers/clusterMembers-para-presetClusterRoles.adoc[] + +After being invited to join the cluster, users will be displayed in the list of cluster members. +-- diff --git a/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/02-view-a-cluster-member-list.adoc b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/02-view-a-cluster-member-list.adoc new file mode 100644 index 000000000..21ec6ca56 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/02-view-a-cluster-member-list.adoc @@ -0,0 +1,62 @@ +--- +title: "View Cluster Member List" +linkTitle: "View Cluster Member List" +keywords: "Kubernetes, KubeSphere, Cluster Management, Cluster Settings, Cluster Members, View Cluster Member List" +description: "Instructions on how to view the cluster member list." +weight: 02 +--- + +:ks_permission: **Member Viewing** +:ks_navigation: **Cluster Settings > Cluster Members** + +This section explains how to view the cluster member list. + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +==== +* The cluster member list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Username +| The username of the cluster member. + +| Status +| The current status of the cluster member. + +include::../../../../_custom-en/clusterManagement/clusterMembers/clusterMembers-para-userStatus.adoc[] + +| Role +| The role of the cluster member within the cluster. + +* **cluster-admin**: Cluster administrator with all permissions within the cluster except creating and deleting clusters. + +* **cluster-viewer**: Cluster viewer with permissions to view all resources within the cluster. + +| Last Login +| The time of the cluster member's last login to the {ks_product-en} web console. +|=== +-- + +* Click the search box at the top of the list and search for cluster members by name. + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/03-change-the-role-of-a-cluster-member.adoc b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/03-change-the-role-of-a-cluster-member.adoc new file mode 100644 index 000000000..18886aec4 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/03-change-the-role-of-a-cluster-member.adoc @@ -0,0 +1,38 @@ +--- +title: "Change Cluster Member Roles" +linkTitle: "Change Cluster Member Roles" +keywords: "Kubernetes, KubeSphere, Cluster Management, Cluster Settings, Cluster Members, Change Cluster Member Roles" +description: "Instructions on how to change cluster member roles." +weight: 03 +--- + +:ks_permission: **Member Management** +:ks_navigation: **Cluster Settings > Cluster Members** + +This section explains how to change cluster member roles. + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] next to the member you want to edit, then select **Change Role**. + +. In the **Change Role** dialog, set the role for the cluster member, then click **OK**. ++ +-- +include::../../../../_custom-en/clusterManagement/clusterMembers/clusterMembers-para-presetClusterRoles.adoc[] +-- diff --git a/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/04-remove-a-cluster-member.adoc b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/04-remove-a-cluster-member.adoc new file mode 100644 index 000000000..83aa27a21 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/04-remove-a-cluster-member.adoc @@ -0,0 +1,43 @@ +--- +title: "Remove Cluster Members" +linkTitle: "Remove Cluster Members" +keywords: "Kubernetes, KubeSphere, Cluster Management, Cluster Settings, Cluster Members, Remove Cluster Members" +description: "Instructions on how to remove cluster members." +weight: 04 +--- + +:ks_permission: **Member Management** +:ks_navigation: **Cluster Settings > Cluster Members** + +This section explains how to remove cluster members. + +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +After removing a user from the cluster, the user will lose the permissions granted by the cluster role. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] next to the member you want to remove, then select **Remove**. + +. In the **Remove Member** dialog, enter the username of the cluster member, then click **OK**. ++ +Once a cluster member is removed, they will no longer appear in the cluster member list. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc new file mode 100644 index 000000000..fb1de36fc --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc @@ -0,0 +1,19 @@ +--- +title: "Cluster Members" +linkTitle: "Cluster Members" +keywords: "Kubernetes, KubeSphere, Cluster Management, Cluster Members" +description: "Instructions on how to manage cluster members." +layout: "second" +weight: 03 +--- + +This section explains how to manage cluster members. + +Cluster members are users who have permission to view or manage resources within the cluster, and their permissions are determined by the roles they have in the cluster. + +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +include::../../../../_custom-en/clusterManagement/clusterMembers/clusterMembers-desc-initialClusterAdmin.adoc[] + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/01-view-a-cluster-role-list.adoc b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/01-view-a-cluster-role-list.adoc new file mode 100644 index 000000000..2a98e2310 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/01-view-a-cluster-role-list.adoc @@ -0,0 +1,33 @@ +--- +title: "View Cluster Role List" +linkTitle: "View Cluster Role List" +keywords: "Kubernetes, KubeSphere, Cluster Management, Cluster Settings, Cluster Members, View Cluster Role List" +description: "Instructions on how to view the cluster role list." +weight: 01 +--- + +:ks_permission: **Role Viewing** +:ks_navigation: **Cluster Settings > Cluster Roles** + + +This section explains how to view the cluster role list. + + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +-- +include::../../../../_custom-en/clusterManagement/clusterMembers/clusterMembers-para-presetClusterRoles.adoc[] +-- diff --git a/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/02-view-cluster-role-details.adoc b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/02-view-cluster-role-details.adoc new file mode 100644 index 000000000..4bfec681c --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/02-view-cluster-role-details.adoc @@ -0,0 +1,161 @@ +--- +title: "View Cluster Role Details" +linkTitle: "View Cluster Role Details" +keywords: "Kubernetes, KubeSphere, Cluster Management, Cluster Settings, Cluster Roles, View Cluster Role Details" +description: "Instructions on how to view cluster role details." +weight: 02 +--- + +:ks_permission: **Role Viewing** +:ks_navigation: **Cluster Settings > Cluster Roles** + +This section explains how to view cluster role details. + +== Prerequisites + + +include::../../../../_custom-en/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ +. Click the name of a cluster role in the list to open its details page. + +. On the **Permissions** tab on the right side of the details page, you can view the permissions associated with the cluster role. ++ +==== +All cluster members can view basic information about the cluster. The permissions required for other operations are as follows: + +* Storage ++ +-- +[%header,cols="1a,4a"] +|=== +|Permission |Operations Allowed + +|Persistent Volume Claim Viewing +|View persistent volume claim list, view persistent volume claim details, view persistent volume list, view persistent volume details. + +|Persistent Volume Claim Management +|Create persistent volume claim, clone persistent volume, expand persistent volume, edit persistent volume claim information, edit persistent volume information, delete persistent volume claim, delete persistent volume. + +|Storage Class Viewing +|View storage class list, view storage class details. + +|Storage Class Management +|Create storage class, set default storage class, enable and disable volume operations, edit storage class information, delete storage class. +|=== +-- + +* Access Control ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Role Viewing +|View cluster role list, view cluster role details. + +|Member Viewing +|View cluster member list. + +|Member Management +|Invite users to join the cluster, change cluster member roles, remove cluster members. +|=== +-- + +* Project ++ +-- +[%header,cols="1a,4a"] +|=== +|Permission |Operations Allowed + +|Project Viewing +|View project list, view project details. + +|Project Management +|Create project, edit project information, edit project annotations, edit project quotas, edit default container quotas, delete project. +|=== +-- + +* Cluster Resources ++ +-- +[%header,cols="1a,4a"] +|=== +|Permission |Operations Allowed + +|Node View +|View node list, view node details. + +|Node Management +|Prevent and allow pod scheduling to nodes, access node terminal, edit node taints, edit node labels. + +|Custom Resource Definition Viewing +|View custom resource definition list, view custom resource definition details. + +|Custom Resource Definition Management +|Edit custom resources, delete custom resources. +|=== +-- + +* Cluster Settings ++ +-- +[%header,cols="1a,4a"] +|=== +|Permission |Operations Allowed + +|Cluster Settings View +|View cluster overview, view cluster basic information, view cluster visibility. + +|Cluster Settings Management +|Use cluster management features, edit cluster basic information, edit cluster visibility. +|=== +-- + +* Application Workloads ++ +-- +[%header,cols="1a,4a"] +|=== +|Permission |Operations Allowed + +|Application Workload Viewing +| +* Workload View: View workload list, view workload details. + +* Job View: View job list, view job details. + +* Pod View: View pod list, view pod details, view container details. + +* Service View: View service list, view service details. + +|Application Workload Management +| +* Workload Management: Create workload, edit workload information, recreate workload, adjust pod replica count, stop workload, rollback workload settings, edit workload settings, delete workload. + +* Job Management: Create job, edit job information, rerun job, pause scheduled job, delete job. + +* Pod Management: Access container terminal, delete pod. + +* Service Management: Create service, edit service information, edit service settings, edit service external access settings, delete service. +|=== +-- +==== + +. Click the **Authorized Users** tab on the right side of the details page to view users with the current cluster role. ++ +-- +include::../../../../_custom-en/clusterManagement/clusterRoles/clusterRoles-para-authorizedUsers.adoc[] +-- diff --git a/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc new file mode 100644 index 000000000..8317074ef --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc @@ -0,0 +1,22 @@ +--- +title: "Cluster Roles" +linkTitle: "Cluster Roles" +keywords: "Kubernetes, KubeSphere, Cluster Management, Cluster Roles" +description: "Instructions on how to manage cluster roles." +layout: "second" +weight: 04 +--- + +This section explains how to manage cluster roles. + +Each cluster role comes with specific cluster management or viewing permissions. You can assign roles with specific permissions to cluster members to control their access within the cluster. + +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +* {empty} +include::../../../../_custom-en/clusterManagement/clusterMembers/clusterMembers-desc-initialClusterAdmin.adoc[] + +* KubeSphere currently does not support creating custom cluster roles. You can view information about the built-in cluster roles in the {ks_product-en} web console. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] diff --git a/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/_index.adoc b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/_index.adoc new file mode 100644 index 000000000..e5b7e7290 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/09-cluster-settings/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Cluster Settings" +linkTitle: "Cluster Settings" +keywords: "Kubernetes, KubeSphere, Cluster Management, Cluster Settings" +description: "Instructions on how to manage cluster settings." +layout: "second" +weight: 09 +--- + +This section explains how to manage cluster settings. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/01-add-a-member-cluster-using-direct-connection.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/01-add-a-member-cluster-using-direct-connection.adoc new file mode 100644 index 000000000..913b93557 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/01-add-a-member-cluster-using-direct-connection.adoc @@ -0,0 +1,56 @@ +--- +title: "Add Member Cluster via Direct Connection" +linkTitle: "Add Member Cluster via Direct Connection" +keywords: "Kubernetes, {ks_product}, Multi-Cluster Management, Cluster, Add Member Clusters" +description: "Learn how to add member clusters via direct connection." +weight: 01 +--- + +This section explains how to add member clusters via direct connection. + + +== Prerequisites + +* You should have the **platform-admin** role in the host cluster. + +* All nodes in the host cluster must be able to access the Kubernetes API service of the member cluster (usually port 6443 on the master node of the member cluster). Depending on your network environment, you may need to configure firewall and traffic forwarding rules. + +== Get Member Cluster Kubeconfig + +. On a node in the member cluster, run the following command to get the kubeconfig information of the member cluster: ++ +[,bash] +---- +kubectl config view --raw +---- + +. Copy the kubeconfig information and modify the **clusters:cluster:server** parameter as follows: ++ +[,yaml] +---- +clusters: +- cluster: + server: https://:6443 +---- + +== Add Member Cluster + +include::../../../../../_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToHost.adoc[] + ++ + +. Click **Cluster Management**. + ++ + +include::../../../../../_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterBasicInfo.adoc[] ++ +Under **Advanced Settings**, set the purpose identifier for the cluster. + +. On the **Connection Settings** tab, set the **Connection Mode** to **Direct Connection**, enter the kubeconfig information of the member cluster in the **kubeconfig** area, and then click **Next**. + +. On the **Cluster Configuration** tab, configure the cluster settings, and then click **Create**. ++ +-- +Once the member cluster is added, it will be displayed in the list of clusters on the **Cluster Management** page. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/_index.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/_index.adoc new file mode 100644 index 000000000..c22dda784 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/_index.adoc @@ -0,0 +1,27 @@ +--- +title: "Add Member Clusters" +linkTitle: "Add Member Clusters" +keywords: "Kubernetes, KubeSphere, Multi-Cluster Management, Cluster, Add Member Clusters" +description: "Learn how to add member clusters." +layout: "second" +weight: 01 +--- + +This section explains how to add member clusters. + +Depending on your network environment, the host cluster and member clusters can be connected in the following ways: + +* Direct Connection: If the host cluster can access the Kubernetes API service of the member cluster, you can add the kubeconfig information of the member cluster on the host cluster to directly connect the host cluster and the member cluster. + +* Agent Connection: If the host cluster cannot access the Kubernetes API service of the member cluster, you can set up the member cluster to connect to the proxy service "tower" exposed by the host cluster, enabling the connection between the host cluster and the member cluster via tower. + +[.admon.note,cols="a"] +|=== +| Note + +| +To use a agent connection, the **KubeSphere Multi-Cluster Agent Connection** extension needs to be installed and enabled on the KubeSphere platform. +// For more information, refer to link:../../../../11-use-extensions/19-tower/02-add-a-member-cluster-using-proxy-connection[Add a Member Cluster via Agent Connection]. +|=== + +Whether using a direct connection or a agent connection, at least one of the host cluster and the member cluster must be able to access the services exposed by the other side. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/02-view-a-cluster-list.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/02-view-a-cluster-list.adoc new file mode 100644 index 000000000..4cacebdc9 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/02-view-a-cluster-list.adoc @@ -0,0 +1,62 @@ +--- +title: "View Cluster List" +linkTitle: "View Cluster List" +keywords: "Kubernetes, KubeSphere, Multi-Cluster Management, Cluster, View Cluster List" +description: "Learn how to view the list of clusters." +weight: 02 +--- + +:ks_menu: **Cluster Management** +:ks_permission: **Cluster Viewing** + + +This section explains how to view the list of clusters. + + +== Prerequisites + +include::../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +== Steps + +include::../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] + +. Click **Cluster Management**. + +==== +* The cluster list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Name, Identifier, and Description +|The cluster's name, identifiers, and description. + +|Number of Nodes +|Number of server nodes in the cluster. + +|Kubernetes Version +|The version of Kubernetes running in the cluster. + +|Provider +|Provider of the cluster environment. + +|Tags +|Tag of the cluster, used to categorize the cluster. + +|Creation Time +|The time the cluster was added to the {ks_product-en} web console. +|=== +-- + +* Click the search box at the top of the list to search for clusters by name, type or tag. + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] + + +* Click the name of the cluster to access the cluster and manage the resources in it. +==== diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/03-edit-cluster-information.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/03-edit-cluster-information.adoc new file mode 100644 index 000000000..fac3edfa8 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/03-edit-cluster-information.adoc @@ -0,0 +1,47 @@ +--- +title: "Edit Cluster Information" +linkTitle: "Edit Cluster Information" +keywords: "Kubernetes, KubeSphere, Multi-Cluster Management, Cluster, Edit Cluster Information" +description: "Learn how to edit cluster information." +weight: 03 +--- + + +:ks_menu: **Cluster Management** +:ks_permission: **Cluster Management** + + +This section explains how to edit cluster information. + +You can edit the identifier, provider, and description of the cluster. KubeSphere does not support editing the name of an already added cluster. + +== Prerequisites + +include::../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + + +== Steps + +include::../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] + +. Click **Cluster Management**. + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the cluster you want to edit, then choose **Edit Information** from the dropdown list. + +. In the **Edit Information** dialog, set the identifier, provider and description for the cluster, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Identifier +|A label used to identify the purpose of the cluster. + +| Provider +| The provider of the cluster. Select the provider from the dropdown list. + +| Description +| Information describing the cluster. The description can contain any characters and has a maximum length of 256 characters. +|=== +-- diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/04-add-cluster-tags.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/04-add-cluster-tags.adoc new file mode 100644 index 000000000..2bec3de45 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/04-add-cluster-tags.adoc @@ -0,0 +1,50 @@ +--- +title: "Add Cluster Tags" +linkTitle: "Add Cluster Tags" +keywords: "Kubernetes, KubeSphere, Multi-Cluster Management, Cluster, Add Cluster Tags" +description: "Learn how to add cluster tags." +weight: 04 +--- + +:ks_permission: **Cluster Management** + + +This section explains how to add cluster tags. + +You can use tags to categorize and manage clusters. + +== Prerequisites + +* {empty} +include::../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +* You need to create cluster tags in advance. For more information, please refer to link:../../02-cluster-tags/01-create-a-cluster-tag/[Create Cluster Tags]. + + +== Add Tags to a Single Cluster + +include::../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] + +. Click **Cluster Management**. + ++ + +include::../../../../_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterTags.adoc[] + + +== Add Tags to Multiple Clusters + +include::../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] + +. Click **Cluster Management**. + ++ +. Click **Batch Manage** at the top right corner of the cluster list. + +. Select the checkbox on the left side of the clusters where you want to add tags, then click **Add Tags** at the top of the list. + +. In the **Add Tags** dialog, choose the key and value for the tag, click **Add**, and then click **OK**. ++ +-- +After adding the tags, you can search for clusters by tags by clicking on the search box above the cluster list. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-update-kubeconfig.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-update-kubeconfig.adoc new file mode 100644 index 000000000..0415d7e58 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-update-kubeconfig.adoc @@ -0,0 +1,51 @@ +--- +title: "Update kubeconfig" +linkTitle: "Update kubeconfig" +keywords: "Kubernetes, KubeSphere, Multi-Cluster Management, Cluster, Update kubeconfig" +description: "Learn how to update the kubeconfig information of member clusters." +weight: 05 +--- + + +:ks_menu: **Cluster Management** +:ks_permission: **Cluster Management** + + +This section explains how to update the kubeconfig information of member clusters. + +After adding member clusters on the {ks_product-en} platform, if there are changes in the access information of the member clusters, you need to update the kubeconfig of the member clusters. + +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +KubeSphere only supports updating the kubeconfig information of clusters added through direct connections and does not support updating the kubeconfig information of clusters added through agent connections. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] + + +== Prerequisites + +include::../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + + + +== Steps + +include::../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] + +. Click **Cluster Management**. + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the cluster you want to edit, then select **Update kubeconfig** from the dropdown list. + +. In the **Update kubeconfig** dialog, enter the kubeconfig information and then click **Update**. ++ +-- +// Tip +include::../../../../../_ks_components-en/admonitions/tip.adoc[] + +You can click image:/images/ks-qkcp/zh/icons/upload-dark-white.svg[upload-dark-white,18,18] to upload kubeconfig files from your local machine. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] + +The {ks_product-en} web console of the host cluster will use the new kubeconfig information to connect to the member clusters. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/06-remove-a-member-cluster.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/06-remove-a-member-cluster.adoc new file mode 100644 index 000000000..10b163e24 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/06-remove-a-member-cluster.adoc @@ -0,0 +1,78 @@ +--- +title: "Remove Member Clusters" +linkTitle: "Remove Member Clusters" +keywords: "Kubernetes, KubeSphere, Multi-Cluster Management, Cluster, Remove Member Clusters" +description: "Learn how to remove member clusters." +weight: 06 +--- + +:ks_menu: **Cluster Management** + +This section explains how to remove member clusters. + +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +* The host cluster cannot be removed. +* After removing a member cluster, {ks_product-en} will no longer manage that cluster. Existing Kubernetes resources in the cluster will not be deleted. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] + +// Warning +include::../../../../../_ks_components-en/admonitions/warning.adoc[] + +After a cluster is removed, the existing multi-cluster configuration data in the cluster will not be automatically cleared. Uninstalling {ks_product-en} or deleting associated resources may result in data loss. Be sure to follow the link:#_clean_up_multi_cluster_configuration_data[Clean up Multi-Cluster Configuration Data] steps on the removed cluster. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] + +== Prerequisites + +You should have the **platform-admin** role on both the host cluster and the member clusters you want to remove. + +== Remove Clusters via the Web Console + +include::../../../../_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToHost.adoc[] + +. Click **Cluster Management**. + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the cluster you want to remove, then select **Remove Cluster** from the dropdown list. + +. In the **Remove Cluster** dialog, confirm the information of the cluster to be removed, drag the slider to the right, enter the name of the cluster to be removed, choose to either delete or keep all notification configuration data in the cluster, then click **Remove**. ++ +-- +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +In a multi-cluster system, notification channels, silence rules, notification languages, and other configuration data on the host cluster will be automatically synchronized to member clusters. If you do not choose to **delete all notification configuration data in the cluster** when removing the cluster, notifications will continue to be sent according to the original configuration even after the cluster is removed. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- + +== Remove Clusters via Command Line + +In certain situations, you may not be able to remove member clusters via the web console, for example, if there are credential errors for the member cluster. In such cases, you can follow these steps to remove unhealthy member clusters via the command line: + +include::../../../../_custom-en/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToHost.adoc[] + ++ +include::../../../../_custom-en/platformManagement/extensionManagement/extensionManagement-oper-openKubectl.adoc[] + ++ +. In the **kubectl** dialog, run the following command to remove the member cluster (replace with the name of the member cluster): ++ +-- +// Bash +[,bash] +---- +kubectl delete cluster +---- +-- + +== Clean up Multi-Cluster Configuration Data + +Log in to the node of the removed cluster, run the following command to clean up the multi-cluster configuration data in the cluster: + +[,bash] +---- +for ns in $(kubectl get ns --field-selector status.phase!=Terminating -o jsonpath='{.items[*].metadata.name}'); do kubectl label ns $ns kubesphere.io/workspace- && kubectl patch ns $ns --type merge -p '{"metadata":{"ownerReferences":[]}}'; done +---- \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/_index.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/_index.adoc new file mode 100644 index 000000000..6ee86ab66 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Multi-Cluster Management" +linkTitle: "Multi-Cluster Management" +keywords: "Kubernetes, KubeSphere, Multi-Cluster Management, Cluster" +description: "Learn how to manage multiple clusters using the web console of the host cluster." +layout: "second" +weight: 01 +--- + +This section explains how to use the web console of the host cluster to manage multiple clusters. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/01-create-a-cluster-tag.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/01-create-a-cluster-tag.adoc new file mode 100644 index 000000000..b2bac28c3 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/01-create-a-cluster-tag.adoc @@ -0,0 +1,45 @@ +--- +title: "Create Cluster Tags" +linkTitle: "Create Cluster Tags" +keywords: "Kubernetes, KubeSphere, Multi-Cluster Management, Cluster Tags, Create Cluster Tags" +description: "Learn how to create cluster tags." +weight: 01 +--- + +:ks_permission: **Cluster Management** + +This section explains how to create cluster tags. + + +== Prerequisites + +include::../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + + +== Steps + +include::../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] + ++ + +. Click **Cluster Management**. + ++ + +include::../../../../_custom-en/platformManagement/multiclusterManagement/clusterTags/clusterTags-openListPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +. In the **Create Tags** dialog, set the key and value for the tag, then click **Create**. ++ +-- +* Click **Add** to create multiple tags at once. + +* Click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] next to a tag to delete it. + +After creating tags, they will be displayed in the list of tags. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/02-edit-a-cluster-tag.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/02-edit-a-cluster-tag.adoc new file mode 100644 index 000000000..c5e287f9a --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/02-edit-a-cluster-tag.adoc @@ -0,0 +1,35 @@ +--- +title: "Edit Cluster Tags" +linkTitle: "Edit Cluster Tags" +keywords: "Kubernetes, KubeSphere, Multi-Cluster Management, Cluster Tags, Edit Cluster Tags" +description: "Learn how to edit cluster tags." +weight: 02 +--- + +:ks_permission: **Cluster Management** + +This section explains how to edit cluster tags. + + +== Prerequisites + +include::../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + + +== Steps + +include::../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] + ++ + +. Click **Cluster Management**. + ++ + +include::../../../../_custom-en/platformManagement/multiclusterManagement/clusterTags/clusterTags-openListPage.adoc[] + ++ + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] next to the tag you want to edit, then select **Edit** from the dropdown list. + +. In the **Edit Tag** dialog, set the key and value for the tag, then click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/03-add-a-tag-to-clusters.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/03-add-a-tag-to-clusters.adoc new file mode 100644 index 000000000..3d2249ec7 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/03-add-a-tag-to-clusters.adoc @@ -0,0 +1,35 @@ +--- +title: "Add Tags to Clusters" +linkTitle: "Add Tags to Clusters" +keywords: "Kubernetes, KubeSphere, Multi-Cluster Management, Cluster Tags, Add Tags to Cluster" +description: "Learn how to add tags to a cluster." +weight: 03 +--- + +:ks_permission: **Cluster Management** + +This section explains how to add tags to a cluster. + + +== Prerequisites + +include::../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + + +== Steps + +include::../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] + ++ + +. Click **Cluster Management**. + ++ + +include::../../../../_custom-en/platformManagement/multiclusterManagement/clusterTags/clusterTags-openListPage.adoc[] + ++ + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] next to the tag you want to add, then select **Add to Clusters** from the dropdown list. + +. In the **Add Tag to Clusters** dialog, select the cluster where you want to add the tag, then click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/04-remove-a-tag-from-clusters.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/04-remove-a-tag-from-clusters.adoc new file mode 100644 index 000000000..3b8cd7d13 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/04-remove-a-tag-from-clusters.adoc @@ -0,0 +1,34 @@ +--- +title: "Remove Tags from Clusters" +linkTitle: "Remove Tags from Clusters" +keywords: "Kubernetes, KubeSphere, Multi-Cluster Management, Cluster Tags, Remove Tags from Cluster" +description: "Learn how to remove tags from a cluster." +weight: 04 +--- + +:ks_permission: **Cluster Management** + +This section explains how to remove tags from a cluster. + +== Prerequisites + +include::../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + + +== Steps + +include::../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] + ++ + +. Click **Cluster Management**. + ++ + +include::../../../../_custom-en/platformManagement/multiclusterManagement/clusterTags/clusterTags-openListPage.adoc[] + ++ + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] next to the tag you want to remove, then select **Remove from Clusters** from the dropdown list. + +. In the **Remove Tag from Clusters** dialog, click image:/images/ks-qkcp/zh/icons/chain-off-duotone.svg[chain-off-duotone,18,18] next to the cluster from which you want to remove the tag, then click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/05-delete-cluster-tags.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/05-delete-cluster-tags.adoc new file mode 100644 index 000000000..1b244414d --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/05-delete-cluster-tags.adoc @@ -0,0 +1,69 @@ +--- +title: "Delete Cluster Tags" +linkTitle: "Delete Cluster Tags" +keywords: "Kubernetes, KubeSphere, Multi-Cluster Management, Cluster Tags, Delete Tags" +description: "Learn how to delete cluster tags." +weight: 05 +--- + +:ks_permission: **Cluster Management** + +This section explains how to delete cluster tags. + +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +If a tag has been added to a cluster, deleting the tag will also remove it from the cluster. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] + +== Prerequisites + +include::../../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + + +== Delete a Single Tag + +include::../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] + ++ + +. Click **Cluster Management**. + ++ + +include::../../../../_custom-en/platformManagement/multiclusterManagement/clusterTags/clusterTags-openListPage.adoc[] + ++ + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] next to the tag you want to delete, then select **Delete** from the dropdown list. + +. In the **Delete Tag** dialog, enter the key and value of the tag, then click **OK**. + + +== Delete Multiple Tags + +include::../../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] + ++ + +. Click **Cluster Management**. + ++ + +include::../../../../_custom-en/platformManagement/multiclusterManagement/clusterTags/clusterTags-openListPage.adoc[] + ++ + +. Select the checkbox on the left of the tags you want to delete, then click **Delete** at the top of the list. + +. In the **Delete Tag** dialog, enter the key and value of the tag, then click **OK**. ++ +-- +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +Please separate multiple key-value pairs with a comma and space. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/_index.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/_index.adoc new file mode 100644 index 000000000..2dd186bac --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "Cluster Tags" +linkTitle: "Cluster Tags" +keywords: "Kubernetes, KubeSphere, Multi-Cluster Management, Cluster Tags" +description: "Learn how to manage cluster tags." +layout: "second" +weight: 02 +--- + +This section explains how to manage cluster tags using the web console of the host cluster. + +When you have a large number of clusters, you can create tags and assign them to clusters to categorize and manage them effectively. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/_index.adoc b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/_index.adoc new file mode 100644 index 000000000..10c788045 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/10-multi-cluster-management/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Multi-Cluster Management" +linkTitle: "Multi-Cluster Management" +keywords: "Kubernetes, KubeSphere, Multi-Cluster Management" +description: "Learn how to manage multiple clusters using the web console of the host cluster." +layout: "second" +weight: 10 +--- + +This section explains how to use the web console of the host cluster to manage multiple clusters and cluster tags. \ No newline at end of file diff --git a/content/en/docs/v4.1/07-cluster-management/_index.adoc b/content/en/docs/v4.1/07-cluster-management/_index.adoc new file mode 100644 index 000000000..8b0bb7cf8 --- /dev/null +++ b/content/en/docs/v4.1/07-cluster-management/_index.adoc @@ -0,0 +1,13 @@ +--- +title: "Cluster Management" +linkTitle: "Cluster Management" +keywords: "Kubernetes, KubeSphere, Cluster Management" +description: "Learn how to manage resources in a cluster." +layout: "second" +weight: 07 +icon: "/images/docs/common/docs.svg" +--- + +This chapter explains how to manage all resources in individual or multiple clusters within KubeSphere as a cluster member. + +KubeSphere supports the management of multiple clusters. Each cluster can be authorized for multiple workspaces. Each workspace can include multiple regular projects. As a multi-tenant system, KubeSphere supports role-based access control for user permissions at the platform, cluster, workspace, and project levels. \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/01-web-console/01-log-in-and-go-to-a-workspace.adoc b/content/en/docs/v4.1/08-workspace-management/01-web-console/01-log-in-and-go-to-a-workspace.adoc new file mode 100644 index 000000000..fbd8b0288 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/01-web-console/01-log-in-and-go-to-a-workspace.adoc @@ -0,0 +1,34 @@ +--- +title: "Log In and Access Workspaces" +linkTitle: "Log In and Access Workspaces" +keywords: "Kubernetes, KubeSphere, Workspace Management, Web Console, Access Workspace" +description: "This section explains how to log in and access a workspace." +weight: 01 +--- + + +This section explains how to log in to the {ks_product-en} web console and access a workspace. + + +== Prerequisites + +* You should have the username and password of a workspace member. + +include::../../../_custom-en/workspaceManagement/webConsole/webConsole-prer-logIn.adoc[] + + +== Steps + +include::../../../_custom-en/workspaceManagement/webConsole/webConsole-oper-logIn.adoc[] ++ + +include::../../../../_ks_components-en/admonitions/note.adoc[] + +* {empty} +include::../../../_custom-en/workspaceManagement/webConsole/webConsole-note-firstLogin.adoc[] + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] + +. Click **Workspace Management**. + +. Click the name of a workspace in the **Workspaces** page to access the workspace. diff --git a/content/en/docs/v4.1/08-workspace-management/01-web-console/_index.adoc b/content/en/docs/v4.1/08-workspace-management/01-web-console/_index.adoc new file mode 100644 index 000000000..45a603d88 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/01-web-console/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Access Your Workspace" +linkTitle: "Access Your Workspace" +keywords: "Kubernetes, KubeSphere, Workspace Management, Web Console" +description: "Learn how to access workspaces in the web console." +layout: "second" +weight: 01 +--- + +This section explains how to access workspaces in the {ks_product-en} web console. diff --git a/content/en/docs/v4.1/08-workspace-management/02-workspaces/01-create-a-workspace.adoc b/content/en/docs/v4.1/08-workspace-management/02-workspaces/01-create-a-workspace.adoc new file mode 100644 index 000000000..f82bbbb85 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/02-workspaces/01-create-a-workspace.adoc @@ -0,0 +1,46 @@ +--- +title: "Create Workspaces" +linkTitle: "Create Workspaces" +keywords: "Kubernetes, KubeSphere, Access Control, Workspace, Create Workspace" +description: "Learn how to create a workspace." +weight: 01 +--- + +:ks_permission: **Workspace Creation** + +This section explains how to create a workspace. + +== Prerequisites + +include::../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +== Steps + +include::../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] + +. Click **Workspace Management**. +. Click **Create** on the page. +. On the **Create Workspace** page, set the basic information for the workspace and then click **Next**. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Name +|The name of the workspace. The name can only contain lowercase letters, numbers, and hyphens (-), must start and end with a lowercase letter or number, and can be up to 63 characters long. + +|Alias +|The alias of the workspace. The alias can contain any characters and can be up to 63 characters long. + +|Administrator +|The administrator of the workspace. + +|Description +|The description of the workspace. The description can contain any characters and can be up to 256 characters long. +|=== +-- + +. On the **Cluster Settings** tab, select the clusters authorized for this workspace (multiple clusters can be selected at the same time), and resources within the workspace will be created on those clusters. Click **OK**. ++ +After creating the workspace, it will be displayed in the workspace list. \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/02-workspaces/02-view-a-workspace-list.adoc b/content/en/docs/v4.1/08-workspace-management/02-workspaces/02-view-a-workspace-list.adoc new file mode 100644 index 000000000..106fd7613 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/02-workspaces/02-view-a-workspace-list.adoc @@ -0,0 +1,29 @@ +--- +title: "View Workspace List" +linkTitle: "View Workspace List" +keywords: "Kubernetes, KubeSphere, Access Control, Workspace, View Workspace List" +description: "Learn how to view the workspace list." +weight: 02 +--- + +:ks_permission: **Workspace Viewing** + +This section explains how to view the workspace list. + +== Prerequisites + +include::../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + + +== Steps + +include::../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] + +. Click **Workspace Management**. ++ +-- +* The workspace list displays all workspaces on the KubeSphere platform. + +* In the workspace list, click the name of a workspace to view and manage resources within it. +-- + diff --git a/content/en/docs/v4.1/08-workspace-management/02-workspaces/03-edit-workspace-information.adoc b/content/en/docs/v4.1/08-workspace-management/02-workspaces/03-edit-workspace-information.adoc new file mode 100644 index 000000000..c1af682fe --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/02-workspaces/03-edit-workspace-information.adoc @@ -0,0 +1,41 @@ +--- +title: "Edit Workspace Information" +linkTitle: "Edit Workspace Information" +keywords: "Kubernetes, KubeSphere, Access Control, Workspace, Edit Workspace Information" +description: "Learn how to edit workspace information." +weight: 03 +--- + +:ks_permission: **Workspace Management** + +This section explains how to edit workspace information. + +You can edit the alias and description of a workspace. KubeSphere does not support editing the name of an already created workspace. + +== Prerequisites + +include::../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + + +== Steps + +include::../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] + +. Click **Workspace Management**. + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the workspace you want to edit, then choose **Edit Information** from the dropdown list. + +. In the **Edit Information** dialog, set the alias and description for the workspace, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Alias +| The alias of the workspace. The alias can contain any characters, with a maximum length of 63 characters. + +| Description +| The description of the workspace. The description can contain any characters, with a maximum length of 256 characters. +|=== +-- diff --git a/content/en/docs/v4.1/08-workspace-management/02-workspaces/04-delete-workspaces.adoc b/content/en/docs/v4.1/08-workspace-management/02-workspaces/04-delete-workspaces.adoc new file mode 100644 index 000000000..01c6a47eb --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/02-workspaces/04-delete-workspaces.adoc @@ -0,0 +1,55 @@ +--- +title: "Delete Workspaces" +linkTitle: "Delete Workspaces" +keywords: "Kubernetes, KubeSphere, Access Control, Workspace, Delete Workspace" +description: "Learn how to delete a workspace." +weight: 04 +--- + +:ks_permission: **Workspace Management** + +This section explains how to delete a workspace. + +//note +[.admon.note,cols="a"] +|=== +|Note + +| +The system workspace **system-workspace** cannot be deleted. + +|=== + + +== Prerequisites + +include::../../../_custom-en/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + + +== Delete a Single Workspace + +include::../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] + +. Click **Workspace Management**. + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right of the workspace you want to delete, then choose **Delete** from the dropdown list. + +. In the **Delete Workspace** dialog, enter the name of the workspace, then click **OK**. + +== Delete Multiple Workspaces + +include::../../../_custom-en/platformManagement/platformManagement-oper-logIn.adoc[] + +. Click **Workspace Management**. + +. Select the checkbox on the left of the workspaces you want to delete, then click **Delete** above the workspace list. + +. In the **Delete Multiple Workspaces** dialog, enter the name of the workspaces, then click **OK**. ++ +[.admon.note,cols="a"] +|=== +|Note + +|Please separate multiple names using a comma (,) and a space. + +|=== diff --git a/content/en/docs/v4.1/08-workspace-management/02-workspaces/_index.adoc b/content/en/docs/v4.1/08-workspace-management/02-workspaces/_index.adoc new file mode 100644 index 000000000..4d23396ed --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/02-workspaces/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Manage Workspaces" +linkTitle: "Manage Workspaces" +keywords: "Kubernetes, KubeSphere, Access Control, Workspaces" +description: "Learn how to manage workspaces." +layout: "second" +weight: 02 +--- + +This section explains how to create and manage multiple workspaces. diff --git a/content/en/docs/v4.1/08-workspace-management/03-overview/01-view-workspace-resource-usage.adoc b/content/en/docs/v4.1/08-workspace-management/03-overview/01-view-workspace-resource-usage.adoc new file mode 100644 index 000000000..75f7a352f --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/03-overview/01-view-workspace-resource-usage.adoc @@ -0,0 +1,30 @@ +--- +title: "View Resource Usage" +linkTitle: "View Resource Usage" +keywords: "Kubernetes, KubeSphere, Workspace Management, Overview, View Workspace Resource Usage" +description: "Learn how to view workspace resource usage." +weight: 01 +--- + +:ks_permission: **Workspace Settings Viewing** +:ks_navigation: **Overview** + +This section explains how to view workspace resource usage. + + +== Prerequisites + + +include::../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + + + +== Steps + +include::../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] ++ +The **Resource Usage** tab on the **Overview** page provides information on the number of projects, roles, and members in the workspace. \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/03-overview/03-view-cluster-resource-usage.adoc b/content/en/docs/v4.1/08-workspace-management/03-overview/03-view-cluster-resource-usage.adoc new file mode 100644 index 000000000..9d0f26d83 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/03-overview/03-view-cluster-resource-usage.adoc @@ -0,0 +1,32 @@ +--- +title: "View Cluster Information" +linkTitle: "View Cluster Information" +keywords: "Kubernetes, KubeSphere, Workspace Management, Overview, View Cluster Information" +description: "Learn how to view cluster information." +weight: 03 +--- + +:ks_permission: **Workspace Settings Viewing** +:ks_navigation: **Overview** + +This section explains how to view basic information about the clusters authorized for the workspace. + + +== Prerequisites + + +include::../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + + + +== Steps + +include::../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. Click the **Cluster Information** tab on the **Overview** page to view basic information about the clusters authorized for the workspace. \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/03-overview/_index.adoc b/content/en/docs/v4.1/08-workspace-management/03-overview/_index.adoc new file mode 100644 index 000000000..403ddb656 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/03-overview/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Overview" +linkTitle: "Overview" +keywords: "Kubernetes, KubeSphere, Workspace Management, Overview" +description: "Learn how to get workspace overview info." +layout: "second" +weight: 03 +--- + +This section explains how to get workspace overview info. \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/04-projects/01-create-a-project.adoc b/content/en/docs/v4.1/08-workspace-management/04-projects/01-create-a-project.adoc new file mode 100644 index 000000000..73c0a6741 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/04-projects/01-create-a-project.adoc @@ -0,0 +1,52 @@ +--- +title: "Create Projects" +linkTitle: "Create Projects" +keywords: "Kubernetes, KubeSphere, Workspace Management, Project, Create Project" +description: "Learn how to create a project." +weight: 01 +--- + + +:ks_permission: **Project Creation** +:ks_navigation: **Projects** + + +This section introduces how to create a project. + + +== Prerequisites + +include::../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + + +== Steps + +include::../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +. In the pop-up dialog, set the parameters for the project, and then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +include::../../../_custom-en/clusterManagement/projects/projects-para-name.adoc[] + +include::../../../_custom-en/clusterManagement/projects/projects-para-aliasDescription.adoc[] + +|Cluster +|The cluster available for the project. Resources in the project run on the selected cluster. +|=== + +After creating the project, you can invite users to join the project and deploy business in the project. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/04-projects/02-view-a-project-list.adoc b/content/en/docs/v4.1/08-workspace-management/04-projects/02-view-a-project-list.adoc new file mode 100644 index 000000000..000ad88ea --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/04-projects/02-view-a-project-list.adoc @@ -0,0 +1,61 @@ +--- +title: "View Project List" +linkTitle: "View Project List" +keywords: "Kubernetes, KubeSphere, Workspace Management, Project, View Project List" +description: "Introduces how to view the project list." +weight: 02 +--- + +:ks_permission: **Project Viewing** +:ks_navigation: **Projects** + + +include::../../../_custom-en/workspaceManagement/projects/projects-desc-viewProjectList.adoc[] + + +== Prerequisites + +include::../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + + +== Steps + +include::../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + ++ +==== +* The project list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Name +|The name and description of the project. + +|Status +|The current status of the project. + +* **Active**: The project is in normal status. +* **Deleting**: The project is being deleted. + +|Creation Time +|The creation time of the project. +|=== +-- + +include::../../../_custom-en/workspaceManagement/projects/projects-oper-searchForProjects.adoc[] + +include::../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../_ks_components-en/oper-customizeColumns.adoc[] + + +* Click the name of a project in the list to open the project management page. You can view and manage resources in the project on the page. + +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/04-projects/03-edit-project-information.adoc b/content/en/docs/v4.1/08-workspace-management/04-projects/03-edit-project-information.adoc new file mode 100644 index 000000000..2830a51d8 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/04-projects/03-edit-project-information.adoc @@ -0,0 +1,33 @@ +--- +title: "Edit Project Information" +linkTitle: "Edit Project Information" +keywords: "Kubernetes, KubeSphere, Workspace Management, Project, Edit Project Information" +description: "Introduces how to edit project information." +weight: 03 +--- + +:ks_permission: **Project Management** +:ks_navigation: **Projects** + + +include::../../../_custom-en/clusterManagement/projects/projects-desc-editInformation.adoc[] + +include::../../../_custom-en/clusterManagement/projects/projects-note-editInformation.adoc[] + + +== Prerequisites + +include::../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + + +== Steps + +include::../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../_custom-en/clusterManagement/projects/projects-oper-editInformation.adoc[] diff --git a/content/en/docs/v4.1/08-workspace-management/04-projects/04-edit-project-annotations.adoc b/content/en/docs/v4.1/08-workspace-management/04-projects/04-edit-project-annotations.adoc new file mode 100644 index 000000000..fdc7ce2c3 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/04-projects/04-edit-project-annotations.adoc @@ -0,0 +1,41 @@ +--- +title: "Edit Project Annotations" +linkTitle: "Edit Project Annotations" +keywords: "Kubernetes, KubeSphere, Workspace Management, Project, Edit Project Annotations" +description: "Introduces how to edit project annotations." +weight: 04 +--- + +:ks_permission: **Project Management** +:ks_navigation: **Projects** + + +This section introduces how to edit project annotations. + +Project annotations are key-value pairs used to add additional metadata or descriptive information to a project. + + +== Prerequisites + +include::../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + + + +== Steps + +include::../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the project you want to edit, then select **Edit Annotations** from the dropdown list. + +. In the **Edit Annotations** dialog, set the key-value pairs, then click **OK**. ++ +-- +* Click **Add** to set multiple annotations. + +* To delete an annotation, click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] next to the created annotation. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/04-projects/05-edit-project-quotas.adoc b/content/en/docs/v4.1/08-workspace-management/04-projects/05-edit-project-quotas.adoc new file mode 100644 index 000000000..985233fdf --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/04-projects/05-edit-project-quotas.adoc @@ -0,0 +1,34 @@ +--- +title: "Edit Project Quotas" +linkTitle: "Edit Project Quotas" +keywords: "Kubernetes, KubeSphere, Workspace Management, Project, Edit Project Quotas" +description: "Introduces how to edit project quotas." +weight: 05 +--- + +:ks_permission: **Project Management** +:ks_navigation: **Projects** + + +include::../../../_custom-en/clusterManagement/projects/projects-desc-editQuotas.adoc[] + + +== Prerequisites + +include::../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + + +== Steps + +include::../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the project you want to edit, then select **Edit Quotas** from the dropdown list. + ++ + +include::../../../_custom-en/clusterManagement/projects/projects-oper-editProjectQuotas.adoc[] + diff --git a/content/en/docs/v4.1/08-workspace-management/04-projects/06-delete-projects.adoc b/content/en/docs/v4.1/08-workspace-management/04-projects/06-delete-projects.adoc new file mode 100644 index 000000000..fe8441c57 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/04-projects/06-delete-projects.adoc @@ -0,0 +1,44 @@ +--- +title: "Delete Projects" +linkTitle: "Delete Projects" +keywords: "Kubernetes, KubeSphere, Workspace Management, Project, Delete Project" +description: "Introduces how to delete a project." +weight: 06 +--- + +:ks_permission: **Project Management** +:ks_navigation: **Projects** + + +include::../../../_custom-en/clusterManagement/projects/projects-desc-deleteProjects.adoc[] + + +== Prerequisites + +include::../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + + +== Delete a Single Project + +include::../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../_custom-en/clusterManagement/projects/projects-oper-deleteASingleProject.adoc[] + + +== Delete Multiple Projects + +include::../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../_custom-en/clusterManagement/projects/projects-oper-deleteMultipleProjects.adoc[] diff --git a/content/en/docs/v4.1/08-workspace-management/04-projects/_index.adoc b/content/en/docs/v4.1/08-workspace-management/04-projects/_index.adoc new file mode 100644 index 000000000..6152d7fb3 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/04-projects/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "Projects" +linkTitle: "Projects" +keywords: "Kubernetes, KubeSphere, Workspace Management, Projects" +description: "Learn how to view project information and manage projects." +layout: "second" +weight: 04 +--- + +This section explains how to manage projects within a workspace. + +In KubeSphere, workspaces and projects are used for grouping and managing resources. Each workspace can contain multiple projects. \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/01-add-an-app-repository.adoc b/content/en/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/01-add-an-app-repository.adoc new file mode 100644 index 000000000..33c847b07 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/01-add-an-app-repository.adoc @@ -0,0 +1,43 @@ +--- +title: "Add Application Repository" +linkTitle: "Add Application Repository" +keywords: "Kubernetes, KubeSphere, Workspace, Application Repository, Add Application Repository" +description: "Introduces how to add an application repository." +weight: 01 +--- + +:ks_permission: **App Repos Management** +:ks_navigation: **App Management > App Repositories** + +This section introduces how to add an application repository in the workspace. + + +== Prerequisites + +* {empty} +include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +* The Helm Chart repository has been created in advance. For information on how to create a Helm Chart repository, please refer to the link:https://helm.sh/zh/docs/topics/chart_repository/[Helm Documentation]. + + +== Steps + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +. In the **Add App Repository** dialog, configure the parameters for the application repository, and then click **OK**. ++ +-- +include::../../../../_custom-en/workspaceManagement/appRepositories/appRepositories-para-createAppRepository_v4.adoc[] + +The newly created application repository will appear in the application repository list. +-- diff --git a/content/en/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/02-view-an-app-repository-list.adoc b/content/en/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/02-view-an-app-repository-list.adoc new file mode 100644 index 000000000..d62ba62ec --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/02-view-an-app-repository-list.adoc @@ -0,0 +1,59 @@ +--- +title: "View Application Repository List" +linkTitle: "View Application Repository List" +keywords: "Kubernetes, KubeSphere, Workspace, Application Repository, View Application Repository List" +description: "Explains how to view the list of application repositories." +weight: 02 +--- + +:ks_permission: **App Repos Viewing** +:ks_navigation: **App Management > App Repositories** + +This section explains how to view the list of application repositories. + + +== Prerequisites + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +== Steps + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +==== +* Application repository list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Name +|Name, alias, and description of the application repository. + +|Status +|Current status of the application repository. + +* **Successful**: The application repository has been added and synchronized successfully. + +* **Syncing**: The application repository is currently syncing with the Helm Chart repository. + +* **Not Syncing**: When the sync interval is set to 0, the application repository is not syncing with the Helm Chart repository. + +* **Failed**: Synchronization between the application repository and the Helm Chart repository has failed. + +|URL +|URL of the Helm Chart repository. +|=== +-- + +* Click the search box at the top of the list to search for application repositories by name. + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/03-edit-an-app-repository.adoc b/content/en/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/03-edit-an-app-repository.adoc new file mode 100644 index 000000000..becaf0615 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/03-edit-an-app-repository.adoc @@ -0,0 +1,34 @@ +--- +title: "Edit Application Repository" +linkTitle: "Edit Application Repository" +keywords: "Kubernetes, KubeSphere, Workspace, Application Repository, Edit Application Repository" +description: "Explains how to edit an application repository." +weight: 03 +--- + +:ks_permission: **App Repos Management** +:ks_navigation: **App Management > App Repositories** + +This section explains how to edit an application repository. + +== Prerequisites + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +== Steps + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +* Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the application repository you want to edit, then select **Edit Information** from the drop-down list. + +* In the **Edit App Repository** dialog, configure the parameters for the application repository, then click **OK**. ++ +-- +include::../../../../_custom-en/workspaceManagement/appRepositories/appRepositories-para-createAppRepository_v4.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/04-sync-an-app-repository-with-a-helm-chart-repository.adoc b/content/en/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/04-sync-an-app-repository-with-a-helm-chart-repository.adoc new file mode 100644 index 000000000..2c67b52ed --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/04-sync-an-app-repository-with-a-helm-chart-repository.adoc @@ -0,0 +1,35 @@ +--- +title: "Sync App Repository with Helm Chart Repository" +linkTitle: "Sync App Repository with Helm Chart Repository" +keywords: "Kubernetes, KubeSphere, Workspace, Application Repository, Sync Application Repository, Helm Chart Repository" +description: "Explains how to sync an application repository with a Helm Chart repository." +draft: true +weight: 04 +--- + +:ks_permission: **App Repos Management** +:ks_navigation: **App Management > App Repositories** + +This section explains how to sync an application repository with a Helm Chart repository. + +If you have set a sync interval when adding the application repository, the system will automatically sync the application repository with the Helm Chart repository based on the sync interval. You can also manually sync the application repository with the Helm Chart repository following the steps outlined in this section. + +== Prerequisites + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +== Steps + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +* Select the checkbox on the left of the application repository you want to sync, then click **Sync** at the top of the list. ++ +-- +The system will update the application repository based on the Helm Chart repository. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/05-delete-an-app-repository.adoc b/content/en/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/05-delete-an-app-repository.adoc new file mode 100644 index 000000000..337134c13 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/05-delete-an-app-repository.adoc @@ -0,0 +1,37 @@ +--- +title: "Delete Application Repository" +linkTitle: "Delete Application Repository" +keywords: "Kubernetes, KubeSphere, Workspace, Application Repository, Delete Application Repository" +description: "Explains how to delete an application repository." +weight: 05 +--- + +:ks_permission: **App Repos Management** +:ks_navigation: **App Management > App Repositories** + +This section explains how to delete an application repository. + +// Warning +include::../../../../../_ks_components-en/admonitions/warning.adoc[] + +After deleting an application repository, users will not be able to install applications from the repository. Please proceed with caution. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] + +== Prerequisites + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +== Steps + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +* Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the application repository you want to delete, then select **Delete** from the drop-down list. + +* In the **Delete App Repository** dialog, enter the name of the application repository, then click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/_index.adoc b/content/en/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/_index.adoc new file mode 100644 index 000000000..f1284112f --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/_index.adoc @@ -0,0 +1,14 @@ +--- +title: "Application Repository" +linkTitle: "Application Repository" +keywords: "Kubernetes, KubeSphere, Workspace, Application Management, Application Repository" +description: "Introduces how to add and manage application repositories to deploy and manage applications." +layout: "second" +weight: 02 +--- + +This section introduces how to manage application repositories in the workspace. + +In KubeSphere, applications specifically refer to business programs composed of one or more workloads, services, ingresses, and other resources. The application repository in KubeSphere is based on Helm, defining the orchestration of applications through Helm Charts. + +You can add a Helm Chart repository as an application repository to the workspace, allowing you to install applications from the application repository into projects within the workspace. For information on how to create a Helm Chart repository, please refer to the link:https://helm.sh/zh/docs/topics/chart_repository/[Helm Documentation]. \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/05-app-management/_index.adoc b/content/en/docs/v4.1/08-workspace-management/05-app-management/_index.adoc new file mode 100644 index 000000000..d1a778544 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/05-app-management/_index.adoc @@ -0,0 +1,8 @@ +--- +title: "Application Management" +linkTitle: "Application Management" +keywords: "Kubernetes, KubeSphere, Workspace, Application Management" +description: "Introduces how to manage application repositories through workspace." +layout: "second" +weight: 05 +--- diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/01-view-workspace-basic-information.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/01-view-workspace-basic-information.adoc new file mode 100644 index 000000000..7a11bb273 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/01-view-workspace-basic-information.adoc @@ -0,0 +1,40 @@ +--- +title: "View Workspace Basic Information" +linkTitle: "View Workspace Basic Information" +keywords: "Kubernetes, KubeSphere, Workspace, Workspace Settings, Basic Information, View Workspace Basic Information" +description: "Explains how to view workspace basic information." +weight: 01 +--- + +:ks_navigation: **Workspace Settings > Basic Info** + +This section explains how to view workspace basic information. + +== Prerequisites + +You should be a member of a workspace. For more information, refer to link:../../03-workspace-members/[Workspace Members] and link:../../04-workspace-roles/[Workspace Roles]. + +== Steps + +. Log in to the KubeSphere web console and navigate to your workspace. + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +-- +The **Basic Information** page provides the following information: + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Workspace Information +| Information about the current workspace, including the workspace name, administrator, creation time, and number of workspace members. + +| Network Isolation +| The network isolation status of the clusters authorized for the workspace. When network isolation is enabled for the clusters authorized for the workspace, pods running in the workspace on those clusters cannot be accessed by clients outside the workspace or outside the clusters. Outbound traffic from pods running in the workspace on those clusters is not restricted. + +By default, network isolation is disabled. It can be enabled after installing the "KubeSphere Network" extension. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/02-edit-workspace-information.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/02-edit-workspace-information.adoc new file mode 100644 index 000000000..0c6a9cb7f --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/02-edit-workspace-information.adoc @@ -0,0 +1,45 @@ +--- +title: "Edit Workspace Information" +linkTitle: "Edit Workspace Information" +keywords: "Kubernetes, KubeSphere, Workspace, Workspace Settings, Basic Information, Edit Workspace Information" +description: "Explains how to edit workspace information." +weight: 02 +--- + +:ks_permission: **Workspace Settings Management** +:ks_navigation: **Workspace Settings > Basic Info** + +This section explains how to edit workspace information. + +You can edit the alias and description of the workspace. KubeSphere does not support editing the name of a workspace that has already been created. + +== Prerequisites + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +== Steps + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. In the **Workspace Information** area, select **Manage > Edit Information** from the top right corner. + +. In the **Edit Information** dialog, set the alias and description for the workspace, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +| Alias +| The alias for the workspace. Aliases can be the same for different workspaces. Aliases can only contain letters, numbers, and hyphens (-), and cannot begin or end with a hyphen (-). The maximum length is 63 characters. + +| Description +| Information describing the workspace. The description can contain any characters and has a maximum length of 256 characters. +|=== +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/04-delete-a-workspace.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/04-delete-a-workspace.adoc new file mode 100644 index 000000000..b7083c0e6 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/04-delete-a-workspace.adoc @@ -0,0 +1,48 @@ +--- +title: "Delete Workspaces" +linkTitle: "Delete Workspaces" +keywords: "Kubernetes, KubeSphere, Workspace, Workspace Settings, Basic Information, Delete Workspace" +description: "Instructions on how to delete a workspace." +weight: 04 +--- + +:ks_permission: **Workspace Settings Management** +:ks_navigation: **Workspace Settings > Basic Info** + +This section provides guidance on deleting a workspace. + +// Warning +include::../../../../../_ks_components-en/admonitions/warning.adoc[] + +Deleting a workspace is irreversible. If you choose to delete projects within the workspace, all projects and their resources within the workspace will also be deleted. Please proceed with caution. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] + + +== Prerequisites + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + + +== Steps + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. In the **Workspace Information** area, select **Manage > Delete Workspace** from the top right corner. + +. In the **Delete Workspace** dialog, enter the name of the workspace, then click **OK**. ++ +-- +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +You can select the **Delete projects in the workspace** checkbox to delete all projects within the workspace simultaneously. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/_index.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/_index.adoc new file mode 100644 index 000000000..d385371c0 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Basic Information" +linkTitle: "Basic Information" +keywords: "Kubernetes, KubeSphere, Workspace, Workspace Settings, Basic Information" +description: "Explains how to view and edit basic information for workspaces." +layout: "second" +weight: 01 +--- + +This section explains how to view and manage basic information for workspaces. \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/01-edit-workspace-quotas.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/01-edit-workspace-quotas.adoc new file mode 100644 index 000000000..a63933f47 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/01-edit-workspace-quotas.adoc @@ -0,0 +1,55 @@ +--- +title: "Edit Workspace Quotas" +linkTitle: "Edit Workspace Quotas" +keywords: "Kubernetes, KubeSphere, Workspace, Workspace Settings, Workspace Quotas, Edit Workspace Quotas" +description: "Instructions on how to edit workspace quotas." +weight: 01 +--- + +:ks_permission: **Workspace Settings Management** +:ks_navigation: **Workspace Settings > Workspace Quotas** + + +This section explains how to edit workspace quotas. + +In KubeSphere, multiple clusters can be authorized to the same workspace. You can set resource quotas for each cluster within a workspace. + +== Prerequisites + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + + +== Steps + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. Click **Edit Quotas** in the top right corner of the cluster you want to edit. ++ +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|CPU Limit +|Maximum sum of CPU limits for all containers running in a workspace on a single cluster. + +|CPU Request +|Maximum sum of CPU reservations for all containers running in a workspace on a single cluster. + +|Memory Limit +|Maximum sum of memory limits for all containers running in a workspace on a single cluster. + +|Memory Request +|Maximum sum of memory reservations for all containers running in a workspace on a single cluster. + +|Storage Resource Quota +|Limit the total amount of storage resources under a workspace, including total storage resources and storage class bound resources. +|=== ++ + +. After modifying the quotas, click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/02-view-workspace-quotas.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/02-view-workspace-quotas.adoc new file mode 100644 index 000000000..f773064c5 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/02-view-workspace-quotas.adoc @@ -0,0 +1,31 @@ +--- +title: "View Workspace Quotas" +linkTitle: "View Workspace Quotas" +keywords: "Kubernetes, KubeSphere, Workspace, Workspace Settings, Workspace Quotas, View Workspace Quotas" +description: "Guide on how to view workspace quotas." +weight: 02 +--- + +:ks_permission: **Workspace Settings Viewing** +:ks_navigation: **Workspace Settings > Workspace Quotas** + +This section explains how to view workspace quotas. + +== Prerequisites + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + + +== Steps + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +-- +The **Workspace Quotas** page displays resource quota information for clusters authorized to the workspace: + +include::../../../../_custom-en/workspaceManagement/workspace-quotas/workspaceQuotas-para-cpuMemoryQuotas.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/_index.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/_index.adoc new file mode 100644 index 000000000..ff0fd6e5f --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/_index.adoc @@ -0,0 +1,18 @@ +--- +title: "Workspace Quotas" +linkTitle: "Workspace Quotas" +keywords: "Kubernetes, KubeSphere, Workspace, Workspace Settings, Workspace Quotas" +description: "Guide on how to view and manage workspace quotas." +layout: "second" +weight: 02 +--- + + + +This section explains how to view and manage workspace resource quotas. + +In KubeSphere, multiple clusters can be authorized to the same workspace. You can set resource quotas for each cluster within a workspace. Workspace quotas consist of two types of settings: + +* Resource Request: Container resource request is the resources reserved by the system for a single container. Workspace resource request is the maximum sum of all container resource requests for a workspace running in a single cluster. KubeSphere currently supports setting CPU request and memory request for workspaces. + +* Resource Limit: Container resource limit is the maximum resources that a single container can utilize. Workspace resource limit is the maximum sum of all container resource limits for a workspace running in a single cluster. KubeSphere currently supports setting CPU limit and memory limit for workspaces. \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/01-invite-a-user-to-a-workspace.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/01-invite-a-user-to-a-workspace.adoc new file mode 100644 index 000000000..aeda4d702 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/01-invite-a-user-to-a-workspace.adoc @@ -0,0 +1,36 @@ +--- +title: "Invite Users to Join Workspaces" +linkTitle: "Invite Users to Join Workspaces" +keywords: "Kubernetes, KubeSphere, Workspace Management, Workspace Settings, Workspace Members, Invite Users to Join Workspace" +description: "Guide on how to invite users to join a workspace." +weight: 01 +--- + +:ks_permission: **Member Management** +:ks_navigation: **Workspace Settings > Workspace Members** + +This section explains how to invite users to join a workspace. + +== Prerequisites + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +== Steps + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ +include::../../../../../_ks_components-en/oper-clickInvite.adoc[] + ++ + +. In the **Invite Member** dialog, click image:/images/ks-qkcp/zh/icons/add-dark.svg[add-dark,18,18] next to the user you want to invite. Select the role of the user in the workspace from the dropdown list, then click **OK**. ++ +-- +include::../../../../_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-presetRoles_v4.adoc[] + +The invited user will be displayed in the workspace members list. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/02-view-a-workspace-member-list.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/02-view-a-workspace-member-list.adoc new file mode 100644 index 000000000..f55271ac3 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/02-view-a-workspace-member-list.adoc @@ -0,0 +1,57 @@ +--- +title: "View Workspace Member List" +linkTitle: "View Workspace Member List" +keywords: "Kubernetes, KubeSphere, Workspace Management, Workspace Settings, Workspace Members, View Workspace Member List" +description: "Guide on how to view the workspace member list." +weight: 02 +--- + +:ks_permission: **Member Viewing** +:ks_navigation: **Workspace Settings > Workspace Members** + + +This section explains how to view the workspace member list. + + +== Prerequisites + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +== Steps + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +==== +* The workspace member list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Username +|The username of the workspace member. + +|Status +| +The current status of the workspace member. + +include::../../../../_custom-en/clusterManagement/clusterMembers/clusterMembers-para-userStatus.adoc[] + +|Role +|The role of the workspace member within the workspace. + +|Last Login +|The time when the workspace member last logged into the {ks_product-en} web console. +|=== +-- + +* Click the search box at the top of the list to search for workspace members by name. + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/03-view-workspace-member-details.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/03-view-workspace-member-details.adoc new file mode 100644 index 000000000..c33134eba --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/03-view-workspace-member-details.adoc @@ -0,0 +1,52 @@ +--- +title: "View Workspace Member Details" +linkTitle: "View Workspace Member Details" +keywords: "Kubernetes, KubeSphere, Workspace Management, Workspace Settings, Workspace Members, View Workspace Member Details" +description: "Guide on how to view workspace member details." +weight: 03 +--- + +:ks_permission: **Member Viewing** +:ks_navigation: **Workspace Settings > Workspace Members** + +This section explains how to view workspace member details. + +== Prerequisites + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +== Steps + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. Click the name of a workspace member in the list to open its details page. + +. In the **Attributes** section on the left side of the workspace member details page, view the resource attributes of the workspace member. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Workspace +|The name of the current workspace. + +|Workspace Role +|The role of the workspace member. + +|Email +|The email address of the workspace member. +|=== +-- + +. On the **Projects** tab on the right side of the details page, view the projects to which the workspace member belongs. ++ +-- +Click **Clusters** in the top left corner and select a cluster to view projects in a specific cluster. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/04-change-the-role-of-a-workspace-member.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/04-change-the-role-of-a-workspace-member.adoc new file mode 100644 index 000000000..b5d31dfd1 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/04-change-the-role-of-a-workspace-member.adoc @@ -0,0 +1,33 @@ +--- +title: "Change Workspace Member Roles" +linkTitle: "Change Workspace Member Roles" +keywords: "Kubernetes, KubeSphere, Workspace Management, Workspace Settings, Workspace Members, Change Workspace Member Role" +description: "Guide on how to change the role of a workspace member." +weight: 04 +--- + +:ks_permission: **Member Management** +:ks_navigation: **Workspace Settings > Workspace Members** + +This section explains how to change the role of a workspace member. + +== Prerequisites + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +== Steps + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. On the right side of the workspace member you want to edit, click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18], then select **Change Role**. + +. In the **Change Role** dialog, set the role for the workspace member from the dropdown list, then click **OK**. ++ +-- +include::../../../../_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-presetRoles_v4.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/05-remove-a-workspace-member.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/05-remove-a-workspace-member.adoc new file mode 100644 index 000000000..8901551b2 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/05-remove-a-workspace-member.adoc @@ -0,0 +1,40 @@ +--- +title: "Remove Workspace Members" +linkTitle: "Remove Workspace Members" +keywords: "Kubernetes, KubeSphere, Workspace Management, Workspace Settings, Workspace Members, Remove Workspace Member" +description: "Guide on how to remove a workspace member." +weight: 05 +--- + +:ks_permission: **Member Management** +:ks_navigation: **Workspace Settings > Workspace Members** + +This section explains how to remove a workspace member. + +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +Once a user is removed from the workspace, they will lose the permissions provided by the workspace role. If the user has joined projects in the workspace, they will also be removed from those projects. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] + +== Prerequisites + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +== Steps + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. On the right side of the workspace member you want to remove, click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18], then select **Remove**. + +. In the **Remove Member** dialog, enter the username of the workspace member, then click **OK**. ++ +-- +Once the workspace member is removed, they will no longer appear in the workspace member list. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/_index.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/_index.adoc new file mode 100644 index 000000000..4212a9128 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/_index.adoc @@ -0,0 +1,19 @@ +--- +title: "Workspace Members" +linkTitle: "Workspace Members" +keywords: "Kubernetes, KubeSphere, Workspace, Workspace Settings, Workspace Members" +description: "Guide on how to manage workspace members." +layout: "second" +weight: 03 +--- + +This section explains how to manage workspace members. + +Workspace members are users who have permissions to view or manage resources in a workspace. The permissions of workspace members are determined by the roles they have in the workspace. + +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +include::../../../../_custom-en/workspaceManagement/workspaceMembers/workspaceMembers-desc-initialWorkspaceAdmin.adoc[] + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/01-create-a-workspace-role.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/01-create-a-workspace-role.adoc new file mode 100644 index 000000000..56a6fa71a --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/01-create-a-workspace-role.adoc @@ -0,0 +1,48 @@ +--- +title: "Create Workspace Roles" +linkTitle: "Create Workspace Roles" +keywords: "Kubernetes, KubeSphere, Workspace, Workspace Settings, Workspace Role, Create Workspace Role" +description: "Guide on creating a workspace role." +weight: 01 +--- + +:ks_permission: **Role Management** +:ks_navigation: **Workspace Settings > Workspace Roles** + +This section explains how to create a workspace role. + +== Prerequisites + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +== Steps + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ +include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +. In the **Create Workspace Role** dialog, set the name, alias, and description of the workspace role, then click **Edit Permissions**. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter | Description + +|Name +|The name of the workspace role. The name can only contain lowercase letters, numbers, and hyphens (-), must start and end with a lowercase letter or number, and can be up to 63 characters long. + +include::../../../../_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-aliasAndDescription.adoc[] +|=== +-- + +. In the **Edit Permissions** dialog, set the permissions for the workspace role, then click **OK**. ++ +==== +include::../../../../_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions_v4.adoc[] +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/02-view-a-workspace-role-list.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/02-view-a-workspace-role-list.adoc new file mode 100644 index 000000000..1ce23b15e --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/02-view-a-workspace-role-list.adoc @@ -0,0 +1,31 @@ +--- +title: "View Workspace Role List" +linkTitle: "View Workspace Role List" +keywords: "Kubernetes, KubeSphere, Workspace, Workspace Settings, Workspace Role, View Workspace Role List" +description: "Guide on how to view the workspace role list." +weight: 02 +--- + +:ks_permission: **Role Viewing** +:ks_navigation: **Workspace Settings > Workspace Roles** + +This section explains how to view the workspace role list. + +Each workspace role contains specific workspace management or viewing permissions. You can grant roles with specific permissions to workspace members to control their permissions within the workspace. + +== Prerequisites + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +== Steps + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +-- +include::../../../../_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-presetRoles_v4.adoc[] + +You can also create custom workspace roles. For more information, see link:../01-create-a-workspace-role/[Create Workspace Roles]. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/03-view-workspace-role-details.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/03-view-workspace-role-details.adoc new file mode 100644 index 000000000..d8f78d750 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/03-view-workspace-role-details.adoc @@ -0,0 +1,39 @@ +--- +title: "View Workspace Role Details" +linkTitle: "View Workspace Role Details" +keywords: "Kubernetes, KubeSphere, Workspace, Workspace Settings, Workspace Role, View Workspace Role Details" +description: "Guide on how to view workspace role details." +weight: 03 +--- + +:ks_permission: **Role Viewing** +:ks_navigation: **Workspace Settings > Workspace Roles** + +This section explains how to view workspace role details. + +== Prerequisites + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +== Steps + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. Click the name of a workspace role in the list to open its details page. + +. On the **Permissions** tab on the right side of the details page, view the permissions granted to the workspace role. ++ +==== +include::../../../../_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions_v4.adoc[] +==== + +. Click the **Authorized Users** tab on the right side of the details page to view the users assigned to the current workspace role. ++ +-- +include::../../../../_custom-en/clusterManagement/clusterRoles/clusterRoles-para-authorizedUsers.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/04-edit-workspace-role-information.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/04-edit-workspace-role-information.adoc new file mode 100644 index 000000000..dc31a6689 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/04-edit-workspace-role-information.adoc @@ -0,0 +1,40 @@ +--- +title: "Edit Workspace Role Information" +linkTitle: "Edit Workspace Role Information" +keywords: "Kubernetes, KubeSphere, Workspace, Workspace Settings, Workspace Role, Edit Workspace Role Information" +description: "Guide on how to edit workspace role information." +weight: 04 +--- + +:ks_permission: **Role Management** +:ks_navigation: **Workspace Settings > Workspace Roles** + +This section explains how to edit workspace role information. + +You can edit the alias and description of workspace roles created by users. KubeSphere does not support editing preset workspace roles and does not support editing the names of workspace roles. + +== Prerequisites + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +== Steps + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the workspace role you want to edit, then select **Edit Information** from the dropdown list. + +. In the **Edit Information** dialog, set the alias and description for the workspace role, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +include::../../../../_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-aliasAndDescription.adoc[] +|=== +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/05-edit-permissions-of-a-workspace-role.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/05-edit-permissions-of-a-workspace-role.adoc new file mode 100644 index 000000000..9ba39ff12 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/05-edit-permissions-of-a-workspace-role.adoc @@ -0,0 +1,35 @@ +--- +title: "Edit Workspace Role Permissions" +linkTitle: "Edit Workspace Role Permissions" +keywords: "Kubernetes, KubeSphere, Workspace, Workspace Settings, Workspace Role, Edit Workspace Role Permissions" +description: "Guide on how to edit workspace role permissions." +weight: 05 +--- + +:ks_permission: **Role Management** +:ks_navigation: **Workspace Settings > Workspace Roles** + +This section explains how to edit workspace role permissions. + +You can only edit permissions for workspace roles created by users. Permissions for preset workspace roles cannot be edited. + +== Prerequisites + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +== Steps + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the workspace role you want to edit, then select **Edit Permissions** from the dropdown list. + +. In the **Edit Permissions** dialog, set the permissions for the workspace role, then click **OK**. ++ +==== +include::../../../../_custom-en/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions_v4.adoc[] +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/06-delete-a-workspace-role.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/06-delete-a-workspace-role.adoc new file mode 100644 index 000000000..74ff245b1 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/06-delete-a-workspace-role.adoc @@ -0,0 +1,34 @@ +--- +title: "Delete Workspace Roles" +linkTitle: "Delete Workspace Roles" +keywords: "Kubernetes, KubeSphere, Workspace, Workspace Settings, Workspace Role, Delete Workspace Role" +description: "Guide on how to delete workspace roles." +weight: 06 +--- + +:ks_permission: **Role Management** +:ks_navigation: **Workspace Settings > Workspace Roles** + +This section explains how to delete workspace roles. + +You can delete workspace roles created by users. Preset workspace roles cannot be deleted. + +== Prerequisites + +* Ensure the workspace role you want to delete is not assigned to any workspace members. Otherwise, you need to remove the workspace members or change their roles. + +* {empty} +include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +== Steps + +include::../../../../_custom-en/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the workspace role you want to delete, then select **Delete** from the dropdown list. + +. In the **Delete Role** dialog, click **OK** to confirm the deletion. \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/_index.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/_index.adoc new file mode 100644 index 000000000..4f2849d67 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/_index.adoc @@ -0,0 +1,19 @@ +--- +title: "Workspace Roles" +linkTitle: "Workspace Roles" +keywords: "Kubernetes, KubeSphere, Workspace, Workspace Settings, Workspace Roles" +description: "Guide on managing workspace roles." +layout: "second" +weight: 04 +--- + +This section explains how to manage workspace roles. + +Workspace roles contain specific management or viewing permissions for a workspace. You can assign roles with specific permissions to workspace members to control their permissions within the workspace. + +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +include::../../../../_custom-en/workspaceManagement/workspaceMembers/workspaceMembers-desc-initialWorkspaceAdmin.adoc[] + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] diff --git a/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/_index.adoc b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/_index.adoc new file mode 100644 index 000000000..1332218f5 --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/06-workspace-settings/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Workspace Settings" +linkTitle: "Workspace Settings" +keywords: "KubeSphere, Kubernetes, Workspace Quotas" +description: "Explains how to set up basic information for workspaces, modify workspace quotas, set workspace roles, and manage workspace members." +layout: "second" +weight: 06 +--- + +This section explains how to set up basic information for workspaces, modify workspace quotas, set workspace roles, and manage workspace members. \ No newline at end of file diff --git a/content/en/docs/v4.1/08-workspace-management/_index.adoc b/content/en/docs/v4.1/08-workspace-management/_index.adoc new file mode 100644 index 000000000..d5480c0ed --- /dev/null +++ b/content/en/docs/v4.1/08-workspace-management/_index.adoc @@ -0,0 +1,15 @@ +--- +title: "Workspace Management" +linkTitle: "Workspace Management" +keywords: "Kubernetes, KubeSphere, Workspace Management" +description: "Learn how to manage resources within a single workspace." +layout: "second" +weight: 08 +icon: "/images/docs/common/docs.svg" +--- + +This section explains how to manage resources within a workspace. + +In KubeSphere, a workspace is used to group resources for management. Cluster administrators can authorize one or more clusters to a workspace, allowing resources within the workspace to run on the cluster. Each workspace can contain multiple projects. Users can be invited to join a workspace and gain view and management permissions for workspace resources based on their workspace roles. + +After the {ks_product-en} installation is complete, the system will automatically create the **system-workspace** workspace, which includes system projects for managing system resources. \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/01-web-console/01-log-in-and-go-to-a-project.adoc b/content/en/docs/v4.1/09-project-management/01-web-console/01-log-in-and-go-to-a-project.adoc new file mode 100644 index 000000000..db6d15d8c --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/01-web-console/01-log-in-and-go-to-a-project.adoc @@ -0,0 +1,35 @@ +--- +title: "Log In and Access Projects" +linkTitle: "Log In and Access Projects" +keywords: "Kubernetes, KubeSphere, Project Management, Web Console, Access Project" +description: "This section explains how to log in and access a project." +weight: 01 +--- + +This section explains how to log in to the {ks_product-en} web console and access a project. + +== Prerequisites + +* You should have the username and password of a project member. + +include::../../../_custom-en/workspaceManagement/webConsole/webConsole-prer-logIn.adoc[] + + +== Steps + +include::../../../_custom-en/workspaceManagement/webConsole/webConsole-oper-logIn.adoc[] ++ +-- +// Note +include::../../../../_ks_components-en/admonitions/note.adoc[] + +include::../../../_custom-en/workspaceManagement/webConsole/webConsole-note-firstLogin.adoc[] + +include::../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- + +. Click **Workspace Management**. + +. Click the name of a workspace in the **Workspaces** page to access the workspace. + +. Click **Projects > Projects** on the left navigation pane, then click the name of a project to access the project. \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/01-web-console/_index.adoc b/content/en/docs/v4.1/09-project-management/01-web-console/_index.adoc new file mode 100644 index 000000000..3a787416e --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/01-web-console/_index.adoc @@ -0,0 +1,11 @@ +--- +title: "Access Your Project" +linkTitle: "Access Your Project" +keywords: "Kubernetes, KubeSphere, Project Management, Web Console" +description: "Learn how to access projects in the web console." +layout: "second" +weight: 01 +--- + + +This section explains how to access projects in the {ks_product-en} web console. diff --git a/content/en/docs/v4.1/09-project-management/02-overview/01-view-project-overall-information.adoc b/content/en/docs/v4.1/09-project-management/02-overview/01-view-project-overall-information.adoc new file mode 100644 index 000000000..2a279a66e --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/02-overview/01-view-project-overall-information.adoc @@ -0,0 +1,57 @@ +--- +title: "Project Overview" +linkTitle: "Project Overview" +keywords: "Kubernetes, KubeSphere, Project Management, Overview, Project Overview" +description: "Learn how to get an overview of the project." +weight: 01 +--- + +:ks_permission: **Project Settings Viewing** +:ks_navigation: **Overview** + + +This section introduces how to get an overview of the project. + + +== Prerequisites + + +:relfileprefix: ../../../ + +include::../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== Steps + +include::../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../_ks_components-en/oper-navigate.adoc[] ++ +-- +The **Overview** page provides the following information: + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Basic Information +|Includes the project's name, description, cluster, workspace, and creator. + +|Project Members and Roles +|Displays the number of project members and roles, as well as the most recently logged-in user. + +|Number of Created Resources +|Shows the quantity of resources in the current project, such as pods, deployments, statefulsets, daemonsets, jobs, cron jobs, persistent volume claims, services, ingresses, etc. + +|Project Quota +|The maximum total reserved resources for all containers in the project, and the maximum total resource limits for all containers in the project. If the project administrator has not set project quotas, it will not be displayed. + +|Default Container Quota +|The default value for reserved resources for a single container in the project, and the default value for resource limit for a single container in the project. If the project has not set default container quotas, it will not be displayed. +|=== +-- diff --git a/content/en/docs/v4.1/09-project-management/02-overview/_index.adoc b/content/en/docs/v4.1/09-project-management/02-overview/_index.adoc new file mode 100644 index 000000000..920b080ca --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/02-overview/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Overview" +linkTitle: "Overview" +keywords: "Kubernetes, KubeSphere, Project Management, Overview" +description: "Learn how to get an overview of a project." +layout: "second" +weight: 02 +--- + + diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/01-install-an-app-from-the-app-store.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/01-install-an-app-from-the-app-store.adoc new file mode 100644 index 000000000..0ae19ab3c --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/01-install-an-app-from-the-app-store.adoc @@ -0,0 +1,63 @@ +--- +title: "Install Applications from App Store" +linkTitle: "Install Applications from App Store" +keywords: "Kubernetes, KubeSphere, Project Management, Applications" +description: "Explains how to view project overview information." +weight: 01 +--- + +:ks_permission: **Application Instance Create** +:ks_navigation: **Application Workloads > Applications** + + +This section explains how to install applications from the App Store. + + +== Prerequisites + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +. Click **From App Store** in the **Create App** dialog. + +. In the App Store, click the application template you want to use, then click **Deploy** in the top right corner. ++ +-- +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +If the **Deployment Notice** dialog appears, carefully read the relevant content, then click **Agree**. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- + +. In the **Location** dialog that appears, select the installation location for the application, then click **OK**. + ++ + +include::../../../../_custom-en/projectManagement/apps/apps-oper-installApp.adoc[] + ++ +-- +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +Applications in the App Store are published by members with relevant permissions in the workspace or provided by third parties. For more information on application functional parameters, please contact relevant workspace members or the application provider. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] + +Once the application is created, it will be displayed in the list of applications. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/02-install-an-app-using-an-app-template.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/02-install-an-app-using-an-app-template.adoc new file mode 100644 index 000000000..84b6b8f1c --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/02-install-an-app-using-an-app-template.adoc @@ -0,0 +1,67 @@ +--- +title: "Install Applications Using App Templates" +linkTitle: "Install Applications Using App Templates" +keywords: "Kubernetes, KubeSphere, Project Management, Applications, Install Applications from Application Templates" +description: "Learn how to install applications from application templates." +weight: 02 +--- + + +:ks_permission: **Application Instance Create** +:ks_navigation: **Application Workloads > Applications** + + +This section explains how to install applications from application templates in the workspace or third-party application repositories. + +//note +[.admon.note,cols="a"] +|=== +|Note + +| +To use application templates in the workspace, you need to install and enable the "App Store Management" extension. After installation, **App Templates** will display under the **App Management** menu in the workspace. Workspace members with relevant permissions can then create application templates for the workspace. + +|=== + +== Prerequisites + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +. Click **From App Templates** in the **Create App** dialog. + +. On the **App Templates** page, click the **Current workspace** dropdown list and select the **Current workspace** or an application repository. + +. Click the desired application template, then click **Install**. + ++ + +include::../../../../_custom-en/projectManagement/apps/apps-oper-installApp.adoc[] + ++ +-- +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +Application templates and application repositories are created by workspace members with relevant permissions. + +For more information on application functional parameters, please contact relevant workspace members or the application provider. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] + +Once the application is created, it will be displayed in the list of applications. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/04-view-an-app-list.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/04-view-an-app-list.adoc new file mode 100644 index 000000000..792d388b0 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/04-view-an-app-list.adoc @@ -0,0 +1,67 @@ +--- +title: "View Application List" +linkTitle: "View Application List" +keywords: "Kubernetes, KubeSphere, Project Management, Applications, View Application List" +description: "Learn how to view the application list." +weight: 04 +--- + + +:ks_permission: **Application Instance View** +:ks_navigation: **Application Workloads > Applications** + + +This section explains how to view the application list. + + +== Prerequisites + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ +==== +* The application list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Name +|The name of the application. + +include::../../../../_custom-en/projectManagement/apps/apps-para-status_v4.adoc[] + +|App Type +|The type of application template, such as **Helm application** or **YAML application**. + +|App Template +|The application template used to create the application. Only applicable to template-based applications. + +|Version +|The version number of the application. + +* For template-based applications, it displays the version of the Helm Chart. + +// * For custom applications, it shows the user-defined version number. + +|Update Time +|The update time of the application. +|=== +-- + +* Click the search box at the top of the list to search for applications by name. + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/05-view-template-based-app-details.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/05-view-template-based-app-details.adoc new file mode 100644 index 000000000..0f0a17949 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/05-view-template-based-app-details.adoc @@ -0,0 +1,80 @@ +--- +title: "View Details of Template-based Applications" +linkTitle: "View Details of Template-based Applications" +keywords: "Kubernetes, KubeSphere, Project Management, Applications, View Details of Template-based Applications" +description: "Learn how to view details of template-based applications." +weight: 05 +--- + + +:ks_permission: **Application Instance View** +:ks_navigation: **Application Workloads > Applications** + + +This section explains how to view details of template-based applications. + + +== Prerequisites + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. On the **Applications** page, click the name of an application to open its details page. + +. In the **Attributes** section on the left side of the details page, view the resource attributes of the application. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Cluster +|The cluster to which the application belongs. + +|Project +|The project to which the application belongs. + +include::../../../../_custom-en/projectManagement/apps/apps-para-status_v4.adoc[] + +|Application +|The application template used by the application. + +include::../../../../_custom-en/projectManagement/apps/apps-para-details2.adoc[] +|=== +-- + ++ + +include::../../../../_custom-en/projectManagement/apps/apps-oper-viewResourceStatus_v4.adoc[] + ++ + +. On the right side of the details page, click **App Template** to view information about the application template. ++ +-- +* Click **App Description** to view information about the application. + +* Click **Chart Files** to view files in the Helm Chart package. Click the dropdown list on the right side of **Chart Files** to select the file you want to view. Click image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download,18,18] to download the file locally. +-- + +. On the right side of the details page, click **App Settings** to view application settings. ++ +-- +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +The default settings of the application are stored in the **values.yaml** file within the Helm Chart package. The **App Settings** page displays the settings customized by the user during the application installation. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/06-edit-app-information.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/06-edit-app-information.adoc new file mode 100644 index 000000000..7ee07d2f7 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/06-edit-app-information.adoc @@ -0,0 +1,31 @@ +--- +title: "Edit Application Information" +linkTitle: "Edit Application Information" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Applications, Edit Application Information" +description: "Learn how to edit application information." +weight: 06 +--- + +:ks_permission: **Application Instance Management** +:ks_navigation: **Application Workloads > Applications** + + +This section explains how to edit application information. + +You can edit the alias and description of an application. KubeSphere does not support editing the name of an already created application. + +## Prerequisites + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +## Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/projectManagement/apps/apps-oper-editAppInformation.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/08-edit-app-settings.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/08-edit-app-settings.adoc new file mode 100644 index 000000000..d5c4ca568 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/08-edit-app-settings.adoc @@ -0,0 +1,34 @@ +--- +title: "Edit Application Settings" +linkTitle: "Edit Application Settings" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Applications, Edit Application Settings" +description: "Learn how to edit application settings." +weight: 08 +--- + +:ks_permission: **Application Instance Management** +:ks_navigation: **Application Workloads > Applications** + +This section explains how to edit the settings of a created application. + +When creating an application, you can also edit its settings. For more information, see link:../01-install-an-app-from-the-app-store[Install Applications from App Store] and link:../02-install-an-app-using-an-app-template[Install Applications Using App Templates]. + +## Prerequisites + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +## Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. On the **Applications** page, click the name of an application to open its details page. + +. On the top left corner of the application details page, select **More > Edit Settings**. + +. In the **Edit App Settings** dialog, choose the target application version on the right, edit the application settings, and then click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/10-delete-apps.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/10-delete-apps.adoc new file mode 100644 index 000000000..b0cf3139a --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/10-delete-apps.adoc @@ -0,0 +1,49 @@ +--- +title: "Delete Applications" +linkTitle: "Delete Applications" +keywords: "Kubernetes, KubeSphere, Project Management, Applications, Delete Application" +description: "Learn how to delete an application." +weight: 10 +--- + +:ks_permission: **Application Instance Deletion** +:ks_navigation: **Application Workloads > Applications** + + +This section explains how to delete an application. + +## Prerequisites + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +## Delete a Single Application + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] next to the application you want to delete, and select **Delete** from the dropdown list. + +. In the **Delete App** dialog, enter the name of the application, and then click **OK**. + +## Delete Multiple Applications + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. Select the checkboxes next to the applications you want to delete, and then click **Delete** at the top of the application list. + +. In the **Delete Multiple Applications** dialog, enter the names of the applications, and then click **OK**. ++ +-- +include::../../../../_custom-en/note-separateNamesByComma.adoc[] +-- diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/_index.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/_index.adoc new file mode 100644 index 000000000..7dd3274fd --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/01-apps/_index.adoc @@ -0,0 +1,14 @@ +--- +title: "Applications" +linkTitle: "Applications" +keywords: "Kubernetes, KubeSphere, Project Management, Applications" +description: "Introduces how to manage installed applications within a project." +layout: "second" +weight: 01 +--- + +This section explains how to manage applications. + +In KubeSphere, applications specifically refer to business programs composed of one or more resources such as workloads, services, ingresses, etc. + +KubeSphere currently supports creating applications based on app templates, which means creating applications from existing application templates. The application template used for creating applications can be an application template published to the App Store, uploaded to the workspace, or from a remote application repository. diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/01-create-a-stateful-or-stateless-service.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/01-create-a-stateful-or-stateless-service.adoc new file mode 100644 index 000000000..7be649609 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/01-create-a-stateful-or-stateless-service.adoc @@ -0,0 +1,284 @@ +--- +title: "Create Stateful or Stateless Services" +linkTitle: "Create Stateful or Stateless Services" +keywords: "Kubernetes, KubeSphere, Project Management, Workloads, Services, Create Service, Create Stateful or Stateless Services" +description: "Introduces how to create stateful or stateless services." +weight: 01 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Services** + +This section introduces how to create stateful or stateless services. + + +== Prerequisites + + +include::../../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +Please refer to link:#_parameter_description[Parameter Description] for configuring the parameters of a service. + +include::../../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +. In the **Create Service** dialog, choose **Stateful Service** or **Stateless Service** based on your requirements. ++ +-- +// Note +include::../../../../../../_ks_components-en/admonitions/note.adoc[] + +include::../../../../../_custom-en/clusterManagement/services/services-para-statelessStatefulExternal.adoc[] + +include::../../../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- + ++ + +include::../../../../../_custom-en/projectManagement/services/services-oper-setBasicInformation.adoc[] + ++ + +. On the **Pod Settings** tab, configure the replica count, containers, update strategy, security context, scheduling rules, and metadata for the pods managed by the backend workload of the service, then click **Next**. + ++ + +include::../../../../../_custom-en/projectManagement/services/services-oper-setStorageAdvanced.adoc[] + + +== Parameter Description + +The following explains how to configure parameters for stateful and stateless services. + +* Basic Information ++ +-- +include::../../../../../_custom-en/projectManagement/services/services-para-setServiceInformation.adoc[] + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +include::../../../../../_custom-en/clusterManagement/services/services-para-serviceName.adoc[] + +include::../../../../../_custom-en/clusterManagement/services/services-para-serviceAlias.adoc[] + +include::../../../../../_custom-en/projectManagement/services/services-para-serviceVersion.adoc[] + +include::../../../../../_custom-en/clusterManagement/services/services-para-serviceDescription.adoc[] +|=== +-- + +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podReplicas.adoc[] + +* Pod Settings > Add Container ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] +-- + +* Pod Settings > Add Container > Container Settings ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] + +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] + +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] + +include::../../../../../_custom-en/clusterManagement/projects/projects-para-containerQuotas.adoc[] +|=== +-- + +* Pod Settings > Add Container > Port Settings ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] +-- + +* Pod Settings > Add Container > Image Pull Policy ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] +-- + +* Pod Settings > Add Container > Health Check ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] +-- + +* Pod Settings > Add Container > Health Check > Add Probe ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc[] +-- + +* Pod Settings > Add Container > Lifecycle Management ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] +-- + +* Pod Settings > Add Container > Lifecycle Management > Add Action ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] +-- + +* Pod Settings > Add Container > Start Command ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] +-- + +* Pod Settings > Add Container > Environment Variables ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] +-- + +* Pod Settings > Add Container > Container Security Context ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] +-- + +* Pod Settings > Add Container > Synchronize Host Timezone ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] +-- + +* Pod Settings > Update Strategy ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc[] +-- + +* Pod Settings > Update Policy > Rolling Update Settings ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc[] +-- + +* Pod Settings > Pod Security Context ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podSecurityContext.adoc[] +-- + +* Pod Settings > Pod Scheduling Rules ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc[] +-- + +* Pod Settings > Pod Scheduling Rules > Custom Rules ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc[] +-- + +* Pod Settings > Pod Graceful Period ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc[] +-- + +* Pod Settings > Add Metadata ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-PodMetadata.adoc[] +-- + +* Storage Settings ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc[] + +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] + +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] +|=== + +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume.adoc[] +-- + +* Storage Settings > Add Persistent Volume Claim Template ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc[] +-- + +* Storage Settings > Mount Volume > Persistent Volume ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] +-- + +* Storage Settings > Mount Volume > Temporary Volume ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume_new.adoc[] +-- + +* Storage Settings > Mount Volume > HostPath Volume ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] +-- + +* Storage Settings > Mount ConfigMap or Secret ++ +-- +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] +-- + +* Advanced Settings ++ +-- +Specify nodes for the pods managed by the backend workload of the service, and set the external access mode, session persistence settings, and metadata for the service. + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +include::../../../../../_custom-en/clusterManagement/services/services-para-externalAccess.adoc[] + +include::../../../../../_custom-en/clusterManagement/services/services-para-sessionPersistence.adoc[] + +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc[] + +| Add Metadata +| +include::../../../../../_custom-en/projectManagement/services/services-desc-setServiceLabelWorkloadAnnotation.adoc[] + +include::../../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc[] +|=== +-- diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/02-create-an-external-service.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/02-create-an-external-service.adoc new file mode 100644 index 000000000..0a7924529 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/02-create-an-external-service.adoc @@ -0,0 +1,49 @@ +--- +title: "Create External Services" +linkTitle: "Create External Services" +keywords: "Kubernetes, KubeSphere, Project Management, Workloads, Services, Create Service, Create External Services" +description: "Instructions on how to create external services." +weight: 02 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Services** + +This section explains how to create external services. + +External services forward business traffic to other services outside the cluster, and can be accessed internally within the cluster using the domain name format `..svc.cluster.local`. + +== Prerequisites + +include::../../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +== Steps + +include::../../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +. In the **Create Service** dialog, select **External Service**. + +. On the **Basic Information** tab, set the basic information of the service, then click **Next**. + +. On the **External Service** tab, set the address of the target service, then click **Create**. ++ +-- +// Note +include::../../../../../../_ks_components-en/admonitions/note.adoc[] + +* The address of the target service must be a domain name. If you input an IP address, it will be considered as a domain composed of numbers rather than a real IP address. + +* To ensure that business traffic can be correctly forwarded to the target service, please make sure the domain name of the target service can be resolved to an actual IP address by a domain name server. + +include::../../../../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/05-create-a-service-using-existing-workloads.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/05-create-a-service-using-existing-workloads.adoc new file mode 100644 index 000000000..df8b2f860 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/05-create-a-service-using-existing-workloads.adoc @@ -0,0 +1,56 @@ +--- +title: "Create Services Using Existing Workloads" +linkTitle: "Create Services Using Existing Workloads" +keywords: "Kubernetes, KubeSphere, Project Management, Workloads, Services, Create Service, Create Services Using Existing Workloads" +description: "Instructions on how to create services using existing workloads as backend workloads." +weight: 05 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Services** + +This section explains how to create services using existing workloads as backend workloads. + +== Prerequisites + +* {empty} +include::../../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +* You should have workloads created in the project beforehand. For more information, refer to link:../../../03-workloads/01-create-a-workload/[Create Workloads]. + +== Steps + +include::../../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +. In the **Create Service** dialog, select **Specify Workload**. + ++ + +include::../../../../../_custom-en/projectManagement/services/services-oper-setBasicInformation.adoc[] ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +include::../../../../../_custom-en/clusterManagement/services/services-para-serviceName.adoc[] + +include::../../../../../_custom-en/clusterManagement/services/services-para-serviceAlias.adoc[] + +include::../../../../../_custom-en/clusterManagement/services/services-para-serviceDescription.adoc[] +|=== +-- + ++ + +include::../../../../../_custom-en/clusterManagement/services/services-oper-createAService.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/_index.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/_index.adoc new file mode 100644 index 000000000..897d96d0a --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/_index.adoc @@ -0,0 +1,21 @@ +--- +title: "Create Services" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Services, Create Services" +description: "Learn how to create services." +layout: "second" +weight: 01 +--- + + + +include::../../../../../_custom-en/clusterManagement/services/services-desc-createAService.adoc[] + +KubeSphere supports creating services and their backend workloads in the following ways: + +- Create Stateful Services: Create services with an internal access mode set to Headless, and simultaneously create a StatefulSet as the backend workload for the service. + +- Create Stateless Services: Create services with an internal access mode set to VirtualIP, and simultaneously create a Deployment as the backend workload for the service. + +- Create External Services: Direct service traffic to services outside the cluster. + +- Specify Workloads: Create services with an internal access mode set to Headless or VirtualIP, and use existing workloads in the project as the backend workload for the service. \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/02-view-a-service-list.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/02-view-a-service-list.adoc new file mode 100644 index 000000000..bb75688b0 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/02-view-a-service-list.adoc @@ -0,0 +1,63 @@ +--- +title: "View Service List" +linkTitle: "View Service List" +keywords: "Kubernetes, KubeSphere, Project Management, Workloads, Services, View Service Lists" +description: "Instructions on how to view the service list." +weight: 02 +--- + +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Services** + +include::../../../../_custom-en/clusterManagement/services/services-desc-viewServiceList.adoc[] + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +==== +* The service list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +include::../../../../_custom-en/clusterManagement/services/services-para-name.adoc[] + +|Service Type +|The type of service. Depending on how the service was created, KubeSphere categorizes services into the following types: + +include::../../../../_custom-en/clusterManagement/services/services-para-statelessStatefulExternal.adoc[] + +* **External Service**: Services forward business traffic to other services outside the cluster. The system does not allocate virtual IP addresses for services. They can be accessed internally within the cluster using the domain name format `..svc.cluster.local`. + +* **Custom Service**: Services created by users with custom internal access modes and backend workloads. + +|App +|The application to which the service belongs. + +|Internal Access +| +include::../../../../_custom-en/clusterManagement/services/services-para-internalAccess.adoc[] + +include::../../../../_custom-en/clusterManagement/services/services-para-virtualip-headless.adoc[] + +include::../../../../_custom-en/clusterManagement/services/services-para-externalName.adoc[] + +include::../../../../_custom-en/clusterManagement/services/services-para-externalAccess.adoc[] + +include::../../../../_custom-en/clusterManagement/services/services-para-creationTime.adoc[] +|=== +-- + +include::../../../../_custom-en/clusterManagement/services/services-oper-searchForServices.adoc[] + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/04-view-service-details.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/04-view-service-details.adoc new file mode 100644 index 000000000..0cb5e6484 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/04-view-service-details.adoc @@ -0,0 +1,32 @@ +--- +title: "View Service Details" +linkTitle: "View Service Details" +keywords: "Kubernetes, KubeSphere, Project Management, Workloads, Services, View Service Details" +description: "Instructions on how to view service details." +weight: 04 +--- + +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Services** + +include::../../../../_custom-en/clusterManagement/services/services-desc-viewServiceDetails.adoc[] + +== Prerequisites + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/services/services-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/services/services-oper-viewServiceDetails.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/05-edit-service-information.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/05-edit-service-information.adoc new file mode 100644 index 000000000..0b851bc02 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/05-edit-service-information.adoc @@ -0,0 +1,28 @@ +--- +title: "Edit Service Information" +linkTitle: "Edit Service Information" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workload, Services, Edit Service Information" +description: "Instructions on how to edit service information." +weight: 05 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Services** + +include::../../../../_custom-en/clusterManagement/services/services-desc-editServiceInformation.adoc[] + +== Prerequisites + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/services/services-oper-editServiceInformation.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/06-edit-service-settings.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/06-edit-service-settings.adoc new file mode 100644 index 000000000..f145dd392 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/06-edit-service-settings.adoc @@ -0,0 +1,28 @@ +--- +title: "Edit Service Settings" +linkTitle: "Edit Service Settings" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workload, Services, Edit Service Settings" +description: "Instructions on how to edit service settings." +weight: 06 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Services** + +include::../../../../_custom-en/clusterManagement/services/services-desc-editServiceSettings.adoc[] + +== Prerequisites + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/services/services-oper-editServiceSettings.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/07-edit-service-external-access-settings.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/07-edit-service-external-access-settings.adoc new file mode 100644 index 000000000..5b030ed0c --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/07-edit-service-external-access-settings.adoc @@ -0,0 +1,28 @@ +--- +title: "Edit Service External Access Settings" +linkTitle: "Edit Service External Access Settings" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workload, Services, Edit Service External Access Settings" +description: "Instructions on how to edit service external access settings." +weight: 07 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Services** + +include::../../../../_custom-en/clusterManagement/services/services-desc-editServiceExternalAccessSettings.adoc[] + +== Prerequisites + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/services/services-oper-editServiceExternalAccessSettings.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/09-delete-services.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/09-delete-services.adoc new file mode 100644 index 000000000..a725aae78 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/09-delete-services.adoc @@ -0,0 +1,44 @@ +--- +title: "Delete Services" +linkTitle: "Delete Services" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workload, Services, Delete Service" +description: "Instructions on how to delete services." +weight: 09 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Services** + +include::../../../../_custom-en/clusterManagement/services/services-desc-deleteServices.adoc[] + +== Prerequisites + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +== Delete a Single Service + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/services/services-oper-deleteASingleService.adoc[] + ++ + +. In the **Delete Service** dialog, select the workloads you want to delete, then click **OK**. + +== Delete Multiple Services + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/services/services-oper-deleteMultipleServices.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/_index.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/_index.adoc new file mode 100644 index 000000000..3fc91c2c4 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/02-services/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Services" +linkTitle: "Services" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Services" +description: "Learn how to manage services." +layout: "second" +weight: 02 +--- + +include::../../../../_custom-en/clusterManagement/services/services-desc-services.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/01-create-a-workload.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/01-create-a-workload.adoc new file mode 100644 index 000000000..ab5fa1c2e --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/01-create-a-workload.adoc @@ -0,0 +1,248 @@ +--- +title: "Create Workloads" +linkTitle: "Create Workloads" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Workloads, Create Workloads" +description: "Introduction to creating workloads." +weight: 01 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Workloads** + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-createAWorkload.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +Please refer to link:#_parameter_description[Parameter Description] for configuring the parameters of a workload. + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-createAWorkload.adoc[] + + +== Parameter Description + +The following explains how to configure parameters for the workload. + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-basicInformation.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podReplicas.adoc[] + +* Pod Settings > Add Container ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] +-- + +* Pod Settings > Add Container > Container Settings ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] + +include::../../../../_custom-en/clusterManagement/projects/projects-para-containerQuotas.adoc[] +|=== +-- + +* Pod Settings > Add Container > Port Settings ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] +-- + +* Pod Settings > Add Container > Image Pull Policy ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] +-- + +* Pod Settings > Add Container > Health Check ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] +-- + +* Pod Settings > Add Container > Health Check > Add Probe ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc[] +-- + +* Pod Settings > Add Container > Lifecycle Management ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] +-- + +* Pod Settings > Add Container > Lifecycle Management > Add Action ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] +-- + +* Pod Settings > Add Container > Start Command ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] +-- + +* Pod Settings > Add Container > Environment Variables ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] +-- + +* Pod Settings > Add Container > Container Security Context ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] +-- + +* Pod Settings > Add Container > Synchronize Host Timezone ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] +-- + +* Pod Settings > Update Strategy ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc[] +-- + +* Pod Settings > Update Policy > Rolling Update Settings ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc[] +-- + +* Pod Settings > Pod Security Context ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podSecurityContext.adoc[] +-- + +* Pod Settings > Pod Scheduling Rules ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc[] +-- + +* Pod Settings > Pod Scheduling Rules > Custom Rules ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc[] +-- + +* Pod Settings > Pod Graceful Period ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc[] +-- + +* Pod Settings > Add Metadata ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-PodMetadata.adoc[] +-- + +* Storage Settings ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] +|=== + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume.adoc[] +-- + +* Storage Settings > Add Persistent Volume Claim Template ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc[] +-- + +* Storage Settings > Mount Volume > Persistent Volume ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] +-- + +* Storage Settings > Mount Volume > Temporary Volume ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume_new.adoc[] +-- + +* Storage Settings > Mount Volume > HostPath Volume ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] +-- + +* Storage Settings > Mount ConfigMap or Secret ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] +-- + +* Advanced Settings ++ +-- +Specify nodes for the pods managed by the workload and set metadata for the workload. + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +// include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podIpPool.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc[] + +| Add Metadata +| +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-setWorkloadMetadata.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc[] +|=== +-- diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/02-view-a-workload-list.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/02-view-a-workload-list.adoc new file mode 100644 index 000000000..5218b42b0 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/02-view-a-workload-list.adoc @@ -0,0 +1,43 @@ +--- +title: "View Workload List" +linkTitle: "View Workload List" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Workloads, View Workload List" +description: "Learn how to view the list of workloads." +weight: 02 +--- + +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Workloads** + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-viewAWorkloadList.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openListPage.adoc[] ++ +==== +include::../../../../_custom-en/clusterManagement/workloads/workloads-para-workloadList_new.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-searchForWorkloads.adoc[] + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/03-view-workload-details.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/03-view-workload-details.adoc new file mode 100644 index 000000000..1639a179a --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/03-view-workload-details.adoc @@ -0,0 +1,36 @@ +--- +title: "View Workload Details" +linkTitle: "View Workload Details" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Workloads, View Workload Details" +description: "Learn how to view workload details." +weight: 03 +--- + +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Workloads** + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-viewWorkloadDetails.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-viewWorkloadDetails_new.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/04-edit-workload-information.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/04-edit-workload-information.adoc new file mode 100644 index 000000000..329488e56 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/04-edit-workload-information.adoc @@ -0,0 +1,37 @@ +--- +title: "Edit Workload Information" +linkTitle: "Edit Workload Information" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Workloads, Edit Workload Information" +description: "Learn how to edit workload information." +weight: 04 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Workloads** + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-editWorkloadInformation.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-editWorkloadInformation.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/05-re-create-a-workload.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/05-re-create-a-workload.adoc new file mode 100644 index 000000000..c0ae9256e --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/05-re-create-a-workload.adoc @@ -0,0 +1,37 @@ +--- +title: "Recreate Workloads" +linkTitle: "Recreate Workloads" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Workloads, Recreate Workload" +description: "Learn how to recreate a workload." +weight: 05 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Workloads** + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-recreateAWorkload.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-recreateAWorkload.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/06-adjust-the-number-of-pod-replicas.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/06-adjust-the-number-of-pod-replicas.adoc new file mode 100644 index 000000000..fb5a546e2 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/06-adjust-the-number-of-pod-replicas.adoc @@ -0,0 +1,37 @@ +--- +title: "Adjust Pod Replicas Count" +linkTitle: "Adjust Pod Replicas Count" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Workloads, Adjust Pod Replicas" +description: "Learn how to adjust the replica count of pods in a workload." +weight: 06 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Workloads** + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-adjustTheNumberOfPodReplicas.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-adjustTheNumberOfPodReplicas.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/07-stop-workloads.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/07-stop-workloads.adoc new file mode 100644 index 000000000..9498ef720 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/07-stop-workloads.adoc @@ -0,0 +1,36 @@ +--- +title: "Stop Workloads" +linkTitle: "Stop Workloads" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Workloads, Stop Workloads" +description: "Learn how to stop workloads." +weight: 07 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Workloads** + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-stopWorkloads.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-stopWorkloads.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/08-roll-back-workload-settings.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/08-roll-back-workload-settings.adoc new file mode 100644 index 000000000..d57b57f1c --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/08-roll-back-workload-settings.adoc @@ -0,0 +1,40 @@ +--- +title: "Roll Back Workload Settings" +linkTitle: "Roll Back Workload Settings" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Workloads, Rollback Workload Settings" +description: "Learn how to rollback workload settings." +weight: 08 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Workloads** + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-rollBackWorkloadSettings.adoc[] + + +== Prerequisites + + +* {empty} +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-prer-workloadEdited.adoc[] + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-rollBackWorkloadSettings.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/10-edit-workload-settings.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/10-edit-workload-settings.adoc new file mode 100644 index 000000000..d566cbdfa --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/10-edit-workload-settings.adoc @@ -0,0 +1,188 @@ +--- +title: "Edit Workload Settings" +linkTitle: "Edit Workload Settings" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Workloads, Edit Workload Settings" +description: "Learn how to edit settings for created workloads." +weight: 10 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Workloads** + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-editWorkloadSettings.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-editWorkloadSettings.adoc[] + ++ + +. In the **Edit Settings** dialog, set the workload's update strategy, containers, storage, pod scheduling rules (not available for DaemonSets), and pod graceful period. Then, click **OK**. For specific parameter settings, refer to link:#_Parameter_Description[Parameter Description]. + + +== Parameter Description + +* Update Strategy ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc[] +-- + +* Update Strategy > Rolling Update Settings ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc[] +-- + +* Containers > Add Container ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] +-- + +* Containers > Container Settings ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] + +include::../../../../_custom-en/clusterManagement/projects/projects-para-containerQuotas.adoc[] +|=== +-- + +* Containers > Container Settings > Port Settings ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] +-- + +* Containers > Container Settings > Image Pull Policy ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] +-- + +* Containers > Container Settings > Health Check ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] +-- + +* Containers > Container Settings > Lifecycle Management ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] +-- + +* Containers > Container Settings > Start Command ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] +-- + +* Containers > Container Settings > Environment Variables ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] +-- + +* Containers > Container Settings > Container Security Context ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] +-- + +* Containers > Container Settings > Synchronize Host Timezone ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] +-- + +* Storage ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] +|=== + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume_new.adoc[] +-- + +* Storage > Mount Volume > Persistent Volume ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] +-- + +* Storage > Mount Volume > Temporary Volume ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume_new.adoc[] +-- + +* Storage > Mount Volume > HostPath Volume ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] +-- + +* Storage > Mount ConfigMap or Secret ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] +-- + +* Pod Scheduling Rules ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc[] +-- + +* Pod Scheduling Rules > Custom Rules ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc[] +-- + +* Pod Graceful Period ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/11-delete-workloads.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/11-delete-workloads.adoc new file mode 100644 index 000000000..3eda48072 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/11-delete-workloads.adoc @@ -0,0 +1,58 @@ +--- +title: "Delete Workloads" +linkTitle: "Delete Workloads" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Workloads, Delete Workload" +description: "Learn how to delete a workload." +weight: 11 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Workloads** + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-deleteWorkloads.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Delete a Single Workload + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-deleteASingleWorkload.adoc[] + ++ + +. In the **Delete Workload** dialog, confirm and select the names of the resources related to the workloads to be deleted, then click **OK**. + + +== Delete Multiple Workloads + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/workloads/workloads-oper-deleteMultipleWorkloads.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/_index.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/_index.adoc new file mode 100644 index 000000000..a8e78ba51 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/03-workloads/_index.adoc @@ -0,0 +1,11 @@ +--- +title: "Workloads" +linkTitle: "Workloads" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Workloads" +description: "Instructions on how to manage application workloads." +layout: "second" +weight: 03 +--- + + +include::../../../../_custom-en/clusterManagement/workloads/workloads-desc-workloads.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/01-create-a-job.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/01-create-a-job.adoc new file mode 100644 index 000000000..56caa39a2 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/01-create-a-job.adoc @@ -0,0 +1,201 @@ +--- +title: "Create Jobs" +linkTitle: "Create Jobs" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Job, Create Job" +description: "Learn how to create jobs." +weight: 01 +--- + + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Jobs** + + +include::../../../../_custom-en/clusterManagement/jobs/jobs-desc-createAJob.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +Please refer to link:#_Parameter_Description[Parameter Description] for configuring job parameters. + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-openListPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-createAJob.adoc[] + + +== Parameter Description + +The following explains how to configure parameters for the job. + +include::../../../../_custom-en/clusterManagement/jobs/jobs-para-basicInformation.adoc[] + +include::../../../../_custom-en/clusterManagement/jobs/jobs-para-strategySettings.adoc[] + +include::../../../../_custom-en/clusterManagement/jobs/jobs-para-restartPolicy.adoc[] + + +* Pod Settings > Add Container ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] +-- + +* Pod Settings > Add Container > Container Settings ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] + +include::../../../../_custom-en/clusterManagement/projects/projects-para-containerQuotas.adoc[] +|=== +-- + +* Pod Settings > Add Container > Port Settings ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] +-- + +* Pod Settings > Add Container > Image Pull Policy ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] +-- + +* Pod Settings > Add Container > Health Check ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] +-- + +* Pod Settings > Add Container > Health Check > Add Probe ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc[] +-- + +* Pod Settings > Add Container > Lifecycle Management ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] +-- + +* Pod Settings > Add Container > Lifecycle Management > Add Action ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] +-- + +* Pod Settings > Add Container > Start Command ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] +-- + +* Pod Settings > Add Container > Environment Variables ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] +-- + +* Pod Settings > Add Container > Container Security Context ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] +-- + +* Pod Settings > Add Container > Synchronize Host Timezone ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] +-- + +* Storage Settings ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] +|=== + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume_new.adoc[] +-- + +* Storage Settings > Mount Volume > Persistent Volume ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] +-- + +* Storage Settings > Mount Volume > Temporary Volume ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume_new.adoc[] +-- + +* Storage Settings > Mount Volume > HostPath Volume ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] +-- + +* Storage Settings > Mount ConfigMap or Secret ++ +-- +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] +-- + +* Advanced Settings ++ +-- +Specify nodes for the pods managed by the job and set metadata for the job. + +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc[] + +| Add Metadata +| +include::../../../../_custom-en/clusterManagement/jobs/jobs-desc-setJobMetadata.adoc[] + +include::../../../../_custom-en/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc[] +|=== +-- diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/02-view-a-job-list.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/02-view-a-job-list.adoc new file mode 100644 index 000000000..1ff63fe0a --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/02-view-a-job-list.adoc @@ -0,0 +1,43 @@ +--- +title: "View Job List" +linkTitle: "View Job List" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Job, View Job List" +description: "Learn how to view the job list." +weight: 02 +--- + +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Jobs** + + +include::../../../../_custom-en/clusterManagement/jobs/jobs-desc-viewAJobList.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-openListPage.adoc[] ++ +==== +include::../../../../_custom-en/clusterManagement/jobs/jobs-para-jobList.adoc[] + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-searchForJobs.adoc[] + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/03-view-job-details.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/03-view-job-details.adoc new file mode 100644 index 000000000..84b06c64a --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/03-view-job-details.adoc @@ -0,0 +1,37 @@ +--- +title: "View Job Details" +linkTitle: "View Job Details" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Job, View Job Details" +description: "Learn how to view job details." +weight: 03 +--- + +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Jobs** + + +include::../../../../_custom-en/clusterManagement/jobs/jobs-desc-viewJobDetails.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-viewJobDetails_new.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/04-edit-job-information.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/04-edit-job-information.adoc new file mode 100644 index 000000000..9f4860a33 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/04-edit-job-information.adoc @@ -0,0 +1,37 @@ +--- +title: "Edit Job Information" +linkTitle: "Edit Job Information" +keywords: "Kubernetes, KubeSphere, Project Management, Application jobs, Job, Edit Job Information" +description: "Learn how to edit job information." +weight: 04 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Jobs** + + +include::../../../../_custom-en/clusterManagement/jobs/jobs-desc-editJobInformation.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-openListPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-editJobInformation.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/05-rerun-a-job.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/05-rerun-a-job.adoc new file mode 100644 index 000000000..82f9574d7 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/05-rerun-a-job.adoc @@ -0,0 +1,33 @@ +--- +title: "Re-run Jobs" +linkTitle: "Re-run Jobs" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Job, Re-run Job" +description: "Instructions on how to re-run a job." +weight: 05 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Jobs** + + +include::../../../../_custom-en/clusterManagement/jobs/jobs-desc-rerunAJob.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-rerunAJob.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/06-pause-a-cronjob.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/06-pause-a-cronjob.adoc new file mode 100644 index 000000000..7169b55b9 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/06-pause-a-cronjob.adoc @@ -0,0 +1,37 @@ +--- +title: "Pause CronJobs" +linkTitle: "Pause CronJobs" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Jobs, Pause CronJob" +description: "Instructions on how to pause a CronJob." +weight: 06 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Jobs** + + +include::../../../../_custom-en/clusterManagement/jobs/jobs-desc-pauseACronjob.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. On the **Jobs** page, click **Cronjobs** to open the list of scheduled jobs. + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-pauseACronjob.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/07-delete-jobs.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/07-delete-jobs.adoc new file mode 100644 index 000000000..19cdbdf30 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/07-delete-jobs.adoc @@ -0,0 +1,54 @@ +--- +title: "Delete Jobs" +linkTitle: "Delete Jobs" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Jobs, Delete Job" +description: "Learn how to delete a job." +weight: 07 +--- + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Jobs** + + +include::../../../../_custom-en/clusterManagement/jobs/jobs-desc-deleteJobs.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Delete a Single Job + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-openListPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-deleteASingleJob.adoc[] + + +== Delete Multiple Jobs + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-openListPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/jobs/jobs-oper-deleteMultipleJobs.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/_index.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/_index.adoc new file mode 100644 index 000000000..702f053bc --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/04-jobs/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "Jobs" +linkTitle: "Jobs" +keywords: "Kubernetes, KubeSphere, Project Management, Jobs" +description: "Learn how to manage jobs." +layout: "second" +weight: 04 +--- + + + +include::../../../../_custom-en/clusterManagement/jobs/jobs-desc-jobs.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/06-pods/01-view-a-pod-list.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/06-pods/01-view-a-pod-list.adoc new file mode 100644 index 000000000..bf81b01a0 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/06-pods/01-view-a-pod-list.adoc @@ -0,0 +1,40 @@ +--- +title: "View Pod List" +linkTitle: "View Pod List" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Pods, Viewing Pod Lists" +description: "Explain how to view the list of pods." +weight: 01 +--- + + +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Pods** + + +include::../../../../_custom-en/clusterManagement/pods/pods-desc-viewAPodList.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +==== +include::../../../../_custom-en/clusterManagement/pods/pods-para-podList.adoc[] + +include::../../../../_custom-en/clusterManagement/pods/pods-oper-searchForPods.adoc[] + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/06-pods/02-view-pod-details.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/06-pods/02-view-pod-details.adoc new file mode 100644 index 000000000..e1c6f90da --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/06-pods/02-view-pod-details.adoc @@ -0,0 +1,38 @@ +--- +title: "View Pod Details" +linkTitle: "View Pod Details" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Pods, Viewing Pod Details" +description: "Explain how to view the details of a pod." +weight: 02 +--- + + +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Pods** + + +include::../../../../_custom-en/clusterManagement/pods/pods-desc-viewPodDetails.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/pods/pods-oper-openDetails.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/pods/pods-oper-viewPodDetails_new.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/06-pods/03-view-container-details.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/06-pods/03-view-container-details.adoc new file mode 100644 index 000000000..318237924 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/06-pods/03-view-container-details.adoc @@ -0,0 +1,38 @@ +--- +title: "View Container Details" +linkTitle: "View Container Details" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Pods, View Container Details" +description: "Learn how to view container details." +weight: 03 +--- + + +:ks_permission: **Application Workload Viewing** +:ks_navigation: **Application Workloads > Pods** + + +include::../../../../_custom-en/clusterManagement/pods/pods-desc-viewContainerDetails.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/pods/pods-oper-openDetails.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/pods/pods-oper-viewContainerDetails_new.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/06-pods/04-access-a-container-terminal.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/06-pods/04-access-a-container-terminal.adoc new file mode 100644 index 000000000..4aa06d6f4 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/06-pods/04-access-a-container-terminal.adoc @@ -0,0 +1,37 @@ +--- +title: "Access Container Terminal" +linkTitle: "Access Container Terminal" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Pods, Access Container Terminal" +description: "Learn how to access the container terminal." +weight: 04 +--- + + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Pods** + +include::../../../../_custom-en/clusterManagement/pods/pods-desc-accessAContainerTerminal.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/pods/pods-oper-openDetails.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/pods/pods-oper-accessAContainerTerminal.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/06-pods/05-delete-pods.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/06-pods/05-delete-pods.adoc new file mode 100644 index 000000000..85bfb6fbf --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/06-pods/05-delete-pods.adoc @@ -0,0 +1,47 @@ +--- +title: "Delete Pods" +linkTitle: "Delete Pods" +keywords: "Kubernetes, KubeSphere, Project Management, Application Workloads, Pods, Delete Pods" +description: "Learn how to delete a pod." +weight: 05 +--- + + +:ks_permission: **Application Workload Management** +:ks_navigation: **Application Workloads > Pods** + + +include::../../../../_custom-en/clusterManagement/pods/pods-desc-deletePods.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Delete a Single Pod + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/pods/pods-oper-deleteASinglePod.adoc[] + + +== Delete Multiple Pods + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/pods/pods-oper-deleteMultiplePods.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/06-pods/_index.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/06-pods/_index.adoc new file mode 100644 index 000000000..5434bb2fd --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/06-pods/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "Pods" +linkTitle: "Pods" +keywords: "Kubernetes, KubeSphere, Project Management, Pod" +description: "Instructions on how to manage pods." +layout: "second" +weight: 06 +--- + + + +include::../../../../_custom-en/clusterManagement/pods/pods-desc-pods.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/03-application-workloads/_index.adoc b/content/en/docs/v4.1/09-project-management/03-application-workloads/_index.adoc new file mode 100644 index 000000000..60bb20370 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/03-application-workloads/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Application Workloads" +linkTitle: "Application Workloads" +keywords: "Kubernetes, KubeSphere, Project Management, Storage, Application Workloads" +description: "Introduces how to manage application workloads." +layout: "second" +weight: 03 +--- + +This section explains how to manage applications, services, workloads, jobs, and pods. \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/01-create-a-persistent-volume-claim.adoc b/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/01-create-a-persistent-volume-claim.adoc new file mode 100644 index 000000000..49253ab57 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/01-create-a-persistent-volume-claim.adoc @@ -0,0 +1,38 @@ +--- +title: "Create PVCs" +linkTitle: "Create PVCs" +keywords: "Kubernetes, KubeSphere, Project Management, Storage, Persistent Volume Claim, Create Persistent Volume Claim" +description: "Explain how to create a Persistent Volume Claim." +weight: 01 +--- + + +:ks_permission: **Persistent Volume Claim Management** +:ks_navigation: **Storage > Persistent Volume Claims** + + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAPersistentVolumeClaim.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim_new.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/02-view-a-persistent-volume-claim-list.adoc b/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/02-view-a-persistent-volume-claim-list.adoc new file mode 100644 index 000000000..11eee7dcb --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/02-view-a-persistent-volume-claim-list.adoc @@ -0,0 +1,40 @@ +--- +title: "View PVC List" +linkTitle: "View PVC List" +keywords: "Kubernetes, KubeSphere, Project Management, Storage, Persistent Volume Claim, Persistent Volume, View Persistent Volume Claim List" +description: "Explain how to view the list of Persistent Volume Claims." +weight: 02 +--- + + +:ks_permission: **Persistent Volume Claim Viewing** +:ks_navigation: **Storage > Persistent Volume Claims** + + +include::../../../../_custom-en/clusterManagement/pods/pods-desc-viewAPersistentVolumeList.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +==== +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-persistentVolumeClaimList.adoc[] + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-searchForPersistentVolumeClaims.adoc[] + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/03-view-persistent-volume-claim-details.adoc b/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/03-view-persistent-volume-claim-details.adoc new file mode 100644 index 000000000..04eadeff6 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/03-view-persistent-volume-claim-details.adoc @@ -0,0 +1,38 @@ +--- +title: "View PVC Details" +linkTitle: "View PVC Details" +keywords: "Kubernetes, KubeSphere, Project Management, Storage, Persistent Volume Claim, Persistent Volume, View Persistent Volume Claim Details" +description: "Explain how to view details of a Persistent Volume Claim." +weight: 03 +--- + +:ks_permission: **Persistent Volume Claim Viewing** +:ks_navigation: **Storage > Persistent Volume Claims** + + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-viewPersistentVolumeClaimDetails.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails_new.adoc[] + diff --git a/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/04-clone-a-persistent-volume.adoc b/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/04-clone-a-persistent-volume.adoc new file mode 100644 index 000000000..f6fbd0621 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/04-clone-a-persistent-volume.adoc @@ -0,0 +1,42 @@ +--- +title: "Clone Persistent Volumes" +linkTitle: "Clone Persistent Volumes" +keywords: "Kubernetes, KubeSphere, Project Management, Storage, Persistent Volume Claim, Persistent Volume, Clone Persistent Volume" +description: "Explain how to clone a Persistent Volume." +weight: 04 +--- + + +:ks_permission: **Persistent Volume Claim Management** +:ks_navigation: **Storage > Persistent Volume Claims** + + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-cloneAPersistentVolume.adoc[] + + +== Prerequisites + +* {empty} +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc[] + + +* Ensure that the backend storage system supports volume cloning, and the storage class corresponding to the Persistent Volume Claim has enabled volume cloning. + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-cloneAPersistentVolume.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/06-expand-a-persistent-volume.adoc b/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/06-expand-a-persistent-volume.adoc new file mode 100644 index 000000000..fadfcc297 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/06-expand-a-persistent-volume.adoc @@ -0,0 +1,43 @@ +--- +title: "Expand Persistent Volumes" +linkTitle: "Expand Persistent Volumes" +keywords: "Kubernetes, KubeSphere, Project Management, Storage, Persistent Volume Claim, Persistent Volume, Expand Persistent Volume" +description: "Learn how to expand the capacity of a Persistent Volume." +weight: 06 +--- + + +:ks_permission: **Persistent Volume Claim Management** +:ks_navigation: **Storage > Persistent Volume Claims** + + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-expandAPersistentVolumeClaim.adoc[] + + +== Prerequisites + + +* {empty} +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc[] + + +* Ensure that the backend storage system supports volume cloning, and the storage class corresponding to the Persistent Volume Claim has enabled volume cloning. + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-expandAPersistentVolume.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/07-edit-persistent-volume-claim-information.adoc b/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/07-edit-persistent-volume-claim-information.adoc new file mode 100644 index 000000000..d15d94a19 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/07-edit-persistent-volume-claim-information.adoc @@ -0,0 +1,33 @@ +--- +title: "Edit PVC Information" +linkTitle: "Edit PVC Information" +keywords: "Kubernetes, KubeSphere, Project Management, Storage, Persistent Volume Claim, Persistent Volume, Edit Persistent Volume Claim Information" +description: "Introduce how to edit the basic information of a Persistent Volume Claim." +weight: 07 +--- + +:ks_permission: **Persistent Volume Claim Management** +:ks_navigation: **Storage > Persistent Volume Claims** + + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-editPersistentVolumeClaimInformation.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-editPersistentVolumeClaimInformation.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/08-delete-persistent-volume-claims.adoc b/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/08-delete-persistent-volume-claims.adoc new file mode 100644 index 000000000..63a3e3536 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/08-delete-persistent-volume-claims.adoc @@ -0,0 +1,48 @@ +--- +title: "Delete PVCs" +linkTitle: "Delete PVCs" +keywords: "Kubernetes, KubeSphere, Project Management, Storage, Persistent Volume Claim, Persistent Volume, Delete Persistent Volume Claim" +description: "Introduce how to delete a Persistent Volume Claim." +weight: 08 +--- + +:ks_permission: **Persistent Volume Claim Management** +:ks_navigation: **Storage > Persistent Volume Claims** + + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-deletePersistentVolumeClaims.adoc[] + + +== Prerequisites + + +* {empty} +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-backData.adoc[] + + +== Delete a Single Persistent Volume Claim + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteASinglePersistentVolumeClaim.adoc[] + + +== Delete Multiple Persistent Volume Claims + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteMultiplePersistentVolumeClaims.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/_index.adoc b/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/_index.adoc new file mode 100644 index 000000000..16ddd7122 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/_index.adoc @@ -0,0 +1,14 @@ +--- +title: "Persistent Volume Claims" +linkTitle: "Persistent Volume Claims" +keywords: "Kubernetes, KubeSphere, Project Management, Storage, Persistent Volume Claim, Persistent Volume" +description: "Explain how to manage volumes." +layout: "second" +weight: 01 +--- + + + +This section explains how to manage Persistent Volume Claims (PVC). + +A Persistent Volume Claim defines the requirements for storage resources. The system creates a storage area in the backend storage system based on the Persistent Volume Claim, making it available for containers. Each storage area corresponds to a Persistent Volume in KubeSphere. diff --git a/content/en/docs/v4.1/09-project-management/04-storage/_index.adoc b/content/en/docs/v4.1/09-project-management/04-storage/_index.adoc new file mode 100644 index 000000000..a16159f51 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/04-storage/_index.adoc @@ -0,0 +1,15 @@ +--- +title: "Storage" +linkTitle: "Storage" +keywords: "Kubernetes, KubeSphere, Project Management, Storage" +description: "Explain how to manage storage resources." +layout: "second" +weight: 04 +--- + + +This section explains how to manage storage resources. + +KubeSphere supports the management of the following storage resources in projects: + +* Persistent Volume Claim: Defines storage requirements. The system creates a storage area in the backend storage system for containers based on the parameters in the persistent volume claim. Each storage area corresponds to a persistent volume in KubeSphere. \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/01-create-a-secret.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/01-create-a-secret.adoc new file mode 100644 index 000000000..50ec53d4e --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/01-create-a-secret.adoc @@ -0,0 +1,37 @@ +--- +title: "Create Secrets" +linkTitle: "Create Secrets" +keywords: "Kubernetes, KubeSphere, Project Management, Secret" +description: "Learn how to create Secrets." +weight: 01 +--- + +:ks_permission: **Secret Management** +:ks_navigation: **Configuration > Secrets** + + +include::../../../../_custom-en/clusterManagement/secrets/secrets-desc-createASecret.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/secrets/secrets-oper-createASecret.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/02-view-a-secret-list.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/02-view-a-secret-list.adoc new file mode 100644 index 000000000..fb201b93b --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/02-view-a-secret-list.adoc @@ -0,0 +1,39 @@ +--- +title: "View Secrets List" +linkTitle: "View Secrets List" +keywords: "Kubernetes, KubeSphere, Project Management, Secrets" +description: "Introduction to viewing the list of Secrets." +weight: 02 +--- + +:ks_permission: **Secret Viewing** +:ks_navigation: **Configuration > Secrets** + + +include::../../../../_custom-en/clusterManagement/secrets/secrets-desc-viewASecretList.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +==== +include::../../../../_custom-en/clusterManagement/secrets/secrets-para-secretList.adoc[] + +include::../../../../_custom-en/clusterManagement/secrets/secrets-oper-searchForSecrets.adoc[] + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/03-view-secret-details.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/03-view-secret-details.adoc new file mode 100644 index 000000000..64374f40c --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/03-view-secret-details.adoc @@ -0,0 +1,38 @@ +--- +title: "View Secret Details" +linkTitle: "View Secret Details" +keywords: "Kubernetes, KubeSphere, Project Management, Secret" +description: "Introduction to viewing secret details." +weight: 03 +--- + + +:ks_permission: **Secret Viewing** +:ks_navigation: **Configuration > Secrets** + + +include::../../../../_custom-en/clusterManagement/secrets/secrets-desc-viewSecretDetails.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/secrets/secrets-oper-openSecretDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/secrets/secrets-oper-viewSecretDetails.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/04-edit-secret-information.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/04-edit-secret-information.adoc new file mode 100644 index 000000000..831843f46 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/04-edit-secret-information.adoc @@ -0,0 +1,33 @@ +--- +title: "Edit Secret Information" +linkTitle: "Edit Secret Information" +keywords: "Kubernetes, KubeSphere, Project Management, Secret, Edit Secret Information" +description: "Introduction to editing key-value pair data of a Secret." +weight: 04 +--- + +:ks_permission: **Secret Management** +:ks_navigation: **Configuration > Secrets** + + +include::../../../../_custom-en/clusterManagement/secrets/secrets-desc-editSecretInformation.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/secrets/secrets-oper-editSecretInformation.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/05-edit-secret-settings.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/05-edit-secret-settings.adoc new file mode 100644 index 000000000..06e34cf19 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/05-edit-secret-settings.adoc @@ -0,0 +1,34 @@ +--- +title: "Edit Secret Settings" +linkTitle: "Edit Secret Settings" +keywords: "Kubernetes, KubeSphere, Project Management, Secret, Edit Secret Settings" +description: "Introduction to editing settings of a Secret." +weight: 05 +--- + + +:ks_permission: **Secret Management** +:ks_navigation: **Configuration > Secrets** + + +include::../../../../_custom-en/clusterManagement/secrets/secrets-desc-editSecretSettings.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/secrets/secrets-oper-editSecretSettings.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/06-delete-secrets.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/06-delete-secrets.adoc new file mode 100644 index 000000000..3171246af --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/06-delete-secrets.adoc @@ -0,0 +1,47 @@ +--- +title: "Delete Secrets" +linkTitle: "Delete Secrets" +keywords: "Kubernetes, KubeSphere, Project Management, Secret, Delete Secret" +description: "Introduction to deleting a Secret." +weight: 06 +--- + + +:ks_permission: **Secret Management** +:ks_navigation: **Configuration > Secrets** + + +include::../../../../_custom-en/clusterManagement/secrets/secrets-desc-deleteSecrets.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Delete a Single Secret + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/secrets/secrets-oper-deleteASingleSecret.adoc[] + + +== Delete Multiple Secrets + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/secrets/secrets-oper-deleteMultipleSecrets.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/_index.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/_index.adoc new file mode 100644 index 000000000..915b3e1c4 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/01-secrets/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "Secrets" +linkTitle: "Secrets" +keywords: "Kubernetes, KubeSphere, Project Management, Configuration, Secret" +description: "Introduction to managing Secrets." +layout: "second" +weight: 01 +--- + + + +include::../../../../_custom-en/clusterManagement/secrets/secrets-desc-secrets.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/01-create-a-configmap.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/01-create-a-configmap.adoc new file mode 100644 index 000000000..c94ea3ffe --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/01-create-a-configmap.adoc @@ -0,0 +1,38 @@ +--- +title: "Create ConfigMaps" +linkTitle: "Create ConfigMaps" +keywords: "Kubernetes, KubeSphere, Project Management, ConfigMap, Create ConfigMap" +description: "Learn how to create a ConfigMap." +weight: 01 +--- + + +:ks_permission: **ConfigMap Management** +:ks_navigation: **Configuration > ConfigMaps** + + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-desc-createAConfigmap.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-oper-createAConfigmap.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/02-view-a-configmap-list.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/02-view-a-configmap-list.adoc new file mode 100644 index 000000000..9a6e62aac --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/02-view-a-configmap-list.adoc @@ -0,0 +1,39 @@ +--- +title: "View ConfigMaps List" +linkTitle: "View ConfigMaps List" +keywords: "Kubernetes, KubeSphere, Project Management, ConfigMaps" +description: "Introduction to viewing the list of ConfigMaps." +weight: 02 +--- + +:ks_permission: **ConfigMap Viewing** +:ks_navigation: **Configuration > ConfigMaps** + + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-desc-viewAConfigmapList.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +==== +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-para-configmapList_new.adoc[] + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-oper-searchForConfigmaps.adoc[] + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/03-view-configmap-details.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/03-view-configmap-details.adoc new file mode 100644 index 000000000..80f728d5c --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/03-view-configmap-details.adoc @@ -0,0 +1,37 @@ +--- +title: "View ConfigMap Details" +linkTitle: "View ConfigMap Details" +keywords: "Kubernetes, KubeSphere, Project Management, ConfigMap, View ConfigMap Details" +description: "Instructions on how to view ConfigMap details." +weight: 03 +--- + +:ks_permission: **ConfigMap Viewing** +:ks_navigation: **Configuration > ConfigMaps** + + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-desc-viewConfigmapDetails.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-oper-viewConfigmapDetails.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/04-edit-configmap-information.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/04-edit-configmap-information.adoc new file mode 100644 index 000000000..fed120874 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/04-edit-configmap-information.adoc @@ -0,0 +1,33 @@ +--- +title: "Edit ConfigMap Information" +linkTitle: "Edit ConfigMap Information" +keywords: "Kubernetes, KubeSphere, Project Management, ConfigMap, Edit ConfigMap Information" +description: "Learn how to edit ConfigMap information." +weight: 04 +--- + +:ks_permission: **ConfigMap Management** +:ks_navigation: **Configuration > ConfigMaps** + + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-desc-editConfigmapInformation.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-oper-editConfigmapInformation.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/05-edit-configmap-settings.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/05-edit-configmap-settings.adoc new file mode 100644 index 000000000..431b6e312 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/05-edit-configmap-settings.adoc @@ -0,0 +1,33 @@ +--- +title: "Edit ConfigMap Settings" +linkTitle: "Edit ConfigMap Settings" +keywords: "Kubernetes, KubeSphere, Project Management, ConfigMap, Edit ConfigMap Settings" +description: "Learn how to edit ConfigMap data." +weight: 05 +--- + +:ks_permission: **ConfigMap Management** +:ks_navigation: **Configuration > ConfigMaps** + + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-desc-editConfigmapSettings.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-oper-editConfigmapSettings.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/06-delete-configmaps.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/06-delete-configmaps.adoc new file mode 100644 index 000000000..6cf3bfde6 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/06-delete-configmaps.adoc @@ -0,0 +1,46 @@ +--- +title: "Delete ConfigMaps" +linkTitle: "Delete ConfigMaps" +keywords: "Kubernetes, KubeSphere, Project Management, ConfigMap, Delete ConfigMap" +description: "Learn how to delete a ConfigMap." +weight: 06 +--- + +:ks_permission: **ConfigMap Management** +:ks_navigation: **Configuration > ConfigMaps** + + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-desc-deleteConfigmaps.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Delete a Single ConfigMap + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-oper-deleteASingleConfigmap.adoc[] + + +== Delete Multiple ConfigMaps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-oper-deleteMultipleConfigmaps.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/_index.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/_index.adoc new file mode 100644 index 000000000..6512b03df --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/02-configmaps/_index.adoc @@ -0,0 +1,14 @@ +--- +title: "ConfigMaps" +linkTitle: "ConfigMaps" +keywords: "Kubernetes, KubeSphere, Project Management, ConfigMap" +description: "Introduction to managing ConfigMaps." +layout: "second" +weight: 02 +--- + + + +include::../../../../_custom-en/clusterManagement/configmaps/configmaps-desc-configmaps.adoc[] + +ConfigMaps are only used to store non-sensitive data. If you need to store sensitive data, please use link:../01-secrets/[Secrets]. \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/01-create-a-service-account.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/01-create-a-service-account.adoc new file mode 100644 index 000000000..c4a754fce --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/01-create-a-service-account.adoc @@ -0,0 +1,34 @@ +--- +title: "Create Service Accounts" +linkTitle: "Create Service Accounts" +keywords: "Kubernetes, KubeSphere, Project Management, Service Account" +description: "Learn how to create a service account." +weight: 01 +--- + + +:ks_permission: **Service Account Management** +:ks_navigation: **Configuration > Service Accounts** + + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-createAServiceAccount.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-createAServiceAccount.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/02-view-a-service-account-list.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/02-view-a-service-account-list.adoc new file mode 100644 index 000000000..37f4a2eac --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/02-view-a-service-account-list.adoc @@ -0,0 +1,40 @@ +--- +title: "View Service Account List" +linkTitle: "View Service Account List" +keywords: "Kubernetes, KubeSphere, Project Management, Service Accounts" +description: "Explain how to view the list of service accounts in the cluster." +weight: 02 +--- + + +:ks_permission: **Service Account Viewing** +:ks_navigation: **Configuration > Service Accounts** + + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-viewAServiceAccountList.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +==== +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-para-serviceAccountList.adoc[] + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-searchForServiceAccounts.adoc[] + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/03-view-service-account-details.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/03-view-service-account-details.adoc new file mode 100644 index 000000000..770c84dcb --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/03-view-service-account-details.adoc @@ -0,0 +1,37 @@ +--- +title: "View Service Account Details" +linkTitle: "View Service Account Details" +keywords: "Kubernetes, KubeSphere, Project Management, Service Accounts, View Service Account Details" +description: "Explain how to view details of a service account." +weight: 03 +--- + +:ks_permission: **Service Account Viewing** +:ks_navigation: **Configuration > Service Accounts** + + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-viewServiceAccountDetails.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-viewServiceAccountDetails.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/04-edit-service-account-information.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/04-edit-service-account-information.adoc new file mode 100644 index 000000000..7a493b7d2 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/04-edit-service-account-information.adoc @@ -0,0 +1,34 @@ +--- +title: "Edit Service Account Information" +linkTitle: "Edit Service Account Information" +keywords: "Kubernetes, KubeSphere, Project Management, Service Accounts" +description: "Explain how to edit the alias and description of a service account." +weight: 04 +--- + + +:ks_permission: **Service Account Management** +:ks_navigation: **Configuration > Service Accounts** + + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-editServiceAccountInformation.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-editServiceAccountInformation.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/05-change-the-role-of-a-service-account.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/05-change-the-role-of-a-service-account.adoc new file mode 100644 index 000000000..1445dc901 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/05-change-the-role-of-a-service-account.adoc @@ -0,0 +1,33 @@ +--- +title: "Change Service Account Role" +linkTitle: "Change Service Account Role" +keywords: "Kubernetes, KubeSphere, Project Management, Service Accounts, Change Service Account Role" +description: "Explain how to change the role of a service account." +weight: 05 +--- + +:ks_permission: **Service Account Management** +:ks_navigation: **Configuration > Service Accounts** + + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-changeTheRoleOfAServiceAccount.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-changeTheRoleOfAServiceAccount.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/06-delete-service-accounts.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/06-delete-service-accounts.adoc new file mode 100644 index 000000000..ba3ac3fd1 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/06-delete-service-accounts.adoc @@ -0,0 +1,46 @@ +--- +title: "Delete Service Accounts" +linkTitle: "Delete Service Accounts" +keywords: "Kubernetes, KubeSphere, Project Management, Service Account, Delete Service Account" +description: "Learn how to delete a service account." +weight: 06 +--- + +:ks_permission: **Service Account Management** +:ks_navigation: **Configuration > Service Accounts** + + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-deleteServiceAccounts.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Delete a Single Service Account + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-deleteASingleServiceAccount.adoc[] + + +== Delete Multiple Service Accounts + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-oper-deleteMultipleServiceAccounts.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/_index.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/_index.adoc new file mode 100644 index 000000000..431e9160f --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/03-service-accounts/_index.adoc @@ -0,0 +1,11 @@ +--- +title: "Service Accounts" +linkTitle: "Service Accounts" +keywords: "Kubernetes, KubeSphere, Project Management, Service Accounts" +description: "Learn how to manage service accounts." +layout: "second" +weight: 03 +--- + + +include::../../../../_custom-en/clusterManagement/serviceAccounts/serviceAccounts-desc-serviceAccounts.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/05-configuration/_index.adoc b/content/en/docs/v4.1/09-project-management/05-configuration/_index.adoc new file mode 100644 index 000000000..f691625c8 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/05-configuration/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "Configuration" +linkTitle: "Configuration" +keywords: "Kubernetes, KubeSphere, Project Management, Configuration" +description: "Introduction to managing Secrets, ConfigMaps, and Service Accounts." +layout: "second" +weight: 05 +--- + + + +include::../../../_custom-en/clusterManagement/clusterManagement-desc-configuration.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/06-project-settings/01-basic-information/01-view-project-basic-information.adoc b/content/en/docs/v4.1/09-project-management/06-project-settings/01-basic-information/01-view-project-basic-information.adoc new file mode 100644 index 000000000..1929effa7 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/06-project-settings/01-basic-information/01-view-project-basic-information.adoc @@ -0,0 +1,45 @@ +--- +title: "View Project Basic Information" +linkTitle: "View Project Basic Information" +keywords: "Kubernetes, KubeSphere, Project Management, Basic Information, View Project Basic Information" +description: "Instructions on how to view project basic information." +weight: 01 +--- + +:ks_permission: **Project Settings Viewing** +:ks_navigation: **Project Settings > Basic Information** + + +This section explains how to view project basic information. + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +-- +The **Basic Information** page provides the following information: + +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Project Information +|Information about the current project, including the project's name, parent workspace, creator, creation time, number of services, number of project roles, and number of project members. + +include::../../../../_custom-en/clusterManagement/projects/projects-para-defaultContainerQuotas.adoc[] + +include::../../../../_custom-en/clusterManagement/projects/projects-para-projectQuotas.adoc[] +|=== +-- diff --git a/content/en/docs/v4.1/09-project-management/06-project-settings/01-basic-information/02-edit-project-information.adoc b/content/en/docs/v4.1/09-project-management/06-project-settings/01-basic-information/02-edit-project-information.adoc new file mode 100644 index 000000000..ab2468662 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/06-project-settings/01-basic-information/02-edit-project-information.adoc @@ -0,0 +1,46 @@ +--- +title: "Edit Project Basic Information" +linkTitle: "Edit Project Basic Information" +keywords: "Kubernetes, KubeSphere, Project Management, Basic Information, Edit Project Basic Information" +description: "Instructions on how to edit project basic information." +weight: 02 +--- + +:ks_permission: **Project Settings Management** +:ks_navigation: **Project Settings > Basic Information** + + +This section explains how to edit project basic information. + +You can edit the alias and description of a project. KubeSphere does not support editing the name of an already created project. + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. On the **Basic Information** page, click **Manage**, then select **Edit Information** from the dropdown list. + +. In the **Edit Information** dialog, set the alias and description for the project, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +| Parameter | Description + +include::../../../../_custom-en/clusterManagement/projects/projects-para-aliasDescription.adoc[] +|=== +-- diff --git a/content/en/docs/v4.1/09-project-management/06-project-settings/01-basic-information/03-edit-project-quotas.adoc b/content/en/docs/v4.1/09-project-management/06-project-settings/01-basic-information/03-edit-project-quotas.adoc new file mode 100644 index 000000000..54c58138d --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/06-project-settings/01-basic-information/03-edit-project-quotas.adoc @@ -0,0 +1,32 @@ +--- +title: "Edit Project Quotas" +linkTitle: "Edit Project Quotas" +keywords: "Kubernetes, KubeSphere, Project Management, Project Settings, Basic Information, Edit Project Quotas" +description: "Instructions on how to edit project quotas." +weight: 03 +--- + +:ks_permission: **Project Settings Management** +:ks_navigation: **Project Settings > Basic Information** + +include::../../../../_custom-en/clusterManagement/projects/projects-desc-editQuotas.adoc[] + +== Prerequisites + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. On the **Basic Information** page, click **Manage**, then select **Edit Project Quotas** from the dropdown list. + ++ + +include::../../../../_custom-en/clusterManagement/projects/projects-oper-editProjectQuotas.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/06-project-settings/01-basic-information/04-edit-default-container-quotas.adoc b/content/en/docs/v4.1/09-project-management/06-project-settings/01-basic-information/04-edit-default-container-quotas.adoc new file mode 100644 index 000000000..8ef6ab0f5 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/06-project-settings/01-basic-information/04-edit-default-container-quotas.adoc @@ -0,0 +1,32 @@ +--- +title: "Edit Default Container Quotas" +linkTitle: "Edit Default Container Quotas" +keywords: "Kubernetes, KubeSphere, Project Management, Project Settings, Basic Information, Edit Default Container Quotas" +description: "Instructions on how to edit default container quotas." +weight: 04 +--- + +:ks_permission: **Project Settings Management** +:ks_navigation: **Project Settings > Basic Information** + +include::../../../../_custom-en/clusterManagement/projects/projects-desc-editDefaultContainerQuotas.adoc[] + +== Prerequisites + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. On the **Basic Information** page, click **Manage**, then select **Edit Default Container Quotas** from the dropdown list. + ++ + +include::../../../../_custom-en/clusterManagement/projects/projects-oper-editDefaultContainerQuotas.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/06-project-settings/01-basic-information/05-delete-a-project.adoc b/content/en/docs/v4.1/09-project-management/06-project-settings/01-basic-information/05-delete-a-project.adoc new file mode 100644 index 000000000..a7c39ef8f --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/06-project-settings/01-basic-information/05-delete-a-project.adoc @@ -0,0 +1,30 @@ +--- +title: "Delete Projects" +linkTitle: "Delete Projects" +keywords: "Kubernetes, KubeSphere, Project Management, Project Settings, Basic Information, Delete Project" +description: "Instructions on how to delete a project." +weight: 05 +--- + +:ks_permission: **Project Settings Management** +:ks_navigation: **Project Settings > Basic Information** + +include::../../../../_custom-en/clusterManagement/projects/projects-desc-deleteProjects.adoc[] + +== Prerequisites + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. On the **Basic Information** page, click **Manage**, then select **Delete Project** from the dropdown list. + +. In the **Delete Project** dialog, enter the project name, then click **OK**. \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/06-project-settings/01-basic-information/_index.adoc b/content/en/docs/v4.1/09-project-management/06-project-settings/01-basic-information/_index.adoc new file mode 100644 index 000000000..d0475db74 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/06-project-settings/01-basic-information/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Basic Information" +linkTitle: "Basic Information" +keywords: "Kubernetes, KubeSphere, Project Management, Basic Information" +description: "Instructions on how to view and edit project basic information." +layout: "second" +weight: 01 +--- + +This section explains how to view and edit project basic information. \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/01-create-a-project-role.adoc b/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/01-create-a-project-role.adoc new file mode 100644 index 000000000..be9813563 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/01-create-a-project-role.adoc @@ -0,0 +1,48 @@ +--- +title: "Create Project Roles" +linkTitle: "Create Project Roles" +keywords: "Kubernetes, KubeSphere, Project Management, Project Settings, Project Roles, Create Project Role" +description: "Instructions on how to create a project role." +weight: 01 +--- + +:ks_permission: **Role Management** +:ks_navigation: **Project Settings > Project Roles** + +This section explains how to create a project role. + +== Prerequisites + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-clickCreate.adoc[] + ++ + +. In the **Create Role** dialog, set the name, alias, and description of the project role, then click **Edit Permissions**. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Name +|The name of the project role. The name can only contain lowercase letters, numbers, and hyphens (-), must start and end with a lowercase letter or number, and can be up to 63 characters long. + +include::../../../../_custom-en/projectManagement/projectRoles/projectRoles-para-aliasAndDescription.adoc[] +|=== +-- + +. In the **Edit Permissions** dialog, set the permissions for the project role, then click **OK**. ++ +include::../../../../_custom-en/projectManagement/projectRoles/projectRoles-para-permissions_v4.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/02-view-a-project-role-list.adoc b/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/02-view-a-project-role-list.adoc new file mode 100644 index 000000000..a332bf068 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/02-view-a-project-role-list.adoc @@ -0,0 +1,31 @@ +--- +title: "View Project Role List" +linkTitle: "View Project Role List" +keywords: "Kubernetes, KubeSphere, Project Management, Project Settings, Project Roles, View Project Role Lists" +description: "Learn how to view project role lists." +weight: 02 +--- + +:ks_permission: **Role Viewing** +:ks_navigation: **Project Settings > Project Roles** + +This section explains how to view the project role list. + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +-- +include::../../../../_custom-en/projectManagement/projectRoles/projectRoles-para-presetRoles.adoc[] +-- diff --git a/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/03-view-project-role-details.adoc b/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/03-view-project-role-details.adoc new file mode 100644 index 000000000..5035d9082 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/03-view-project-role-details.adoc @@ -0,0 +1,36 @@ +--- +title: "View Project Role Details" +linkTitle: "View Project Role Details" +keywords: "Kubernetes, KubeSphere, Project Management, Project Settings, Project Roles, View Project Role Details" +description: "Instructions on how to view project role details." +weight: 02 +--- + +:ks_permission: **Role Viewing** +:ks_navigation: **Project Settings > Project Roles** + +This section explains how to view project role details. + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. Click the name of a project role in the list to open its details page. + +. On the **Permissions** tab on the right side of the details page, you can view the permissions associated with the project role. + +. Click the **Authorized Users** tab on the right side of the details page to view users with the current project role. diff --git a/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/04-edit-project-role-information.adoc b/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/04-edit-project-role-information.adoc new file mode 100644 index 000000000..611af03dd --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/04-edit-project-role-information.adoc @@ -0,0 +1,45 @@ +--- +title: "Edit Project Role Information" +linkTitle: "Edit Project Role Information" +keywords: "Kubernetes, KubeSphere, Project, Project Settings, Project Role, Edit Project Role Information" +description: "Guide on how to edit project role information." +weight: 04 +--- + +:ks_permission: **Role Management** +:ks_navigation: **Project Settings > Project Roles** + +This section explains how to edit project role information. + +You can edit the alias and description of project roles created by users. KubeSphere does not support editing preset project roles and does not support editing the names of project roles. + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the project role you want to edit, then select **Edit Information** from the dropdown list. + +. In the **Edit Information** dialog, set the alias and description for the project role, then click **OK**. ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +include::../../../../_custom-en/projectManagement/projectRoles/projectRoles-para-aliasAndDescription.adoc[] +|=== +-- diff --git a/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/05-edit-permissions-of-a-project-role.adoc b/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/05-edit-permissions-of-a-project-role.adoc new file mode 100644 index 000000000..e0f52a342 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/05-edit-permissions-of-a-project-role.adoc @@ -0,0 +1,37 @@ +--- +title: "Edit Project Role Permissions" +linkTitle: "Edit Project Role Permissions" +keywords: "Kubernetes, KubeSphere, Project, Project Settings, Project Role, Edit Project Role Permissions" +description: "Guide on how to edit project role permissions." +weight: 05 +--- + +:ks_permission: **Role Management** +:ks_navigation: **Project Settings > Project Roles** + +This section explains how to edit project role permissions. + +You can only edit permissions for project roles created by users. Permissions for preset project roles cannot be edited. + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the project role you want to edit, then select **Edit Permissions** from the dropdown list. + +. In the **Edit Permissions** dialog, set the permissions for the project role, then click **OK**. ++ +include::../../../../_custom-en/projectManagement/projectRoles/projectRoles-para-permissions_v4.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/06-delete-a-project-role.adoc b/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/06-delete-a-project-role.adoc new file mode 100644 index 000000000..b80ac5474 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/06-delete-a-project-role.adoc @@ -0,0 +1,37 @@ +--- +title: "Delete Project Roles" +linkTitle: "Delete Project Roles" +keywords: "Kubernetes, KubeSphere, Project, Project Settings, Project Role, Delete Project Role" +description: "Guide on how to delete project roles." +weight: 06 +--- + +:ks_permission: **Role Management** +:ks_navigation: **Project Settings > Project Roles** + +This section explains how to delete project roles. + +You can delete project roles created by users. Preset project roles cannot be deleted. + + +== Prerequisites + +* {empty} +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +* Ensure the project role you want to delete is not assigned to any project members. Otherwise, you need to remove the project members or change their roles. + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the project role you want to delete, then select **Delete** from the dropdown list. + +. In the **Delete Role** dialog, click **OK** to confirm the deletion. diff --git a/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/_index.adoc b/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/_index.adoc new file mode 100644 index 000000000..a6ac02f54 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/06-project-settings/02-project-roles/_index.adoc @@ -0,0 +1,19 @@ +--- +title: "Project Roles" +linkTitle: "Project Roles" +keywords: "Kubernetes, KubeSphere, Project Management, Project Settings, Project Roles" +description: "Instructions on how to manage project roles." +layout: "second" +weight: 02 +--- + +This section explains how to manage project roles. + +Each project role contains specific project management or viewing permissions. You can grant roles with specific permissions to project members to control their permissions within the project. + +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +include::../../../../_custom-en/projectManagement/projectRoles/projectRoles-desc-initialProjectAdmin.adoc[] + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/06-project-settings/03-project-members/01-invite-a-user-to-a-project.adoc b/content/en/docs/v4.1/09-project-management/06-project-settings/03-project-members/01-invite-a-user-to-a-project.adoc new file mode 100644 index 000000000..9899b2330 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/06-project-settings/03-project-members/01-invite-a-user-to-a-project.adoc @@ -0,0 +1,43 @@ +--- +title: "Invite Users to Join Projects" +linkTitle: "Invite Users to Join Projects" +keywords: "Kubernetes, KubeSphere, Project Management, Project Settings, Project Members, Invite Users to Join Project" +description: "Guide on how to invite users to join a project." +weight: 01 +--- + +:ks_permission: **Member Management** +:ks_navigation: **Project Settings > Project Members** + +This section explains how to invite users to join a project. + + +== Prerequisites + +* {empty} +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +* Invited users should have joined the workspace to which the project belongs. + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-clickInvite.adoc[] + ++ + +. In the **Invite Member** dialog, click image:/images/ks-qkcp/zh/icons/add-dark.svg[add-dark,18,18] next to the user you want to invite. Select the role of the user in the project from the dropdown list, then click **OK**. ++ +-- +include::../../../../_custom-en/projectManagement/projectRoles/projectRoles-para-presetRoles.adoc[] + +The invited user will be displayed in the project member list. +-- diff --git a/content/en/docs/v4.1/09-project-management/06-project-settings/03-project-members/02-view-a-project-member-list.adoc b/content/en/docs/v4.1/09-project-management/06-project-settings/03-project-members/02-view-a-project-member-list.adoc new file mode 100644 index 000000000..dc7110a54 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/06-project-settings/03-project-members/02-view-a-project-member-list.adoc @@ -0,0 +1,62 @@ +--- +title: "View Project Member List" +linkTitle: "View Project Member List" +keywords: "Kubernetes, KubeSphere, Project Management, Project Settings, Project Members, View Project Member List" +description: "Guide on how to view the project member list." +weight: 02 +--- + +:ks_permission: **Member Viewing** +:ks_navigation: **Project Settings > Project Members** + + +This section explains how to view the project member list. + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] ++ +==== +* The project member list provides the following information: ++ +-- +[%header,cols="1a,4a"] +|=== +|Parameter |Description + +|Username +|The username of the project member. + +|Status +| +The current status of the project member. + +include::../../../../_custom-en/clusterManagement/clusterMembers/clusterMembers-para-userStatus.adoc[] + +|Role +|The role of the project member within the project. + +|Last Login +|The time when the project member last logged into the {ks_product-en} web console. +|=== +-- + +* Click the search box at the top of the list to search for project members by name. + +include::../../../../../_ks_components-en/oper-refreshListData.adoc[] + +include::../../../../../_ks_components-en/oper-customizeColumns.adoc[] +==== + diff --git a/content/en/docs/v4.1/09-project-management/06-project-settings/03-project-members/03-change-the-role-of-a-project-member.adoc b/content/en/docs/v4.1/09-project-management/06-project-settings/03-project-members/03-change-the-role-of-a-project-member.adoc new file mode 100644 index 000000000..070375feb --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/06-project-settings/03-project-members/03-change-the-role-of-a-project-member.adoc @@ -0,0 +1,35 @@ +--- +title: "Change Project Member Roles" +linkTitle: "Change Project Member Roles" +keywords: "Kubernetes, KubeSphere, Project Management, Project Settings, Project Members, Change Project Member Role" +description: "Guide on how to change the role of a project member." +weight: 04 +--- + +:ks_permission: **Member Management** +:ks_navigation: **Project Settings > Project Members** + +This section explains how to change the role of a project member. + +== Prerequisites + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. On the right side of the project member you want to edit, click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18], then select **Change Role**. + +. In the **Change Role** dialog, set the role for the project member from the dropdown list, then click **OK**. ++ +-- +include::../../../../_custom-en/projectManagement/projectRoles/projectRoles-para-presetRoles.adoc[] +-- diff --git a/content/en/docs/v4.1/09-project-management/06-project-settings/03-project-members/04-remove-a-project-member.adoc b/content/en/docs/v4.1/09-project-management/06-project-settings/03-project-members/04-remove-a-project-member.adoc new file mode 100644 index 000000000..620d650c6 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/06-project-settings/03-project-members/04-remove-a-project-member.adoc @@ -0,0 +1,45 @@ +--- +title: "Remove Project Members" +linkTitle: "Remove Project Members" +keywords: "Kubernetes, KubeSphere, Project Management, Project Settings, Project Members, Remove Project Member" +description: "Guide on how to remove a project member." +weight: 04 +--- + +:ks_permission: **Member Management** +:ks_navigation: **Project Settings > Project Members** + +This section explains how to remove a project member. + +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +Once a user is removed from the project, they will lose the permissions provided by the project role. + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] + + +== Prerequisites + + +include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + + + +== Steps + +include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components-en/oper-navigate.adoc[] + ++ + +. On the right side of the project member you want to remove, click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18], then select **Remove**. + +. In the **Remove Member** dialog, enter the username of the project member, then click **OK**. ++ +-- +Once the project member is removed, they will no longer appear in the project member list. +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/09-project-management/06-project-settings/03-project-members/_index.adoc b/content/en/docs/v4.1/09-project-management/06-project-settings/03-project-members/_index.adoc new file mode 100644 index 000000000..cfe0166d7 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/06-project-settings/03-project-members/_index.adoc @@ -0,0 +1,19 @@ +--- +title: "Project Members" +linkTitle: "Project Members" +keywords: "Kubernetes, KubeSphere, Project, Project Settings, Project Members" +description: "Guide on how to manage project members." +layout: "second" +weight: 03 +--- + +This section explains how to manage project members. + +Project members are users who have permissions to view or manage resources in a project. The permissions of project members are determined by the roles they have in the project. + +// Note +include::../../../../../_ks_components-en/admonitions/note.adoc[] + +include::../../../../_custom-en/projectManagement/projectRoles/projectRoles-desc-initialProjectAdmin.adoc[] + +include::../../../../../_ks_components-en/admonitions/admonEnd.adoc[] diff --git a/content/en/docs/v4.1/09-project-management/06-project-settings/_index.adoc b/content/en/docs/v4.1/09-project-management/06-project-settings/_index.adoc new file mode 100644 index 000000000..999852aaf --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/06-project-settings/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Project Settings" +linkTitle: "Project Settings" +keywords: "Kubernetes, KubeSphere, Project Management, Project Settings" +description: "Instructions on how to manage project settings." +layout: "second" +weight: 06 +--- + +This section explains how to view and manage the basic information, roles, and members of a project. diff --git a/content/en/docs/v4.1/09-project-management/_index.adoc b/content/en/docs/v4.1/09-project-management/_index.adoc new file mode 100644 index 000000000..a26993884 --- /dev/null +++ b/content/en/docs/v4.1/09-project-management/_index.adoc @@ -0,0 +1,14 @@ +--- +title: "Project Management" +linkTitle: "Project Management" +keywords: "Kubernetes, KubeSphere, Project Management" +description: "Introduces how to manage projects, including managing application workloads, storage resources, configuration resources , and project settings." +layout: "second" +weight: 09 +icon: "/images/docs/common/docs.svg" +--- + + +This section explains how to manage resources within a project. + +In KubeSphere, each workspace can contain one or more projects. Users can be invited to join projects and gain viewing and management permissions for project resources based on their project roles. \ No newline at end of file diff --git a/content/en/docs/v4.1/10-toolbox/01-use-kubectl-tool.adoc b/content/en/docs/v4.1/10-toolbox/01-use-kubectl-tool.adoc new file mode 100644 index 000000000..92d95125c --- /dev/null +++ b/content/en/docs/v4.1/10-toolbox/01-use-kubectl-tool.adoc @@ -0,0 +1,56 @@ +--- +title: "Run Commands with kubectl" +linkTitle: "Run Commands with kubectl" +keywords: "Kubernetes, KubeSphere, kubectl, command, running commands with kubectl" +description: "Introduction to running commands with kubectl." +weight: 01 +--- + +Kubectl is the Kubernetes command-line tool. You can use it to run commands on Kubernetes clusters to view and manage cluster resources, and more. + +The {ks_product-en} console provides a Web kubectl. By default, only users granted the platform-admin role (such as the default **admin** account) have permission to use the Web kubectl for cluster resource operations and management. + +This section demonstrates how to use the Web kubectl for cluster resource operations and management. + +== Prerequisites + +You should have the **platform-admin** role on the {ks_product-en} platform. For more information, please refer to link:../../05-users-and-roles/01-users.adoc[Users] and link:../../05-users-and-roles/02-platform-roles.adoc[Platform Roles]. + +== Using Web Kubectl + +. Log in to the {ks_product-en} web console with a user having the **platform-admin** role. + +. Hover the cursor over the image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18] icon in the bottom right corner of the page and click **kubectl** from the menu. + +. In the popup window, you will see the kubectl interface as shown below. If you have multiple clusters, you need to first select the target cluster from the dropdown list in the top right corner. If there is only one cluster, the dropdown list will not be visible. ++ +image:/images/ks-qkcp/en/v4.0/kubectl.png[,100%] + +. Enter kubectl commands in the command line tool to query and manage Kubernetes cluster resources. For example, execute the following command to check the status of all pods in the cluster. ++ +[source,bash] +---- +kubectl get pods -A +---- + +. Run kubectl commands in the terminal window using the following syntax: ++ +-- +[source,bash] +---- +kubectl [command] [TYPE] [NAME] [flags] +---- + +include::../../../_ks_components-en/admonitions/note.adoc[] + +* Here, command, TYPE, NAME, and flags are: + +** command: Specifies the operation to perform on one or more resources, such as create, get, describe, and delete. +** TYPE: Specifies link:https://kubernetes.io/zh-cn/docs/reference/kubectl/#resource-types[resource type]. Resource types are case-insensitive, and you can specify singular, plural, or abbreviated forms. +** NAME: Specifies the name of the resource. Names are case-sensitive. If the name is omitted, detailed information for all resources will be displayed, for example, `kubectl get pods`. +** flags: Specifies optional parameters. For example, you can use the `-s` or `--server` flag to specify the address and port of the Kubernetes API server. + +* If you need help, run `kubectl help` in the terminal window or refer to link:https://kubernetes.io/zh/docs/reference/kubectl/overview.adoc[Kubernetes Kubectl Documentation]. + +include::../../../_ks_components-en/admonitions/admonEnd.adoc[] +-- \ No newline at end of file diff --git a/content/en/docs/v4.1/10-toolbox/02-view-a-kubeconfig-file.adoc b/content/en/docs/v4.1/10-toolbox/02-view-a-kubeconfig-file.adoc new file mode 100644 index 000000000..24dbadfc1 --- /dev/null +++ b/content/en/docs/v4.1/10-toolbox/02-view-a-kubeconfig-file.adoc @@ -0,0 +1,17 @@ +--- +title: "View and Download kubeconfig Files" +linkTitle: "View and Download kubeconfig Files" +keywords: "Kubernetes, KubeSphere, Toolbox, View kubeconfig file" +description: "Learn how to view and download kubeconfig files." +weight: 02 +--- + +include::../../_custom-en/workspaceManagement/toolBox/toolBox-desc-viewKubeconfig.adoc[] + +== Prerequisites + +include::../../_custom-en/workspaceManagement/toolBox/toolBox-prer-viewKubeconfig.adoc[] + +== Steps + +include::../../_custom-en/workspaceManagement/toolBox/toolBox-oper-viewKubeconfig.adoc[] \ No newline at end of file diff --git a/content/en/docs/v4.1/10-toolbox/_index.adoc b/content/en/docs/v4.1/10-toolbox/_index.adoc new file mode 100644 index 000000000..d8b601b18 --- /dev/null +++ b/content/en/docs/v4.1/10-toolbox/_index.adoc @@ -0,0 +1,13 @@ +--- +title: "Toolbox" +linkTitle: "Toolbox" +keywords: "Kubernetes, KubeSphere, kubectl, Toolbox" +description: "Guide on how to use the toolbox." +layout: "second" +weight: 10 +icon: "/images/docs/common/docs.svg" +--- + +KubeSphere integrates the kubectl command-line tool and the kubeconfig file for the cluster. By using the kubeconfig file, you can configure access information for the current cluster. + +This section explains how to run commands using kubectl and how to view or download the kubeconfig file for the cluster. \ No newline at end of file diff --git a/content/en/docs/v4.1/20-release-notes/_index.adoc b/content/en/docs/v4.1/20-release-notes/_index.adoc new file mode 100644 index 000000000..69b039565 --- /dev/null +++ b/content/en/docs/v4.1/20-release-notes/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "Release Notes" +linkTitle: "Release Notes" +keywords: "Kubernetes, KubeSphere, Release Notes" +description: "Release notes of different kubesphere versions." +layout: "second" +weight: 20 +icon: "/images/docs/common/docs.svg" +--- + + +This chapter lists the release notes of all versions of KubeSphere. diff --git a/content/en/docs/v4.1/20-release-notes/release-v330.md b/content/en/docs/v4.1/20-release-notes/release-v330.md new file mode 100644 index 000000000..bebe68976 --- /dev/null +++ b/content/en/docs/v4.1/20-release-notes/release-v330.md @@ -0,0 +1,90 @@ +--- +title: "Release Notes for 3.3.0" +keywords: "Kubernetes, KubeSphere, Release Notes" +description: "KubeSphere 3.3.0 Release Notes" +linkTitle: "Release Notes - 3.3.0" +weight: 18098 +--- + +## DevOps +### Features +- Add the Continuous Deployment feature, which supports GitOps and uses Argo CD as the backend, and users can view the status of continuous deployments in real time. +- Add the allowlist feature on the **Basic Information** page of a DevOps project to restrict the target repository and deployment location for continuous deployments. +- Add support for importing and managing code repositories. +- Add support for built-in CRD-based pipeline templates and parameter customization. +- Add support for viewing pipeline events. + +## Storage +### Features + +- Add support for tenant-level storage class permission management. +- Add the volume snapshot content management and volume snapshot class management features. +- Add support for automatic restart of deployments and statefulsets after a PVC has been changed. +- Add the PVC auto expansion feature, which automatically expands PVCs when remaining capacity is insufficient. + +## Multi-tenancy and Multi-cluster +### Features +- Add a notification to remind users when the kubeconfig certificate of a cluster is about to expire. +- Add the kubesphere-config configmap, which provides the name of the current cluster. +- Add support for cluster-level member and role management. + +## Observability + +### Features +- Add process and thread monitoring metrics for containers. +- Add disk monitoring metrics that provide usage of each disk. +- Add support for importing Grafana templates to create custom monitoring dashboards of a namespace scope. +- Add support for defining separate data retention periods for container logs, resource events, and audit logs. + +### Enhancements & Updates +- Upgrade Alertmanager from v0.21.0 to v0.23.0. +- Upgrade Grafana from 7.4.3 to 8.3.3. +- Upgrade kube-state-metrics from v1.9.7 to v2.3.0. +- Upgrade node-exporter from v0.18.1 to v1.3.1. +- Upgrade Prometheus from v2.26.0 to v2.34.0. +- Upgrade Prometheus Operator from v0.43.2 to v0.55.1. +- Upgrade kube-rbac-proxy from v0.8.0 to v0.11.0. +- Upgrade configmap-reload from v0.3.0 to v0.5.0. +- Upgrade Thanos from v0.18.0 to v0.25.2. +- Upgrade kube-events from v0.3.0 to v0.4.0. +- Upgrade Fluent Bit Operator from v0.11.0 to v0.13.0. +- Upgrade Fluent Bit from v1.8.3 to v1.8.11. + +## KubeEdge Integration +### Features +- Add support for logging in to common cluster nodes and edge nodes from the KubeSphere web console. +### Enhancements & Updates +- Upgrade KubeEdge from v1.7.2 to v1.9.2. +- Remove EdgeWatcher. + +## Network +### Enhancements & Updates +- Integrate OpenELB with KubeSphere for exposing LoadBalancer services. +### Bug Fixes +- Fix an issue where the gateway of a project is not deleted after the project is deleted. +## App Store +### Bug Fixes +- Fix a ks-controller-manager crash caused by Helm controller NPE errors. + +## Authentication & Authorization +### Features +- Add support for manually disabling and enabling users. +## User Experience +- Add a prompt when the audit log of Kubernetes has been enabled. +- Add the lifecycle management feature for containers. +- Add support for creating container environment variables in batches from secrets and configmaps. +- Add a time range selector on the **Traffic Monitoring** tab page. +- Add a message in the **Audit Log Search** dialog, which prompts users to enable the audit logs feature. +- Add more Istio parameters in `ClusterConfiguration`. +- Add support for more languages, for example, Turkish. +- Set the **Token** parameter on the webhook settings page as mandatory. +- Prevent passwords without uppercase letters set through the backend CLI. +- Fix an issue where no data is displayed on the **Traffic Management** and **Tracing** tab pages in a multi-cluster project. +- Fix an app installation failure, which occurs when users click buttons too fast. +- Fix an issue where container probes are still displayed after they are deleted. +- Fix an issue where statefulset creation fails when a volume is mounted to an init container. +- Prevent ks-apiserver and ks-controller-manager from restarting when the cluster configuration is changed. +- Optimize some UI texts. +- Optimize display of the service topology on the **Service** page. + +For more information about issues and contributors of KubeSphere 3.3.0, see [GitHub](https://github.com/kubesphere/kubesphere/blob/master/CHANGELOG/CHANGELOG-3.3.md). \ No newline at end of file diff --git a/content/en/docs/v4.1/20-release-notes/release-v331.md b/content/en/docs/v4.1/20-release-notes/release-v331.md new file mode 100644 index 000000000..375e08f94 --- /dev/null +++ b/content/en/docs/v4.1/20-release-notes/release-v331.md @@ -0,0 +1,42 @@ +--- +title: "Release Notes for 3.3.1" +keywords: "Kubernetes, KubeSphere, Release Notes" +description: "KubeSphere 3.3.1 Release Notes" +linkTitle: "Release Notes - 3.3.1" +weight: 18096 +--- + +## DevOps +### Enhancements & Updates + +- Add support for editing the kubeconfig binding mode on the pipeline UI. + +### Bug Fixes + +- Fix an issue where users fail to check the CI/CD template. +- Remove the `Deprecated` tag from the CI/CD template and replace `kubernetesDeploy` with `kubeconfig binding` at the deployment phase. + +## Network +### Bug Fixes + +- Fix an issue where users fail to create routing rules in IPv6 and IPv4 dual-stack environments. + +## Storage +### Bug Fixes + +- Set `hostpath` as a required option when users are mounting volumes. + + +## Authentication & Authorization +### Bug Fixes + +- Delete roles `users-manager` and `workspace-manager`. +- Add role `platform-self-provisioner`. +- Block some permissions of custom roles. + +## User Experience + +- Add support for changing the number of items displayed on each page of a table. +- Add support for batch stopping workloads. + +For more information about issues and contributors of KubeSphere 3.3.1, see [GitHub](https://github.com/kubesphere/kubesphere/blob/master/CHANGELOG/CHANGELOG-3.3.1.md). \ No newline at end of file diff --git a/content/en/docs/v4.1/20-release-notes/release-v332.md b/content/en/docs/v4.1/20-release-notes/release-v332.md new file mode 100644 index 000000000..1c80c0d92 --- /dev/null +++ b/content/en/docs/v4.1/20-release-notes/release-v332.md @@ -0,0 +1,92 @@ +--- +title: "Release Notes for 3.3.2" +keywords: "Kubernetes, KubeSphere, Release Notes" +description: "KubeSphere 3.3.2 Release Notes" +linkTitle: "Release Notes - 3.3.2" +weight: 18095 +--- + +## DevOps + +### Enhancements & Upgrades + +- Add the latest GitHub Actions. +- Save the PipelineRun results to the configmap. +- Modify the Chinese description of the status of ArgoCD applications. +- Add more information to continuous deployment parameters. +- Add a link for PipelineRun in the aborted state. +- Add an ID column for PipelineRun, and the ID will be displayed when users run kubectl commands. +- Remove the queued state from PipelineRun. + +### Bug Fixes + +- Fix an issue where webhook configurations are missing after users change and save pipeline configurations. +- Fix an issue where downloading DevOps pipeline artifacts fails. +- Fix an issue where the image address does not match when a service is created by using a JAR/WAR file. +- Fix an issue where the status of PipelineRun changes from `Cancelled` to `Not-Running`. +- Fix the automatic cleaning behavior of pipelines to keep it consistent with the cleaning configurations of Jenkins. + +## App Store + +### Bug Fixes + +- Fix an issue where the application icon is not displayed on the uploaded application template. +- Fix an issue where the homepage of an application is not displayed on the application information page. +- Fix an issue where importing built-in applications fails. +- Fix a UUID generation error in an IPv6-only environment. + +## Observability + +### Bug Fixes + +- Fix a parsing error in the configuration file of logsidecar-injector. + +## Service Mesh + +### Bug Fixes + +- Fix an issue that application governance of Bookinfo projects without service mesh enabled is not disabled by default. +- Fix an issue where the delete button is missing on the blue-green deployment details page. + +## Network + +### Bug Fixes + +- Restrict network isolation of projects within the current workspace. + +## Storage + +### Enhancements & Upgrades + +- Display the cluster to which system-workspace belongs in multi-cluster environments. +- Rename route to ingress. + +## Authentication & Authorization + +### Enhancements & Upgrades + +- Add dynamic options for cache. +- Remove the "Alerting Message Management" permission. + +### Bug Fixes + +- Fix an issue where platform roles with platform management permisions cannot manage clusters. + +## Development & Testing + +### Bug Fixes + +- Fix an issue where some data is in the `Out of sync` state after the live-reload feature is introduced. +- Fix an issue where the ks-apiserver fails when it is reloaded multiple times. +- Fix an issue where caching resources fails if some required CRDs are missing. +- Fix an issue where the ks-apiserver crashes in Kubernetes 1.24+ versions. +- Fix an issue where Goroutine leaks occur when the audit event sender times out. + +## User Experience + +- Limit the length of cluster names. +- Fix an issue where pod replicas of a federated service are not automatically refreshed. +- Fix an issue where related pods are not deleted after users delete a service. +- Fix an issue where the number of nodes and roles are incorrectly displayed when there is only one node. + +For more information about issues and contributors of KubeSphere 3.3.2, see [GitHub](https://github.com/kubesphere/kubesphere/blob/master/CHANGELOG/CHANGELOG-3.3.2.md). \ No newline at end of file diff --git a/content/en/docs/v4.1/20-release-notes/release-v340.md b/content/en/docs/v4.1/20-release-notes/release-v340.md new file mode 100644 index 000000000..f775cd3da --- /dev/null +++ b/content/en/docs/v4.1/20-release-notes/release-v340.md @@ -0,0 +1,154 @@ +--- +title: "Release Notes for 3.4.0" +keywords: "Kubernetes, KubeSphere, Release Notes" +description: "KubeSphere 3.4.0 Release Notes" +linkTitle: "Release Notes - 3.4.0" +weight: 18094 +--- + +## DevOps + +### Enhancements & Updates + +- Support user-defined pipeline configuration steps. +- Optimize the devops-jenkins JVM memory configuration. + +### Bug Fixes + +- Fix the issue of removing ArgoCD resources without cascade parameters. +- Fix the issue that downloading artifacts for multi-branch pipelines fails. +- Fix the issue that the pipeline running status is inconsistent with Jenkins (Add retry for pipelinerun annotation update). +- Fix the issue that the running of a pipeline created by a new user is pending. + + +## Storage + +### Bug Fixes + +- Fix the issue that pvc cannot be deleted. + +## Gateway and Microservice + +### Features + +- Gateway supports the configuration of forwarding TCP/UDP traffic. + +### Enhancements & Updates + +- Upgrade ingress nginx: v1.1.0 -> v1.3.1. +- Upgrade servicemesh: +istio: 1.11.1 -> 1.14.6; kiali: v1.38.1 -> v1.50.1; jaeger: 1.27 -> 1.29. + +### Bug Fixes + +- Fix the issue that the returned cluster gateways duplicate. +- Fix the verification error when upgrading the gateway. +- Fix the abnormal display of cluster gateway log and resource status after changing gateway namespace configuration. + +## Observability + +### Features + +- Add CRDs such as RuleGroup, ClusterRuleGroup, GlobalRuleGroup to support Alerting v2beta1 APIs. +- Add admission webhook for RuleGroup, ClusterRuleGroup, GlobalRuleGroup. +- Add controllers to sync RuleGroup, ClusterRuleGroup, GlobalRuleGroup resources to PrometheusRule resources. +- Add Alerting v2beta1 APIs. +- The ks-apiserver of Kubesphere integrates the v1 and v2 versions of opensearch, and users can use the external or built-in opensearch cluster for log storage and query. (Currently the built-in opensearch version of Kubesphere is v2). +- ks-installer integrates the opensearch dashboard, which should be enabled by users. + +### Enhancements & Updates +- Upgrade Prometheus stack dependencies. +- Support configuring the maximum number of logs that can be exported. +- The monitoring component supports Kubernetes PDB Apiversion changes. +- Upgrade Notification Manager to v2.3.0. +- Support cleaning up notification configuration in member clusters when a member cluster is deleted. +- Support switching notification languages. +- Support route notifications to specified users. + +### Bug Fixes + +- Fix the issue that Goroutine leaks when getting audit event sender times out. +- Fix the promql statement of ingress P95 delay. + + +## Multi-tenancy and Multi-cluster + +### Enhancements & Updates + +- Check the cluster ID (kube-system UID) when updating the cluster. + +### Bug Fixes + +- Make sure the cluster is Ready when cleaning up notifications. +- Fix the webhook validation issue for new clusters. +- Fix the incorrect cluster status. +- Fix the issue of potentially duplicated entries for granted clusters in the workspace. + + +## App Store + +### Bug Fixes + +- Fix the ID generation failure in IPv6-only environment. +- Fix the missing Home field in app templates. +- Fix the issue that the uploaded app templates do not show icons. +- Fix missing maintainers in Helm apps. +- Fix the issue that Helm applications in a failed status cannot be upgraded again. +- Fix the wrong "applicationId" parameter. +- Fix the infinite loop after app installation failure. +- FIx the wrong status of application repository. + + +## Network + +### Enhancements & Updates + +- Upgrade dependencies. + + +## Authentication and Authorization + +### Features + +- Add inmemory cache. +- Add Resource Getter v1beta1. +- Add write operation for Resource Manager. + +### Enhancements & Updates + +- Add iam.kubesphere/v1beta1 RoleTemplate. +- Update the password minimum length to 8. +- Update Version API. +- Update identityProvider API. +- Add IAM v1beta1 APIs. + +### Bug Fixes + +- Fix the issue that the enableMultiLogin configuration does not take effect. + +## API Changes + +- Use autoscaling/v2 API. +- Use batch/v1 API. +- Update health check API. +- Fix the ks-apiserver crash issue in K8s v1.25. + + +## User Experience + +### Features + +- Resource API supports searching alias in annotations. + +### Bug Fixes + +- Fix the potential Websocket link leakage issue. + +### Enhancements & Updates +- Use Helm action package instead of using Helm binary. +- Adjust the priority of bash and sh in the kubectl terminal. +- Fix the issue that ks-apiserver cannot start due to DiscoveryAPI exception. +- Fix the issue that the pod status is inconsistent with the filtered status when filtering by status on the pod list page. +- Support querying the secret list according to the secret type by supporting fieldSelector filtering. + +For more information about issues and contributors of KubeSphere 3.4.0, see [GitHub](https://github.com/kubesphere/kubesphere/blob/master/CHANGELOG/CHANGELOG-3.4.0.md). \ No newline at end of file diff --git a/content/en/docs/v4.1/20-release-notes/release-v341.md b/content/en/docs/v4.1/20-release-notes/release-v341.md new file mode 100644 index 000000000..b84c14be8 --- /dev/null +++ b/content/en/docs/v4.1/20-release-notes/release-v341.md @@ -0,0 +1,96 @@ +--- +title: "Release Notes for 3.4.1" +keywords: "Kubernetes, KubeSphere, Release Notes" +description: "KubeSphere 3.4.1 Release Notes" +linkTitle: "Release Notes - 3.4.1" +weight: 18093 +--- + +## App Store + +### Bug Fixes + +- Fix the error on the application repository page. +- Fix the error in the application approval process. +- Support "select" in Appdeploy schemaform. + + +## Console + +### Bug Fixes + +- Fix the issue of losing status when modifying a CRD. +- Fix the incorrect style for IsolateInfo and RuleInfo in the Network Policy panel. +- Fix inaccurate Chinese translations on some pages. +- Fix the resource creation failure issue in higher versions of Kubernetes. +- Fix the issue in the dashboard where the names in Recently Access are obscured. +- Fix the issue on the list page where the Customize Columns button displays incomplete content. +- Fix the display error of pod status. +- Fix the issue on the PVC page where the capacity selection numbers are displayed incorrectly. +- Fix the issue when adding containers on the Create Deployment page, using tags to search for images is not working. +- Support building ARM64 images. + +## Multi Cluster + +### Bug Fixes + +- Fix the issue where CD-related clusters are displayed incorrectly in a multi-cluster environment. +- Fix the issue of mistakenly adding a host cluster as a member cluster of another cluster. + + +## Observability + +### Bug Fixes + +- Fix the issue that CPU and memory statistics charts are not displaying. +- Fix API call errors on the notification channel page. +- Fix the blank log receiver page. +- Fix the issue on the new notification channel page where conditional filtering values are missing. + + +## Authentication & Authorization + +### Bug Fixes + +- Fix LDAP login failure. + +## DevOps + +### Bug Fixes + +- Fix the issue where shell is not effective in graphical editing. +- When a cluster is not ready or does not install DevOps, DevOps projects are unavailable. +- Fix the incorrect parameter passing in Jenkins. +- Fix the issue that clicking the replay button pops up an error prompt. +- Fix the issue that the details of a pipeline cannot be viewed. +- Fix the run error due to the large DevOps pipeline logs. +- Fix Jenkins image vulnerability. +- Fix the issue that failed to upgrade DevOps to 3.4.0. +- Fix the error in the cleanup task. +- Fix the failure to set a timeout. +- Fix the bug with downloading multi-branch-pipeline artifacts. +- Fix the issue that disabling discarded history pipelineruns doesn't work. +- Fix the issue that some application resources are not deleted when cascade deleting multiple applications. + +### Enhancements & Updates + +- Display the git repo link on the Pipeline page. +- Improve the API documentation for DevOps. + +## User Experience + +### Bug Fixes + +- Fix the issue on the Statefuls page where the Pod Grace Period parameter is missing. +- Fix the issue where the cluster gateway is not displayed in cluster management. +- Fix the error when creating an application route. +- Add pagination for listing repository tags. + + +## Monitoring + +### Bug Fixes + +- Fix the issue that the Monitoring Target field is displayed blank. + +For more information about issues and contributors of KubeSphere 3.4.1, see [GitHub](https://github.com/kubesphere/kubesphere/blob/master/CHANGELOG/CHANGELOG-3.4.1.md). \ No newline at end of file diff --git a/content/en/docs/v4.1/20-release-notes/release-v411.md b/content/en/docs/v4.1/20-release-notes/release-v411.md new file mode 100644 index 000000000..b74e25fca --- /dev/null +++ b/content/en/docs/v4.1/20-release-notes/release-v411.md @@ -0,0 +1,175 @@ +--- +title: "Release Notes for 4.1.1" +linkTitle: "Release Notes - 4.1.1" +keywords: "Kubernetes, KubeSphere, Release Notes" +description: "KubeSphere 4.1.1 Release Notes" +weight: 45 +--- + +## KubeSphere + +### Features + +* Refactor based on the new microkernel architecture of KubeSphere LuBan. +* Introduce the KubeSphere Marketplace as a built-in feature. +* Support for managing extensions through the Extensions Center. +* UI and API can be extended. +* Support for one-click import of member clusters via kubeconfig. +* Support for KubeSphere Service Accounts. +* Support for dynamic extension of the Resource API. +* Support for adding clusters, workspaces, and projects to quick access. +* Enabled file upload and download via container terminal. +* Adapted to cloud-native gateways (Kubernetes Ingress API) from different vendors. +* Support API rate limiting. +* Support creating persistent volumes on the page. + +### Enhancements + +* Support for selecting all clusters when creating a workspace. +* Optimization of web kubectl, supporting dynamic recycling of pods and fuzzy search when switching clusters. +* Optimization of node list, changing the default sorting to ascending order. +* Only allow trusted OAuth clients to verify user identity directly using username and password. +* Streamline the Agent components deployed in member clusters. +* Split some configurations in KubeSphere Config as independent configuration items. +* Adjust the search result of container images to sort in reverse chronological order. +* Support for editing user aliases. +* Display scheduling status in the cluster list. +* Support binaryData data display in ConfigMap details. +* Refactor the Workbench page. +* Remove unnecessary extensions. +* Support fast deployment and uninstallation via helm. +* Simplify the deployment of agents in member clusters. +* Support for disabling terminal for control plane nodes. +* Support triggering cluster resource synchronization proactively. +* User experience improvements on the workload pages under clusters. +* User experience improvements on the application list page. +* User experience improvements on the persistent volume claim and storage class list pages. +* Optimize the display of excessively long resource names. +* Support globally enabling fieldValidation. +* Support horizontal movement on the cluster nodes list page. + + +### Bug Fixes + +* Fix the issue of the node terminal displaying "connecting" indefinitely. +* Fix the potential issue of unauthorized access to resources in the workspace. +* Fix the potential issue of unauthorized access to cluster authorization APIs in the workspace. +* Fix the issue of abnormal session logout due to incorrect configuration. +* Fix the issue of exceptions when adding image service information to pull images from a specified repository. +* Fix the issue of missing ownerReferences when editing Secrets. +* Fix the issue of white screen and incorrect page redirection during the initial login. +* Fix the scrolling issue with checkboxes in Windows environment. +* Fix the problem where the cluster management entry couldn't be found when logged in as cluster-admin. +* Fix the issue where closing the kubectl container terminal did not terminate the corresponding pod. +* Fix the issue where the cluster cannot be selected when downloading kubeconfig. +* Fix the issue where resource names were not fully displayed in some lists due to excessive length. +* Fix the missing translations in some pages. +* Fix the blank display issue on container details page. +* Fix the default skip certificate verification issue when selecting HTTPS for image registry addresses when creating secrets. +* Fix inability to edit project roles for service accounts of member clusters. +* Fix inability to edit settings for configmaps without key-value pairs. +* Fix inability to edit or delete key-value pair data for configmaps of member clusters. +* Fix the display issue with pop-up dialog when removing unready clusters on the cluster management page. +* Fix the progress bar display issue when removing clusters on cluster management page. +* Fix disappearance of the selection status of previously selected clusters after searching for clusters in pop-up dialog for "Add tags to clusters". +* Fix pagination issue for pods on workload details page. +* Fix display of HTML comments in changelogs on extension details page. +* Fix incomplete display of floating elements on list pages under certain circumstances. +* Fix abnormal display of error messages in the top right corner. +* Fix display issue with pop-up dialog for creating workspaces. +* Fix inability to search for Harbor (version 2.8.0 and later) images. +* Fix slow loading of console under HTTPS protocol. +* Specify cluster creator as cluster administrator by default. +* Fix exception when deleting labels from nodes. +* Fix the issue where page does not refresh in real time when adding member clusters. +* Add prompt message when uploading files in containers. +* Fix the issue where clusters are not filtered based on user permissions when selecting clusters. +* Fix potential permission escalation and authorization risks in helm application deployment. +* Fix the issue where file upload freezes when creating application templates. +* Fix the issue where applications created in one project are visible in other projects. +* Fix the issue where bitnami source in application repository cannot be synchronized. +* Fix the issue where application template displays no data. +* Fix the issue where unauthorized users encounter a blank page when deploying applications from the app store. +* Fix incorrect display of types of secrets. +* Fix display issue with workspace list. +* Fix incorrect status in persistent volume list. +* Fix failure to create PVC based on snapshots. +* Remove unnecessary prompt for persistent volume expansion. +* Fix incorrect display of type dropdown when creating secrets. +* Fix data filling error when creating secrets with the "Image registry information" type. +* Fix the issue where workload list cannot retrieve all projects. +* Fix abnormal display of prompt information for pods in workloads. +* Fix the issue where versions displayed in CRDs page is not the latest. +* Fix display issue when searching for clusters in cluster list. +* Fix the issue where web kubectl terminal is unusable in EKS environment. + +### API Updates + +#### API Removal + +The following APIs will be removed in v4.1: + +**Multi-cluster** + +The multi-cluster proxy request API `/API_PREFIX/clusters/{cluster}/API_GROUP/API_VERSION/...` has been removed. Please use the new multi-cluster proxy request path rule `/clusters/{cluster}/API_PREFIX/API_GROUP/API_VERSION/...` instead. + +**Access Control** + +- The `iam.kubesphere.io/v1alpha2` API version has been removed. Please use the `iam.kubesphere.io/v1beta1` API version instead. + +- Significant changes in `iam.kubesphere.io/v1beta1`: + The API Group for Role, RoleBinding, ClusterRole, and ClusterRoleBinding resources has changed from `rbac.authorization.k8s.io` to `iam.kubesphere.io`. + +**Multi-tenancy** + +- Partial APIs in `tenant.kubesphere.io/v1alpha1` and `tenant.kubesphere.io/v1alpha2` API versions have been removed. Please use the `tenant.kubesphere.io/v1beta1` API version instead. + +- Significant changes in `tenant.kubesphere.io/v1beta1`: + `spec.networkIsolation` in `Workspace` has been removed. + +**kubectl** + +- The `/resources.kubesphere.io/v1alpha2/users/{user}/kubectl` interface has been removed. Terminal-related operations no longer need to call this interface. +- The API path for the user web kubectl terminal has been adjust from `/kapis/terminal.kubesphere.io/v1alpha2/namespaces/{namespace}/pods/{pod}/exec` to `/kapis/terminal.kubesphere.io/v1alpha2/users/{user}/kubectl`. + +**Gateway** + +The `gateway.kubesphere.io/v1alpha1` API version has been removed. + +- The API for querying related gateways of the Ingress configuration has been adjust to `/kapis/gateway.kubesphere.io/v1alpha2/namespaces/{namespace}/availableingressclassscopes`. + +#### API Deprecations + +The following APIs have been marked as deprecated and will be removed in future versions: + +- 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 + +### Known Issues + +* Upgrade from version 3.x to 4.x is not supported at present, but will be supported in subsequent releases. +* The following functions are temporarily unavailable and will be offered by extensions later: + * Monitoring + * Alerting + * Notifications + * Istio + * DevOps + * Project gateway and cluster gateway + * Storage volume snapshot + * Network isolation + * OpenPitrix for app management + + +* The following features are currently unavailable and will be supported in subsequent versions: + * Department management in workspaces + +### Misc + +- Remove all language options except English and Simplified Chinese by default. +- Remove content related to system components. \ No newline at end of file diff --git a/content/en/docs/v4.1/20-release-notes/release-v412.md b/content/en/docs/v4.1/20-release-notes/release-v412.md new file mode 100644 index 000000000..4af012829 --- /dev/null +++ b/content/en/docs/v4.1/20-release-notes/release-v412.md @@ -0,0 +1,29 @@ +--- +title: "Release Notes for 4.1.2" +linkTitle: "Release Notes - 4.1.2" +keywords: "Kubernetes, KubeSphere, Release Notes" +description: "KubeSphere 4.1.2 Release Notes" +weight: 44 +--- + +## KubeSphere + +### Installation/Upgrade Command + +``` +helm upgrade --install -n kubesphere-system --create-namespace ks-core https://charts.kubesphere.io/main/ks-core-1.1.2.tgz --debug --wait +``` + +### Features + +- Support for OCI-based Helm Chart repositories. + +### Enhancements + +- Add the default extension repository. + +### Bug Fixes + +- Fix white screen pages of some extensions. +- Fix problem of residual resources when uninstalling ks-core. +- Fix installation failure in K8s 1.19 environments. \ No newline at end of file diff --git a/content/en/docs/v4.1/24-faq/01-info-collection.adoc b/content/en/docs/v4.1/24-faq/01-info-collection.adoc new file mode 100644 index 000000000..2a67949b6 --- /dev/null +++ b/content/en/docs/v4.1/24-faq/01-info-collection.adoc @@ -0,0 +1,26 @@ +--- +title: "Improvement Plan" +linkTitle: "Improvement Plan" +weight: 01 +keywords: "Installer, Telemetry, KubeSphere, Kubernetes" +description: "Learn about what information KubeSphere collects and how to enable or disable data collection." +--- + +== What is the Improvement Plan? + +The Improvement Plan collects information about KubeSphere installation and feature usage. This information is used solely by KubeSphere to enhance the product and is not shared with any third parties. + +== What does the Improvement Plan report? + +The Improvement Plan does not collect any specific identifying information such as usernames, passwords, resource names, or addresses. + +The main collected information includes: + +- Extension installation information: Extension name, extension version, and installation time. +- Cluster information: Cluster name, cluster role, cluster version, cluster UID (UID of the kube-system namespace), KubeSphere version, KubeSphere UID (UID of the kubesphere-system namespace). +- Cluster node information: Node name, node UID, node role, node architecture, node operating system version, node operating system image name, kernel version, container runtime version, kube-proxy version, kubelet version. +- Resource statistics: Number of users, number of namespaces, number of workspaces. + +== How to participate in or opt out of the Improvement Plan? + +When installing or configuring KubeSphere, you can choose to participate in the Improvement Plan or not by configuring `telemetry.enabled`. For more information, refer to link:../../03-installation-and-upgrade/02-install-kubesphere/05-appendix/#_advanced_options[Advanced Configuration of KubeSphere Core]. \ No newline at end of file diff --git a/content/en/docs/v4.1/24-faq/_index.adoc b/content/en/docs/v4.1/24-faq/_index.adoc new file mode 100644 index 000000000..0fc72336c --- /dev/null +++ b/content/en/docs/v4.1/24-faq/_index.adoc @@ -0,0 +1,8 @@ +--- +title: "FAQ" +linkTitle: "FAQ" +description: "Summary and answers to common questions about KubeSphere." +layout: "second" +weight: 24 +icon: "/images/docs/v3.x/docs.svg" +--- \ No newline at end of file diff --git a/content/en/docs/v4.1/_index.adoc b/content/en/docs/v4.1/_index.adoc new file mode 100644 index 000000000..4210f82ef --- /dev/null +++ b/content/en/docs/v4.1/_index.adoc @@ -0,0 +1,43 @@ +--- +title: Documentation +css: scss/docs.scss +isDocsRoot: true +LinkTitle: Documentation + +section1: + title: KubeSphere Documentation + content: Learn how to build and manage cloud-native applications using KubeSphere Container Platform. Get documentation, example code, tutorials, and more. + image: /images/docs/common/banner.png + +sectionLink: + docs: + title: Popular Pages + description: Learn how to use KubeSphere with these quickstarts, tutorials, and examples. + list: + - /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 + +section3: + title: Run KubeSphere and Kubernetes Stack from the Cloud Service + description: Cloud Providers are providing KubeSphere as a cloud-hosted service for users, helping you to create a highly available Kubernetes cluster managed by KubeSphere within minutes via several clicks. It enables you to use the cloud-hosted Kubernetes services out of the box. + 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: Want to host KubeSphere on your cloud or your solution? + btnContent: Partner with us + btnLink: /partner/ +--- \ No newline at end of file diff --git a/content/en/news/kubesphere-v4-ga-announcement.md b/content/en/news/kubesphere-v4-ga-announcement.md new file mode 100644 index 000000000..d632b86bf --- /dev/null +++ b/content/en/news/kubesphere-v4-ga-announcement.md @@ -0,0 +1,152 @@ +--- +title: 'KubeSphere v4 is Released with the New Pluggable Architecture - LuBan' +tag: 'Product News' +keyword: 'open source, Kubernetes, KubeSphere, K8s, release, KubeSphere LuBan, plug-and-play' +description: 'Built on the new cloud-native extensible open architecture - KubeSphere LuBan, KubeSphere v4 serves as a cloud-native operating system that holds extraordinary significance for KubeSphere.' +createTime: '2024-10-10' +author: 'KubeSphere' +image: 'https://pek3b.qingstor.com/kubesphere-community/images/ks-v4-ga-cover.png' +--- + +On October 10, 2024, KubeSphere v4 (open source version) is officially released, along with the launch of the brand new pluggable architecture - KubeSphere LuBan. + +Compared to all previous versions of KubeSphere, KubeSphere v4 represents a revolutionary change. Built on the new cloud-native extensible open architecture - KubeSphere LuBan, KubeSphere v4 serves as a cloud-native operating system that holds extraordinary significance for KubeSphere. + +## KubeSphere LuBan + +### What is KubeSphere LuBan + +LuBan(鲁班), the ancestor of craftsmen in ancient China, symbolizes the wisdom and creativity of the laboring masses. He improved labor efficiency with tools, liberating workers from primitive and arduous tasks and revolutionizing civil engineering. Named after him, KubeSphere LuBan (KubeSphere Core) aims to offer businesses and developers a cloud-native product with low cost, rapid iteration, and flexible integration, providing a professional, versatile, and creative experience. + +KubeSphere LuBan, a distributed, open, and scalable cloud-native architecture, provides a pluggable microkernel for extensions. From now on, all KubeSphere functional components and third-party components will seamlessly integrate into the KubeSphere console as extensions based on KubeSphere LuBan, and maintain their versions independently, truly achieving a plug-and-play cloud-native operating system. + +The architectural design of KubeSphere LuBan is shown in the figure below. + +![](https://kubesphere.io/images/ks-qkcp/zh/v4.0/4.0-architecture.png) + +### Why Introduce KubeSphere LuBan + +Since 2018, the KubeSphere multi-cloud container management platform has released over a dozen versions, including three major ones. To meet user demands, KubeSphere integrated numerous enterprise-grade features, such as multi-tenancy management, multi-cluster management, DevOps, GitOps, service mesh, microservices, observability (including monitoring, alerts, logging, auditing, events, notifications, etc.), App Store, edge computing, network, storage, etc. + +While KubeSphere’s all-in-one container solution significantly enhances users' experience, it has also brought the following challenges: + +- **Long release cycle**: Before releasing a new version, we must wait for all extensions to finish development and testing, and pass the integration testing. +- **Delayed user response**: Since each extension cannot be iterated separately, even when we have solved the issues of extensions submitted by users, we have to wait for the new release of KubeSphere to deliver the solutions to users, resulting in a delayed response. +- **Code coupling**: Although the old version supports enabling/disabling extensions individually, the frontend and backend code of these extensions are still coupled together, which tends to affect each other and is not architecturally elegant. +- **Excessive resource consumption**: Some extensions are enabled by default, which may consume excessive system resources for users who do not need them. + +### Advantages of KubeSphere LuBan + +- **Pluggable framework**: Support independent development and deployment of extensions to extend the functionality. Extensions can be added, upgraded, or removed as needed without modifying the code of the core framework. +- **Open UI component library**: Components are open to everyone and can be freely accessed, used, and extended. Users can customize and extend them according to their needs to meet different design and functionality requirements. +- **Real-time updates and fixes**: Developers can update and fix the frontend and backend in real time while the system is running, improving the efficiency of development and operation while ensuring the availability and user experience of applications. +- **Open extension center**: An open extension center - KubeSphere Marketplace is provided to encourage third-party developers to add new features or enhance existing ones to the system by extensions. They can develop and integrate their extensions within the system’s framework, seamlessly connect their extensions with the system, and collectively build a healthy and thriving ecosystem. + +### What Can Be Achieved with KubeSphere LuBan + +1. **For KubeSphere users**: KubeSphere users are free to choose and enable extensions. They can also seamlessly integrate their applications into the KubeSphere console. In addition, as the ecosystem of KubeSphere extensions is enriched, users can freely select a variety of products and services from the KubeSphere Marketplace, ultimately achieving a highly customized container management platform. + +2. **For KubeSphere maintainers**: The extension mechanism allows KubeSphere maintainers to pay more attention to the development of KubeSphere Core, make it lighter, and shorten the release cycle. Additionally, since extensions can be iterated independently, user needs can be met more timely. + +3. **For KubeSphere contributors**:The extension mechanism makes KubeSphere Core and other KubeSphere extensions more loosely coupled and easier to develop. + +4. **For ISVs or open-source projects**: Numerous ISVs or open-source projects can seamlessly integrate their products or projects into the KubeSphere ecosystem at a low cost. For example, Karmada/KubeEdge developers can develop a standalone Karmada/KubeEdge console based on KubeSphere LuBan. + +## Overview of KubeSphere v4 + +KubeSphere v4 is the latest cloud-native OS developed by the KubeSphere team, not only inheriting the powerful features of previous versions such as enterprise-level resource and business management and a one-stop cloud-native solution but also easily achieving upstream and downstream linkage of applications, free integration of various extensions, and providing a seamless business capability and highly consistent product experience. + +The core part (KubeSphere Core) contains only the essential functionalities required for system running, while independent business modules are encapsulated in various components (Extensions). + +### New Features + +- Refactor based on the new microkernel architecture of KubeSphere LuBan. +- Introduce the KubeSphere Marketplace as a built-in feature. +- Support for managing extensions through the Extensions Center. +- UI and API can be extended. +- Support for one-click import of member clusters via kubeconfig. +- Support for KubeSphere Service Accounts. +- Support for dynamic extension of the Resource API. +- Support for adding clusters, workspaces, and projects to quick access. +- Enabled file upload and download via container terminal. +- Adapted to cloud-native gateways (Kubernetes Ingress API) from different vendors. +- Support API rate limiting. +- Support creating persistent volumes on the page. +- Support OCI-based Helm Chart repositories. + +Additionally, KubeSphere v4.1.2 has added a default extension repository (see below). + +It also fixed the following issues in KubeSphere v4.1.1: + +- Fixed white screen pages of some extensions. +- Fixed problem of residual resources when uninstalling ks-core. +- Fixed installation failure in K8s 1.19 environments. + +For other changes, please see the changelog: +- https://www.kubesphere.io/docs/v4.1/20-release-notes/release-v411/ +- https://www.kubesphere.io/docs/v4.1/20-release-notes/release-v412/ + +### KubeSphere Extensions + +KubeSphere extensions are used to expand the capabilities of KubeSphere. Users can dynamically install, uninstall, enable, and disable extensions while the system is running. + +Monitoring, alerts, notifications, project and cluster gateways, volume snapshots, network isolation, and other functionalities are provided by extensions. + +Currently, we have open-sourced 20 extensions, including: + +- KubeSphere Network +- KubeSphere App Store Management +- KubeSphere Service Mesh +- KubeSphere Storage +- KubeSphere Multi-Cluster Agent Connection +- KubeSphere Gateway +- DevOps +- Application Management for Cluster Federation +- OpenSearch Distributed Search and Analytics Engine +- Grafana for WhizardTelemetry +- Grafana Loki for WhizardTelemetry +- WhizardTelemetry Data Pipeline +- WhizardTelemetry Platform Service +- WhizardTelemetry Alerting +- WhizardTelemetry Events +- WhizardTelemetry Logging +- WhizardTelemetry Monitoring +- WhizardTelemetry Notification +- Metrics Server +- Gatekeeper + +Extension repository: https://github.com/kubesphere-extensions/ks-extensions/. + +### Installation + +**Attention: Currently, it is not supported to directly upgrade from v3.4.x to v4. You need to uninstall the old version before installing v4.** + +- How to Install KubeSphere: https://www.kubesphere.io/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere/ + +- How to Install Extensions: https://www.kubesphere.io/docs/v4.1/06-extension-user-guide/01-install-components-pdf/ + +To upgrade from v4.1.1 to v4.1.2, run the following command: + +``` +helm upgrade --install -n kubesphere-system --create-namespace ks-core https://charts.kubesphere.io/main/ks-core-1.1.2.tgz --debug --wait +``` + +To quickly start, please refer to: https://kubesphere.io/docs/v4.1/02-quickstart/01-install-kubesphere. + +## Contribution + +As mentioned earlier, the introduction of the extension mechanism makes KubeSphere Core and KubeSphere extensions more loosely coupled and easier to develop. + +The community is gradually releasing open-source extensions, providing more features and more choices. Developers and ISVs are warmly welcomed to participate, develop your own extensions, and enrich the extension ecosystem together. + +We are grateful for the contribution of the student, Zhang Qiming, who has developed an extension, **Pod Status Analysis Tool**, address: https://github.com/kubesphere-extensions/ks-extensions-contrib/tree/main/pod-analyzer. + +- Repository for Contribution: https://github.com/kubesphere-extensions/ks-extensions-contrib + +- Development Guide: https://dev-guide.kubesphere.io/extension-dev-guide/en/ + +## Future Plans + +KubeSphere aims to build a cloud-native distributed operating system with Kubernetes as its core, featuring an architecture that facilitates plug-and-play integration of third-party applications with cloud-native ecological components. This architecture supports the unified distribution, operation, and maintenance management of cloud-native applications across multiple clouds and clusters. + +KubeSphere v4 realizes this vision, truly becoming a product with a pluggable architecture that allows users to select the extensions they need. In the future, we will offer more open-source extensions for users. \ No newline at end of file diff --git a/content/zh/_ks_components/oper-navigate.adoc b/content/zh/_ks_components/oper-navigate.adoc index fc30decdc..3a2c4937f 100644 --- a/content/zh/_ks_components/oper-navigate.adoc +++ b/content/zh/_ks_components/oper-navigate.adoc @@ -1,2 +1,2 @@ // :ks_include_id: b773f29ad54e4ebd84187b0924c41f21 -. 在左侧导航栏选择pass:a,q[{ks_navigation}]。 +. 在左侧导航栏选择pass:a,q[{ks_navigation}]。 \ No newline at end of file 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 daa60bfc3..d43acecd2 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}]权限。有关更多信息，请参阅“集群成员”和“集群角色”。 +您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅“集群成员”和“集群角色”。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/projects/projects-para-containerQuotas.adoc b/content/zh/docs/_custom/clusterManagement/projects/projects-para-containerQuotas.adoc index 52d249e4a..242189198 100644 --- a/content/zh/docs/_custom/clusterManagement/projects/projects-para-containerQuotas.adoc +++ b/content/zh/docs/_custom/clusterManagement/projects/projects-para-containerQuotas.adoc @@ -12,7 +12,7 @@ |允许容器使用的内存资源上限，单位为 MiB。 |GPU 类型 -|对容器上限使用量的 GPU 类型。目前仅支持设置 NVDIA GPU。 +|对容器上限使用量的 GPU 类型。目前仅支持设置 NVIDIA GPU。 |GPU 上限 |允许容器使用的 GPU 数量上限，单位为 GPU。 diff --git a/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-viewAServiceAccountList.adoc b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-viewAServiceAccountList.adoc index b39819e73..1bf5deea5 100644 --- a/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-viewAServiceAccountList.adoc +++ b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-viewAServiceAccountList.adoc @@ -1,2 +1,2 @@ // :ks_include_id: db44d5dd1fb14ca493ad5092790712ab -本节介绍如何查看集群中服务帐户的列表。 +本节介绍如何查看服务帐户的列表。 diff --git a/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-createAServiceAccount_new.adoc b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-createAServiceAccount_new.adoc deleted file mode 100644 index 86d93c26d..000000000 --- a/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-createAServiceAccount_new.adoc +++ /dev/null @@ -1,28 +0,0 @@ -// :ks_include_id: 6e68b7990c884ed4bff37bc5f2891664 -. 在服务帐户列表页面，点击**创建**。 - -. 在**创建服务帐户**对话框，设置服务帐户的信息，然后点击**创建**。 -+ --- -[%header,cols="1,3"] -|=== -|参数 |描述 - -|名称 -|服务帐户名称。同一项目中的服务帐户名称不能重复。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 - -|别名 -|用户自定义的服务帐户别名。不同服务帐户的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 - -|项目 -|服务帐户所属的项目。 - -|描述 -|服务帐户的描述信息。描述可包含任意字符，最长 256 个字符。 - -|项目角色 -|服务帐户在项目中的角色。服务帐户的角色将决定服务帐户在项目中的权限。 -|=== - -服务帐户创建完成后将显示在服务帐户列表中。 --- diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc index 61978797f..92343da9b 100644 --- a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc @@ -1,3 +1,3 @@ // :ks_include_id: 87861bb084774716a738a763e7cb8d5a |添加持久卷声明模板 -|为有状态副本集添加持久卷声明模板。系统将为每个容器组副本单独创建持久卷声明和持久卷，并将持久卷分别挂载到每个容器组副本中的指定容器。仅对有状态副本集可用。 +|为有状态副本集添加持久卷声明模板。系统将为每个容器组副本单独创建持久卷声明和持久卷，并将持久卷分别挂载到每个容器组副本中的指定容器。仅对**有状态副本集**可用。 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 072183001..887f2c2a6 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}]权限。有关更多信息，请参阅“用户”和“平台角色”。 +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅“平台角色”。 \ No newline at end of file diff --git a/content/zh/docs/_custom/projectManagement/apps/apps-oper-viewResourceStatus_v4.adoc b/content/zh/docs/_custom/projectManagement/apps/apps-oper-viewResourceStatus_v4.adoc index 16e89ebd6..3fa813c9d 100644 --- a/content/zh/docs/_custom/projectManagement/apps/apps-oper-viewResourceStatus_v4.adoc +++ b/content/zh/docs/_custom/projectManagement/apps/apps-oper-viewResourceStatus_v4.adoc @@ -1,5 +1,5 @@ // :ks_include_id: c4590bcc1e7e440b8eaf162491107dc0 -. 在应用详情页面左侧的**资源状态**页签查看组成应用的服务和工作负载。 +. 在应用详情页面右侧的**资源状态**页签查看组成应用的服务和工作负载。 * **服务**区域提供以下信息： + diff --git a/content/zh/docs/_custom/projectManagement/projectRoles/projectRoles-para-permissions_v4.adoc b/content/zh/docs/_custom/projectManagement/projectRoles/projectRoles-para-permissions_v4.adoc index 4827eb42c..0cc7cdcf7 100644 --- a/content/zh/docs/_custom/projectManagement/projectRoles/projectRoles-para-permissions_v4.adoc +++ b/content/zh/docs/_custom/projectManagement/projectRoles/projectRoles-para-permissions_v4.adoc @@ -11,7 +11,6 @@ |持久卷声明查看 |查看持久卷声明列表、查看持久卷声明详情。 - |=== -- @@ -39,7 +38,6 @@ |服务帐户查看 |查看服务帐户列表、查看服务帐户详情。 - |=== -- @@ -51,38 +49,10 @@ |权限 |允许操作 |应用负载管理 -| -* 服务管理：创建有状态或无状态服务、创建外部服务、通过现有工作负载创建服务、编辑服务信息、编辑服务设置、编辑服务外部访问设置、删除服务。 - -* 工作负载管理：创建工作负载、编辑工作负载信息、重新创建工作负载、调整容器组副本数量、停止工作负载、回退工作负载设置、编辑工作负载设置、删除工作负载。 - -* 任务管理：创建任务、编辑任务信息、重新运行任务、暂停定时任务、删除任务。 - -* 应用路由管理：创建应用路由、编辑应用路由信息、编辑路由规则、编辑应用路由注解、删除应用路由。 - -* 容器组管理：访问容器终端、删除容器组。 - -// * 灰度发布管理：创建灰度发布任务、切换上线版本（蓝绿部署）、调整流量分配比例（金丝雀发布）、编辑灰度发布任务设置、删除灰度发布任务。 - -// * 镜像构建器管理：使用源代码创建镜像构建器、使用制品创建镜像构建器、编辑镜像构建器信息、运行镜像构建器、删除镜像构建器。 +|管理项目中的应用、服务、工作负载和任务等资源。 |应用负载查看 -| -* 服务查看：查看服务列表、查看服务详情。 - -* 工作负载查看：查看工作负载列表、查看工作负载详情。 - -* 任务查看：查看任务列表、查看任务详情。 - -* 应用路由查看：查看应用路由列表、查看应用路由详情、访问应用路由的后端服务。 - -* 容器组查看：查看容器组列表、查看容器组详情、查看容器详情。 - -// * 灰度发布查看：查看灰度发布任务列表、查看灰度发布任务详情。 - -// * 镜像构建器查看：查看镜像构建器列表、查看镜像构建器详情。 - - +|查看项目中的应用、服务、工作负载和任务等资源。 |=== -- diff --git a/content/zh/docs/_custom/projectManagement/services/services-oper-setStorageAdvanced.adoc b/content/zh/docs/_custom/projectManagement/services/services-oper-setStorageAdvanced.adoc index ddb1973b0..ac49a9b80 100644 --- a/content/zh/docs/_custom/projectManagement/services/services-oper-setStorageAdvanced.adoc +++ b/content/zh/docs/_custom/projectManagement/services/services-oper-setStorageAdvanced.adoc @@ -1,4 +1,6 @@ // :ks_include_id: 046dfe4aa0334cd393ccf4c776cd19f2 . 在**存储设置**页签，为服务后端工作负载管理的容器挂载卷，然后点击**下一步**。 -. 在**高级设置**页签，为服务后端工作负载管理的容器组指定 IP 池和节点，设置服务的外部访问模式、会话保持设置和元数据，然后点击**创建**。服务创建完成后将显示在服务列表中。 +. 在**高级设置**页签，为服务后端工作负载管理的容器组指定 IP 池和节点，设置服务的外部访问模式、会话保持设置和元数据，然后点击**创建**。 ++ +服务创建完成后将显示在服务列表中。 diff --git a/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-desc-viewKubeconfig.adoc b/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-desc-viewKubeconfig.adoc index 3311da9bc..d8e2a03da 100644 --- a/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-desc-viewKubeconfig.adoc +++ b/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-desc-viewKubeconfig.adoc @@ -1,4 +1,4 @@ // :ks_include_id: e29dfe6c970a4e5ca5b2958a5d35c83d -本节介绍如何查看 kubeconfig 文件。 +本节介绍如何查看和下载 kubeconfig 文件。 kubeconfig 文件包含集群的认证信息，用于向其他应用程序提供集群的访问权限。{ks_product_right}支持自动根据当前登录用户生成 kubeconfig 文件，可向其他应用程序提供当前登录用户相同的访问权限。有关更多信息，请参阅 link:https://kubernetes.io/zh/docs/concepts/configuration/organize-cluster-access-kubeconfig/[Kubernetes 官方文档]。 diff --git a/content/zh/docs/v3.3/devops-user-guide/examples/a-maven-project.md b/content/zh/docs/v3.3/devops-user-guide/examples/a-maven-project.md index bfc0bedba..c218dba32 100644 --- a/content/zh/docs/v3.3/devops-user-guide/examples/a-maven-project.md +++ b/content/zh/docs/v3.3/devops-user-guide/examples/a-maven-project.md @@ -9,7 +9,7 @@ weight: 11430 ## 准备工作 - 您需要[启用 KubeSphere DevOps 系统](../../../pluggable-components/devops/)。 -- 您需要有一个 [Docker Hub](http://www.dockerhub.com/) 帐户。 +- 您需要有一个 [Docker Hub](https://hub.docker.com/) 帐户。 - 您需要创建一个企业空间、一个 DevOps 项目和一个用户，并需要邀请该用户至 DevOps 项目中并赋予 `operator` 角色。有关更多信息，请参见[创建企业空间、项目、用户和角色](../../../quick-start/create-workspace-and-project/)。 ## Maven 项目的工作流 diff --git a/content/zh/docs/v3.3/devops-user-guide/how-to-use/pipelines/create-a-pipeline-using-graphical-editing-panel.md b/content/zh/docs/v3.3/devops-user-guide/how-to-use/pipelines/create-a-pipeline-using-graphical-editing-panel.md index 54ea925d7..5624bc9a6 100644 --- a/content/zh/docs/v3.3/devops-user-guide/how-to-use/pipelines/create-a-pipeline-using-graphical-editing-panel.md +++ b/content/zh/docs/v3.3/devops-user-guide/how-to-use/pipelines/create-a-pipeline-using-graphical-editing-panel.md @@ -13,7 +13,7 @@ KubeSphere 中的图形编辑面板包含用于 Jenkins [阶段 (Stage)](https:/ ## 准备工作 - 您需要[启用 KubeSphere DevOps 系统](../../../../pluggable-components/devops/)。 -- 您需要有一个 [Docker Hub](http://www.dockerhub.com/) 帐户。 +- 您需要有一个 [Docker Hub](https://hub.docker.com/) 帐户。 - 您需要创建一个企业空间、一个 DevOps 项目和一个用户 (`project-regular`)，必须邀请该用户至 DevOps 项目中并赋予 `operator` 角色。如果尚未创建，请参见[创建企业空间、项目、用户和角色](../../../../quick-start/create-workspace-and-project/)。 - 设置 CI 专用节点来运行流水线。有关更多信息，请参见[为缓存依赖项设置 CI 节点](../../../../devops-user-guide/how-to-use/devops-settings/set-ci-node/)。 - 配置您的电子邮件服务器用于接收流水线通知（可选）。有关更多信息，请参见[为 KubeSphere 流水线设置电子邮件服务器](../../../../devops-user-guide/how-to-use/pipelines/jenkins-email/)。 diff --git a/content/zh/docs/v3.3/project-user-guide/image-builder/binary-to-image.md b/content/zh/docs/v3.3/project-user-guide/image-builder/binary-to-image.md index 042274ab9..a5cc5e026 100644 --- a/content/zh/docs/v3.3/project-user-guide/image-builder/binary-to-image.md +++ b/content/zh/docs/v3.3/project-user-guide/image-builder/binary-to-image.md @@ -31,7 +31,7 @@ Binary-to-Image (B2I) 是一个工具箱和工作流，用于从二进制可执 ## 准备工作 - 您已启用 [KubeSphere DevOps 系统](../../../pluggable-components/devops/)。 -- 您需要创建一个 [Docker Hub](http://www.dockerhub.com/) 帐户，也支持 GitLab 和 Harbor。 +- 您需要创建一个 [Docker Hub](https://hub.docker.com/) 帐户，也支持 GitLab 和 Harbor。 - 您需要创建一个企业空间、一个项目和一个用户 (`project-regular`)，请务必邀请该用户至项目中并赋予 `operator` 角色。有关更多信息，请参见[创建企业空间、项目、用户和角色](../../../quick-start/create-workspace-and-project/)。 - 设置一个 CI 专用节点用于构建镜像。该操作不是必需，但建议开发和生产环境进行设置，专用节点会缓存依赖项并缩短构建时间。有关更多信息，请参见[为缓存依赖项设置 CI 节点](../../../devops-user-guide/how-to-use/devops-settings/set-ci-node/)。 diff --git a/content/zh/docs/v3.3/project-user-guide/image-builder/source-to-image.md b/content/zh/docs/v3.3/project-user-guide/image-builder/source-to-image.md index 61f0bbffd..74a819d42 100644 --- a/content/zh/docs/v3.3/project-user-guide/image-builder/source-to-image.md +++ b/content/zh/docs/v3.3/project-user-guide/image-builder/source-to-image.md @@ -21,7 +21,7 @@ Source-to-Image (S2I) 是一个工具箱和工作流，用于从源代码构建 ## 准备工作 - 您需要启用 [KubeSphere DevOps 系统](../../../pluggable-components/devops/)，该系统已集成 S2I。 -- 您需要创建一个 [GitHub](https://github.com/) 帐户和一个 [Docker Hub](http://www.dockerhub.com/) 帐户，也支持 GitLab 和 Harbor。本教程使用 Github 仓库提供源代码，用于构建镜像并推送至 Docker Hub。 +- 您需要创建一个 [GitHub](https://github.com/) 帐户和一个 [Docker Hub](https://hub.docker.com/) 帐户，也支持 GitLab 和 Harbor。本教程使用 Github 仓库提供源代码，用于构建镜像并推送至 Docker Hub。 - 您需要创建一个企业空间、一个项目和一个用户 (`project-regular`)，请务必邀请该用户至项目中并赋予 `operator` 角色。有关更多信息，请参见[创建企业空间、项目、用户和角色](../../../quick-start/create-workspace-and-project/)。 - 设置一个 CI 专用节点用于构建镜像。该操作不是必需，但建议开发和生产环境进行设置，专用节点会缓存依赖项并缩短构建时间。有关更多信息，请参见[为缓存依赖项设置 CI 节点](../../../devops-user-guide/how-to-use/devops-settings/set-ci-node/)。 diff --git a/content/zh/docs/v3.4/devops-user-guide/examples/a-maven-project.md b/content/zh/docs/v3.4/devops-user-guide/examples/a-maven-project.md index bfc0bedba..c218dba32 100644 --- a/content/zh/docs/v3.4/devops-user-guide/examples/a-maven-project.md +++ b/content/zh/docs/v3.4/devops-user-guide/examples/a-maven-project.md @@ -9,7 +9,7 @@ weight: 11430 ## 准备工作 - 您需要[启用 KubeSphere DevOps 系统](../../../pluggable-components/devops/)。 -- 您需要有一个 [Docker Hub](http://www.dockerhub.com/) 帐户。 +- 您需要有一个 [Docker Hub](https://hub.docker.com/) 帐户。 - 您需要创建一个企业空间、一个 DevOps 项目和一个用户，并需要邀请该用户至 DevOps 项目中并赋予 `operator` 角色。有关更多信息，请参见[创建企业空间、项目、用户和角色](../../../quick-start/create-workspace-and-project/)。 ## Maven 项目的工作流 diff --git a/content/zh/docs/v3.4/devops-user-guide/how-to-use/pipelines/create-a-pipeline-using-graphical-editing-panel.md b/content/zh/docs/v3.4/devops-user-guide/how-to-use/pipelines/create-a-pipeline-using-graphical-editing-panel.md index f07d5426a..328009789 100644 --- a/content/zh/docs/v3.4/devops-user-guide/how-to-use/pipelines/create-a-pipeline-using-graphical-editing-panel.md +++ b/content/zh/docs/v3.4/devops-user-guide/how-to-use/pipelines/create-a-pipeline-using-graphical-editing-panel.md @@ -13,7 +13,7 @@ KubeSphere 中的图形编辑面板包含用于 Jenkins [阶段 (Stage)](https:/ ## 准备工作 - 您需要[启用 KubeSphere DevOps 系统](../../../../pluggable-components/devops/)。 -- 您需要有一个 [Docker Hub](http://www.dockerhub.com/) 帐户。 +- 您需要有一个 [Docker Hub](https://hub.docker.com/) 帐户。 - 您需要创建一个企业空间、一个 DevOps 项目和一个用户 (`project-regular`)，必须邀请该用户至 DevOps 项目中并赋予 `operator` 角色。如果尚未创建，请参见[创建企业空间、项目、用户和角色](../../../../quick-start/create-workspace-and-project/)。 - 设置 CI 专用节点来运行流水线。有关更多信息，请参见[为缓存依赖项设置 CI 节点](../../../../devops-user-guide/how-to-use/devops-settings/set-ci-node/)。 - 配置您的电子邮件服务器用于接收流水线通知（可选）。有关更多信息，请参见[为 KubeSphere 流水线设置电子邮件服务器](../../../../devops-user-guide/how-to-use/pipelines/jenkins-email/)。 diff --git a/content/zh/docs/v3.4/project-user-guide/image-builder/binary-to-image.md b/content/zh/docs/v3.4/project-user-guide/image-builder/binary-to-image.md index 042274ab9..a5cc5e026 100644 --- a/content/zh/docs/v3.4/project-user-guide/image-builder/binary-to-image.md +++ b/content/zh/docs/v3.4/project-user-guide/image-builder/binary-to-image.md @@ -31,7 +31,7 @@ Binary-to-Image (B2I) 是一个工具箱和工作流，用于从二进制可执 ## 准备工作 - 您已启用 [KubeSphere DevOps 系统](../../../pluggable-components/devops/)。 -- 您需要创建一个 [Docker Hub](http://www.dockerhub.com/) 帐户，也支持 GitLab 和 Harbor。 +- 您需要创建一个 [Docker Hub](https://hub.docker.com/) 帐户，也支持 GitLab 和 Harbor。 - 您需要创建一个企业空间、一个项目和一个用户 (`project-regular`)，请务必邀请该用户至项目中并赋予 `operator` 角色。有关更多信息，请参见[创建企业空间、项目、用户和角色](../../../quick-start/create-workspace-and-project/)。 - 设置一个 CI 专用节点用于构建镜像。该操作不是必需，但建议开发和生产环境进行设置，专用节点会缓存依赖项并缩短构建时间。有关更多信息，请参见[为缓存依赖项设置 CI 节点](../../../devops-user-guide/how-to-use/devops-settings/set-ci-node/)。 diff --git a/content/zh/docs/v3.4/project-user-guide/image-builder/source-to-image.md b/content/zh/docs/v3.4/project-user-guide/image-builder/source-to-image.md index 61f0bbffd..74a819d42 100644 --- a/content/zh/docs/v3.4/project-user-guide/image-builder/source-to-image.md +++ b/content/zh/docs/v3.4/project-user-guide/image-builder/source-to-image.md @@ -21,7 +21,7 @@ Source-to-Image (S2I) 是一个工具箱和工作流，用于从源代码构建 ## 准备工作 - 您需要启用 [KubeSphere DevOps 系统](../../../pluggable-components/devops/)，该系统已集成 S2I。 -- 您需要创建一个 [GitHub](https://github.com/) 帐户和一个 [Docker Hub](http://www.dockerhub.com/) 帐户，也支持 GitLab 和 Harbor。本教程使用 Github 仓库提供源代码，用于构建镜像并推送至 Docker Hub。 +- 您需要创建一个 [GitHub](https://github.com/) 帐户和一个 [Docker Hub](https://hub.docker.com/) 帐户，也支持 GitLab 和 Harbor。本教程使用 Github 仓库提供源代码，用于构建镜像并推送至 Docker Hub。 - 您需要创建一个企业空间、一个项目和一个用户 (`project-regular`)，请务必邀请该用户至项目中并赋予 `operator` 角色。有关更多信息，请参见[创建企业空间、项目、用户和角色](../../../quick-start/create-workspace-and-project/)。 - 设置一个 CI 专用节点用于构建镜像。该操作不是必需，但建议开发和生产环境进行设置，专用节点会缓存依赖项并缩短构建时间。有关更多信息，请参见[为缓存依赖项设置 CI 节点](../../../devops-user-guide/how-to-use/devops-settings/set-ci-node/)。 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 b7ca63c70..afde43911 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: "在 Linux 上安装 Kubernetes 和 KubeSphere" linkTitle: "在 Linux 上安装 Kubernetes 和 KubeSphere" -keywords: "Kubernetes, {ks_product}, 安装, 安装{ks_product_left}, 安装 Kubernetes" -description: "介绍如何在生产环境中安装 Kubernetes 和{ks_product_left}。" +keywords: "Kubernetes, KubeSphere, 安装, 安装 KubeSphere, 安装 Kubernetes" +description: "介绍如何在生产环境中安装 Kubernetes 和 KubeSphere。" weight: 02 --- @@ -27,12 +27,6 @@ weight: 02 * 在生产环境中，为确保集群具有足够的计算和存储资源，建议每台集群节点配置至少 8 个 CPU 核心、16 GB 内存和 200 GB 磁盘空间。除此之外，建议在每台集群节点的 **/var/lib/docker**（对于 Docker）或 **/var/lib/containerd**（对于 containerd） 目录额外挂载至少 200 GB 磁盘空间用于存储容器运行时数据。 -// :relfileprefix: ../../../ - -// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-prer-offlineInstallation.adoc[] - -// :relfileprefix: ./ - * 在生产环境中，建议提前为{ks_product_both}集群配置高可用性以避免单个控制平面节点出现故障时集群服务中断。有关更多信息，请参阅link:../../../03-installation-and-upgrade/01-preparations/03-configure-high-availability/[配置高可用性]。 + -- @@ -389,7 +383,6 @@ helm upgrade --install -n kubesphere-system --create-namespace ks-core https://c include::../../../../_ks_components/admonitions/note.adoc[] - 如果您访问 Docker Hub 受限，请在命令后添加如下配置，修改默认的镜像拉取地址。 [,bash] 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 b26eae7d6..f8add04cf 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,8 +1,8 @@ --- title: "仅卸载 KubeSphere" linkTitle: "仅卸载 KubeSphere" -keywords: "Kubernetes, {ks_product}, 仅卸载{ks_product_left}" -description: "介绍如何卸载{ks_product_left}。" +keywords: "Kubernetes, KubeSphere, 仅卸载 KubeSphere" +description: "介绍如何卸载 KubeSphere。" weight: 01 --- 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 c59af6e7e..c370dc3b7 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, {ks_product}, 卸载 Kubernetes 和{ks_product_left}" -description: "介绍如何卸载 Kubernetes 和{ks_product_left}。" +keywords: "Kubernetes, KubeSphere, 卸载 Kubernetes 和KubeSphere" +description: "介绍如何卸载 Kubernetes 和 KubeSphere。" weight: 02 --- @@ -61,7 +61,7 @@ include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-tra // Bash [,bash] ---- - ./kk delete cluster -f config-sample.yaml +./kk delete cluster -f config-sample.yaml ---- 如果显示如下信息，则表明卸载成功： 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 bebd04eae..aff983624 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 @@ -1,6 +1,8 @@ --- title: "平台介绍" linkTitle: "平台介绍" +keywords: "Kubernetes, KubeSphere, 平台, 模块" +description: "介绍 KubeSphere 平台上各模块的主要功能。" weight: 01 --- diff --git a/content/zh/docs/v4.1/04-platform-management/02-quick-access.adoc b/content/zh/docs/v4.1/04-platform-management/02-quick-access.adoc index 871315a69..b5b7afc76 100644 --- a/content/zh/docs/v4.1/04-platform-management/02-quick-access.adoc +++ b/content/zh/docs/v4.1/04-platform-management/02-quick-access.adoc @@ -1,6 +1,8 @@ --- title: "快捷访问" linkTitle: "快捷访问" +keywords: "Kubernetes, KubeSphere, 快捷访问" +description: "介绍如何添加或移除对资源的快捷访问。" weight: 02 --- diff --git a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc index 20bccc670..f107dd069 100644 --- a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc +++ b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc @@ -1,5 +1,6 @@ --- title: "配置外部身份验证" +linkTitle: "配置外部身份验证" keywords: "Kubernetes, KubeSphere, 第三方认证" description: "了解如何在 KubeSphere 上设置外部身份验证。" weight: 01 @@ -115,7 +116,7 @@ type: config.kubesphere.io/identityprovider + -- - LDAPIdentityProvider - ++ [,yaml] ---- host: 192.168.0.2:389 @@ -128,7 +129,7 @@ mailAttribute: mail - CASIdentityProvider - ++ [,yaml] ---- redirectURL: "https://ks-console:30880/oauth/redirect/cas" @@ -137,7 +138,7 @@ insecureSkipVerify: true ---- - OIDCIdentityProvider - ++ [,yaml] ---- clientID: '********' @@ -147,7 +148,7 @@ redirectURL: 'https://ks-console/oauth/redirect/google' ---- - GitHubIdentityProvider - ++ [,yaml] ---- clientID: '******' 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 index 5ec09ccc8..4478899fc 100644 --- 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 @@ -1,6 +1,10 @@ --- title: "外部身份验证" +linkTitle: "外部身份验证" +keywords: "Kubernetes, KubeSphere, 第三方认证" +description: "在 KubeSphere 上设置外部身份验证。" weight: 03 +layout: "second" --- 本节演示如何在{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 b6c2b131a..aecc99bb7 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 @@ -1,6 +1,8 @@ --- title: "平台设置" linkTitle: "平台设置" +keywords: "Kubernetes, KubeSphere, 平台, 设置, 基本信息" +description: "介绍介绍如何管理 KubeSphere 平台的基本信息。" weight: 03 layout: "second" --- diff --git a/content/zh/docs/v4.1/05-users-and-roles/01-users/10-delete-users.adoc b/content/zh/docs/v4.1/05-users-and-roles/01-users/10-delete-users.adoc index ebfeb5b74..7a4eadccf 100644 --- a/content/zh/docs/v4.1/05-users-and-roles/01-users/10-delete-users.adoc +++ b/content/zh/docs/v4.1/05-users-and-roles/01-users/10-delete-users.adoc @@ -8,7 +8,7 @@ weight: 10 :ks_menu: **用户和角色管理** :ks_navigation: **用户** -:ks_permission: **删除用户** +:ks_permission: **用户管理** 本节介绍如何删除用户。 diff --git a/content/zh/docs/v4.1/06-extension-user-guide/01-install-components-pdf.adoc b/content/zh/docs/v4.1/06-extension-user-guide/01-install-components-pdf.adoc index 31f9276a1..9108d088a 100644 --- a/content/zh/docs/v4.1/06-extension-user-guide/01-install-components-pdf.adoc +++ b/content/zh/docs/v4.1/06-extension-user-guide/01-install-components-pdf.adoc @@ -20,7 +20,7 @@ weight: 01 . 点击**扩展中心**，查看扩展组件列表。 -. 点击未安装的扩展组件右侧的**安装**按钮，进入组件安装页面。 +. 点击未安装的扩展组件名称，进入组件安装页面。 . 在组件安装对话框的**版本选择**页签，选择扩展组件的版本号，并安装好所有必装组件，点击**下一步**。 @@ -38,13 +38,14 @@ 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]图标，查看使用该组件。 +安装完成后，默认启用该组件。您可以在扩展中心配置、升级、禁用、卸载扩展组件。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/04-disable-components.adoc b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/04-disable-components.adoc index 778f4c0bb..5b50a82d3 100644 --- a/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/04-disable-components.adoc +++ b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/04-disable-components.adoc @@ -8,7 +8,7 @@ weight: 04 本节介绍如何禁用扩展组件。 -组件安装完成后，会自动启用。您可以在扩展中心的组件列表或组件详情页中禁用扩展组件。 +组件安装完成后，会自动启用。您可以在扩展中心的组件详情页中禁用扩展组件。 禁用后，再次启用，即可在集群、企业空间、项目中继续使用该组件。 @@ -20,5 +20,6 @@ weight: 04 . 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 . 点击**扩展中心**，进入扩展中心页面。 -. 点击组件右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**禁用**。 -. 禁用后，点击组件右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**启用**即可继续使用该组件。 +. 点击已安装的组件名称，进入组件详情页。 +. 点击组件图标下的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/06-extension-user-guide/03-manage-components/05-uninstall-components.adoc b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/05-uninstall-components.adoc index 02131c392..0a683f1c7 100644 --- a/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/05-uninstall-components.adoc +++ b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/05-uninstall-components.adoc @@ -8,7 +8,7 @@ weight: 05 本节介绍如何卸载扩展组件。 -您可以在扩展中心的组件列表或组件详情页中卸载扩展组件。 +您可以在扩展中心的组件详情页中卸载扩展组件。 对于多集群环境，卸载时会先卸载集群 Agent，再卸载组件。 @@ -20,7 +20,8 @@ weight: 05 . 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 . 点击**扩展中心**，进入扩展中心页面。 -. 点击组件右侧的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/07-cluster-management/01-web-console/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/01-web-console/_index.adoc index 126e8e597..f0999699f 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 @@ -2,7 +2,7 @@ title: "进入集群" linkTitle: "进入集群" keywords: "Kubernetes, KubeSphere, 集群管理, Web 控制台" -description: "介绍如何登录 KubeSphere Web 控制台并进入集群，以及修改用户的邮箱、语言和密码。" +description: "介绍如何登录 KubeSphere Web 控制台并进入集群。" layout: "second" weight: 01 --- diff --git a/content/zh/docs/v4.1/07-cluster-management/02-overview/01-view-cluster-overall-information.adoc b/content/zh/docs/v4.1/07-cluster-management/02-overview/01-view-cluster-overall-information.adoc index 00eb37f40..18f36475d 100644 --- a/content/zh/docs/v4.1/07-cluster-management/02-overview/01-view-cluster-overall-information.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/02-overview/01-view-cluster-overall-information.adoc @@ -15,12 +15,8 @@ weight: 02 == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 . 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群。 @@ -32,13 +28,13 @@ include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermi |=== |功能区 |描述 -|名称、标签和描述 +|名称、标识和描述 | -显示当前集群的名称、标签和描述。 +显示当前集群的名称、标识和描述。 * 成员集群的名称由用户添加成员集群时设置。 -* 集群名称右侧显示当前集群的标签。 +* 集群名称右侧显示当前集群的标识。 |基本信息 |显示当前集群的提供商、Kubernetes 版本、{ks_product_right}版本和对企业空间的可见性。 @@ -48,6 +44,5 @@ include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermi |工具 |显示 kubectl 命令行工具，和 kubeconfig 配置文件。 - |=== -- diff --git a/content/zh/docs/v4.1/07-cluster-management/03-nodes/01-view-a-node-list.adoc b/content/zh/docs/v4.1/07-cluster-management/03-nodes/01-view-a-node-list.adoc index 0cf8fbf80..8346cadb3 100644 --- a/content/zh/docs/v4.1/07-cluster-management/03-nodes/01-view-a-node-list.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/03-nodes/01-view-a-node-list.adoc @@ -14,12 +14,8 @@ weight: 01 == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 include::../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] @@ -40,7 +36,7 @@ include::../../../_custom/clusterManagement/nodes/nodes-oper-openListPage_new.ad |名称 |各节点的主机名称和在子网内部的 IP 地址。 -// 各节点的主机名称由用户安装集群时在安装配置文件 **config-sample.yaml** 中设置。 +各节点的主机名称由用户安装集群时在安装配置文件 **config-sample.yaml** 中设置。 |状态 | diff --git a/content/zh/docs/v4.1/07-cluster-management/03-nodes/02-view-node-details.adoc b/content/zh/docs/v4.1/07-cluster-management/03-nodes/02-view-node-details.adoc index a884fd770..9dd6b7bb9 100644 --- a/content/zh/docs/v4.1/07-cluster-management/03-nodes/02-view-node-details.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/03-nodes/02-view-node-details.adoc @@ -14,13 +14,8 @@ weight: 02 == 前提条件 - -:relfileprefix: ../../../ - include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/03-nodes/03-prevent-and-allow-pod-scheduling.adoc b/content/zh/docs/v4.1/07-cluster-management/03-nodes/03-prevent-and-allow-pod-scheduling.adoc index d279211cc..6c340128d 100644 --- a/content/zh/docs/v4.1/07-cluster-management/03-nodes/03-prevent-and-allow-pod-scheduling.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/03-nodes/03-prevent-and-allow-pod-scheduling.adoc @@ -14,12 +14,8 @@ weight: 03 == 前提条件 -:relfileprefix: ../../../ - 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/03-nodes/04-access-a-node-terminal.adoc b/content/zh/docs/v4.1/07-cluster-management/03-nodes/04-access-a-node-terminal.adoc index e86ff95b9..02902ed3f 100644 --- a/content/zh/docs/v4.1/07-cluster-management/03-nodes/04-access-a-node-terminal.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/03-nodes/04-access-a-node-terminal.adoc @@ -16,12 +16,8 @@ weight: 04 == 前提条件 -:relfileprefix: ../../../ - 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/03-nodes/05-edit-node-taints.adoc b/content/zh/docs/v4.1/07-cluster-management/03-nodes/05-edit-node-taints.adoc index 2f9a62154..26d3bbf17 100644 --- a/content/zh/docs/v4.1/07-cluster-management/03-nodes/05-edit-node-taints.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/03-nodes/05-edit-node-taints.adoc @@ -25,12 +25,8 @@ include::../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 -:relfileprefix: ../../../ - 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/03-nodes/06-edit-node-labels.adoc b/content/zh/docs/v4.1/07-cluster-management/03-nodes/06-edit-node-labels.adoc index 3cbf39c69..922dbda14 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 @@ -16,12 +16,8 @@ weight: 06 == 前提条件 -:relfileprefix: ../../../ - 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/04-projects/01-create-a-project.adoc b/content/zh/docs/v4.1/07-cluster-management/04-projects/01-create-a-project.adoc index b16d9462f..9bc711319 100644 --- a/content/zh/docs/v4.1/07-cluster-management/04-projects/01-create-a-project.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/04-projects/01-create-a-project.adoc @@ -17,12 +17,8 @@ weight: 01 == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 @@ -61,12 +57,6 @@ include::../../../../_ks_components/admonitions/note.adoc[] * 项目被分配到企业空间后不允许变更项目所属的企业空间。 -ifeval::["{file_output_type}" == "html"] * 项目创建完成后，您可以邀请用户加入项目并在项目中部署业务。 -endif::[] - -ifeval::["{file_output_type}" == "pdf"] -* 项目创建完成后，您可以邀请用户加入项目并在项目中部署业务。有关更多信息，请参阅 《{ks_product_right}项目管理指南》。 -endif::[] include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/04-projects/02-view-a-project-list.adoc b/content/zh/docs/v4.1/07-cluster-management/04-projects/02-view-a-project-list.adoc index 82968fe22..a16eb124f 100644 --- a/content/zh/docs/v4.1/07-cluster-management/04-projects/02-view-a-project-list.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/04-projects/02-view-a-project-list.adoc @@ -15,12 +15,8 @@ include::../../../_custom/workspaceManagement/projects/projects-desc-viewProject == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/04-projects/03-view-project-details.adoc b/content/zh/docs/v4.1/07-cluster-management/04-projects/03-view-project-details.adoc index fa2688b28..a1cc010a2 100644 --- a/content/zh/docs/v4.1/07-cluster-management/04-projects/03-view-project-details.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/04-projects/03-view-project-details.adoc @@ -15,12 +15,8 @@ weight: 03 == 前提条件 -:relfileprefix: ../../../ - 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/04-projects/04-edit-project-information.adoc b/content/zh/docs/v4.1/07-cluster-management/04-projects/04-edit-project-information.adoc index 063d0372c..146255a17 100644 --- a/content/zh/docs/v4.1/07-cluster-management/04-projects/04-edit-project-information.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/04-projects/04-edit-project-information.adoc @@ -18,12 +18,8 @@ include::../../../_custom/clusterManagement/projects/projects-note-editInformati == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/04-projects/05-edit-project-annotations.adoc b/content/zh/docs/v4.1/07-cluster-management/04-projects/05-edit-project-annotations.adoc index 122779784..aebf5a168 100644 --- a/content/zh/docs/v4.1/07-cluster-management/04-projects/05-edit-project-annotations.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/04-projects/05-edit-project-annotations.adoc @@ -18,12 +18,8 @@ weight: 05 == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/04-projects/06-edit-project-quotas.adoc b/content/zh/docs/v4.1/07-cluster-management/04-projects/06-edit-project-quotas.adoc index 7fc1912e3..de288b085 100644 --- a/content/zh/docs/v4.1/07-cluster-management/04-projects/06-edit-project-quotas.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/04-projects/06-edit-project-quotas.adoc @@ -16,12 +16,8 @@ include::../../../_custom/clusterManagement/projects/projects-desc-editQuotas.ad == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 @@ -42,4 +38,4 @@ include::../../../_custom/clusterManagement/projects/projects-oper-openDetailsPa + -include::../../../_custom/clusterManagement/projects/projects-oper-editProjectQuotas.adoc[] +include::../../../_custom/clusterManagement/projects/projects-oper-editProjectQuotas.adoc[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/07-cluster-management/04-projects/07-edit-default-container-quotas.adoc b/content/zh/docs/v4.1/07-cluster-management/04-projects/07-edit-default-container-quotas.adoc index 043fdb1fa..a2badb162 100644 --- a/content/zh/docs/v4.1/07-cluster-management/04-projects/07-edit-default-container-quotas.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/04-projects/07-edit-default-container-quotas.adoc @@ -16,12 +16,8 @@ include::../../../_custom/clusterManagement/projects/projects-desc-editDefaultCo == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/04-projects/08-delete-projects.adoc b/content/zh/docs/v4.1/07-cluster-management/04-projects/08-delete-projects.adoc index a6f35e96e..f835b1df2 100644 --- a/content/zh/docs/v4.1/07-cluster-management/04-projects/08-delete-projects.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/04-projects/08-delete-projects.adoc @@ -16,12 +16,8 @@ include::../../../_custom/clusterManagement/projects/projects-desc-deleteProject == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 删除单个项目 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/01-create-a-workload.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/01-create-a-workload.adoc index cbdd992dd..1a79d84fa 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/01-create-a-workload.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/01-create-a-workload.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-createAW == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/02-view-a-workload-list.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/02-view-a-workload-list.adoc index aedcf6f88..f7104ce5a 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/02-view-a-workload-list.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/02-view-a-workload-list.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-viewAWor == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/03-view-workload-details.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/03-view-workload-details.adoc index bd0d1b1f3..60bc3279a 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/03-view-workload-details.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/03-view-workload-details.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-viewWork == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/04-edit-workload-information.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/04-edit-workload-information.adoc index 31c811c2d..269845d9c 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/04-edit-workload-information.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/04-edit-workload-information.adoc @@ -17,12 +17,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-editWork == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/06-adjust-the-number-of-pod-replicas.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/06-adjust-the-number-of-pod-replicas.adoc index 437bc7236..dbf05db96 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/06-adjust-the-number-of-pod-replicas.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/06-adjust-the-number-of-pod-replicas.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-adjustTh == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/07-re-create-a-workload.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/07-re-create-a-workload.adoc index fa6744161..e25c8b4c1 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/07-re-create-a-workload.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/07-re-create-a-workload.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-recreate == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 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 6d7362f5f..dc9cf8e43 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 @@ -15,12 +15,9 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-rollBack == 前提条件 -:relfileprefix: ../../../../ * {empty} include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - include::../../../../_custom/clusterManagement/workloads/workloads-prer-workloadEdited.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/09-edit-auto-scaling-settings.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/09-edit-auto-scaling-settings.adoc index 32198d9fd..b504bee22 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/09-edit-auto-scaling-settings.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/09-edit-auto-scaling-settings.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-editAuto == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/10-edit-workload-settings.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/10-edit-workload-settings.adoc index 1421ee49c..1a7a0f640 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/10-edit-workload-settings.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/10-edit-workload-settings.adoc @@ -17,12 +17,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-editWork == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 @@ -146,22 +142,21 @@ include::../../../../_custom/clusterManagement/workloads/createWorkload/workload // include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-enableLogCollectionCluster.adoc[] -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc[] +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc[] include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] |=== -* 将光标悬停在已添加的卷上，然后在右侧点击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]可删除卷。 +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume_new.adoc[] -- -* 存储 > 添加持久卷声明模板 -+ --- -include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc[] --- +// * 存储 > 添加持久卷声明模板 +// + +// -- +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc[] +// -- * 存储 > 挂载卷 > 持久卷 + diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/11-stop-workloads.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/11-stop-workloads.adoc index 2c20f5a3f..2ec33da09 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/11-stop-workloads.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/11-stop-workloads.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-stopWork == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/12-delete-workloads.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/12-delete-workloads.adoc index 3da33463f..33166d49e 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/12-delete-workloads.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/12-delete-workloads.adoc @@ -2,7 +2,7 @@ title: "删除工作负载" linkTitle: "删除工作负载" keywords: "Kubernetes, KubeSphere, 集群管理, 应用负载, 工作负载, 删除工作负载" -description: "介绍如何删除任务。" +description: "介绍如何删除工作负载。" weight: 12 --- @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-deleteWo == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 删除单个工作负载 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/01-create-a-job.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/01-create-a-job.adoc index 56c2b6282..66e9b4415 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/01-create-a-job.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/01-create-a-job.adoc @@ -17,12 +17,8 @@ include::../../../../_custom/clusterManagement/jobs/jobs-desc-createAJob.adoc[] == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/02-view-a-job-list.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/02-view-a-job-list.adoc index 4c09dac60..be7747307 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/02-view-a-job-list.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/02-view-a-job-list.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/jobs/jobs-desc-viewAJobList.adoc[ == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/03-view-job-details.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/03-view-job-details.adoc index cf3eb08c6..88ece8821 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/03-view-job-details.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/03-view-job-details.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/jobs/jobs-desc-viewJobDetails.ado == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/04-edit-job-information.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/04-edit-job-information.adoc index 1343f50bd..9cc4604b5 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/04-edit-job-information.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/04-edit-job-information.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/jobs/jobs-desc-editJobInformation == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/05-delete-jobs.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/05-delete-jobs.adoc index 3723fabaf..13ce84914 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/05-delete-jobs.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/05-delete-jobs.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/jobs/jobs-desc-deleteJobs.adoc[] == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 删除单个任务 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/06-re-run-a-job.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/06-re-run-a-job.adoc index b115e1847..4d3603f5b 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/06-re-run-a-job.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/06-re-run-a-job.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/jobs/jobs-desc-rerunAJob.adoc[] == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/07-pause-a-cronjob.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/07-pause-a-cronjob.adoc index 5a9e2b9b2..1e0170b05 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/07-pause-a-cronjob.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/07-pause-a-cronjob.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/jobs/jobs-desc-pauseACronjob.adoc == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 @@ -34,4 +30,8 @@ include::../../../../../_ks_components/oper-navigate.adoc[] + +. 在**任务**页面，点击**定时任务**打开定时任务列表。 + ++ + include::../../../../_custom/clusterManagement/jobs/jobs-oper-pauseACronjob.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/01-view-a-pod-list.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/01-view-a-pod-list.adoc index 420112e9f..4960d7f7f 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/01-view-a-pod-list.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/01-view-a-pod-list.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/pods/pods-desc-viewAPodList.adoc[ == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/02-view-pod-details.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/02-view-pod-details.adoc index be77ae332..7e5dc9778 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/02-view-pod-details.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/02-view-pod-details.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/pods/pods-desc-viewPodDetails.ado == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/03-view-container-details.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/03-view-container-details.adoc index 4a0a14ee8..39c2f88ae 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/03-view-container-details.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/03-view-container-details.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/pods/pods-desc-viewContainerDetai == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/04-access-a-container-terminal.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/04-access-a-container-terminal.adoc index c5e4e9918..7f97552fd 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/04-access-a-container-terminal.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/04-access-a-container-terminal.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/pods/pods-desc-accessAContainerTe == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/05-delete-pods.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/05-delete-pods.adoc index 158d4469d..fc82ce464 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/05-delete-pods.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/05-delete-pods.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/pods/pods-desc-deletePods.adoc[] == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 删除单个容器组 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/01-create-a-service.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/01-create-a-service.adoc index ffad77a56..f8ab1c559 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/01-create-a-service.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/01-create-a-service.adoc @@ -17,12 +17,8 @@ include::../../../../_custom/clusterManagement/services/services-desc-createASer == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/02-view-a-service-list.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/02-view-a-service-list.adoc index 67f4cdd76..2bf80eea8 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/02-view-a-service-list.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/02-view-a-service-list.adoc @@ -17,12 +17,8 @@ include::../../../../_custom/clusterManagement/services/services-desc-viewServic -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/03-view-service-details.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/03-view-service-details.adoc index 0395b59c5..7cd05017e 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/03-view-service-details.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/03-view-service-details.adoc @@ -17,12 +17,8 @@ include::../../../../_custom/clusterManagement/services/services-desc-viewServic == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/04-edit-service-information.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/04-edit-service-information.adoc index 2821f8187..5d0b24c2d 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/04-edit-service-information.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/04-edit-service-information.adoc @@ -17,12 +17,8 @@ include::../../../../_custom/clusterManagement/services/services-desc-editServic == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/05-edit-service-settings.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/05-edit-service-settings.adoc index f4a6f23a3..5bbf743f6 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/05-edit-service-settings.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/05-edit-service-settings.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/services/services-desc-editServic == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/06-edit-service-external-access-settings.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/06-edit-service-external-access-settings.adoc index 4ccf149ae..aa1170c85 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/06-edit-service-external-access-settings.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/06-edit-service-external-access-settings.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/services/services-desc-editServic == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/08-delete-services.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/08-delete-services.adoc index 1a60a9c13..dec23bf46 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/08-delete-services.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/08-delete-services.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/services/services-desc-deleteServ == 前提条件 -:relfileprefix: ../../../../ - 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 deleted file mode 100644 index 813055a14..000000000 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/01-create-a-route.adoc +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "创建应用路由" -linkTitle: "创建应用路由" -keywords: "Kubernetes, KubeSphere, 集群管理, 应用负载, 应用路由, 创建应用路由" -description: "介绍如何创建应用路由。" -weight: 01 ---- - -:ks_permission: **应用负载管理** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../_custom/clusterManagement/routes/routes-desc-createARoute.adoc[] - - -== 前提条件 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -* 如需创建支持 HTTPS 协议的应用路由，您需要创建 **TLS 信息**类型的保密字典，保密字典中必须包含 Base64 编码的证书和私钥。有关更多信息，请参阅link:../../../06-configuration/02-configmaps/[创建保密字典]。 - -* 应用路由所属的项目中存在至少一个服务。有关更多信息，请参阅link:../../04-services/01-create-a-service/[创建服务]。 - - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/routes/routes-oper-createARoute_v4.adoc[] - diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/02-view-a-route-list.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/02-view-a-route-list.adoc deleted file mode 100644 index 14b04b2a9..000000000 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/02-view-a-route-list.adoc +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "查看应用路由列表" -linkTitle: "查看应用路由列表" -keywords: "Kubernetes, KubeSphere, 集群管理, 应用负载, 应用路由, 查看应用路由列表" -description: "介绍如何查看应用路由列表。" -weight: 02 ---- - - -:ks_permission: **应用负载查看** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../_custom/clusterManagement/routes/routes-desc-viewARouteList.adoc[] - - -== 前提条件 - - -:relfileprefix: ../../../../ - -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/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/07-cluster-management/05-application-workloads/05-routes/03-view-route-details.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/03-view-route-details.adoc deleted file mode 100644 index f5d1a1e50..000000000 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/03-view-route-details.adoc +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "查看应用路由详情" -linkTitle: "查看应用路由详情" -keywords: "Kubernetes, KubeSphere, 集群管理, 应用负载, 应用路由, 查看应用路由列表" -description: "介绍如何查看应用路由详情。" -weight: 03 ---- - - -:ks_permission: **应用负载查看** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../_custom/clusterManagement/routes/routes-desc-viewRouteDetails.adoc[] - - -== 前提条件 - - -:relfileprefix: ../../../../ - -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/routes/routes-oper-openDetailsPage.adoc[] - -+ - -include::../../../../_custom/clusterManagement/routes/routes-oper-viewRouteDetails.adoc[] 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 deleted file mode 100644 index f32b8e099..000000000 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/04-access-a-backend-service-of-a-route.adoc +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "访问应用路由的后端服务" -linkTitle: "访问应用路由的后端服务" -keywords: "Kubernetes, KubeSphere, 集群管理, 应用负载, 应用路由, 访问应用路由的后端服务" -description: "介绍如何访问应用路由的后端服务。" -weight: 04 ---- - - -:ks_permission: **应用负载查看** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../_custom/clusterManagement/routes/routes-desc-accessABackendServiceOfARoute.adoc[] - - -== 前提条件 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - - -* 您需要启用{ks_product_both}集群网关或项目网关。 - -include::../../../../_custom/clusterManagement/routes/routes-prer-accessABackendServiceOfARoute.adoc[] - - -== 操作步骤 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/routes/routes-oper-openDetailsPage.adoc[] - -+ - -include::../../../../_custom/clusterManagement/routes/routes-oper-accessABackendServiceOfARoute.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/05-edit-route-information.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/05-edit-route-information.adoc deleted file mode 100644 index 40717a2c3..000000000 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/05-edit-route-information.adoc +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "编辑应用路由信息" -linkTitle: "编辑应用路由信息" -keywords: "Kubernetes, KubeSphere, 集群管理, 应用负载, 应用路由, 编辑应用路由信息" -description: "介绍如何编辑应用路由信息。" -weight: 05 ---- - - -:ks_permission: **应用负载管理** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../_custom/clusterManagement/routes/routes-desc-editRouteInformation.adoc[] - - -== 前提条件 - - -:relfileprefix: ../../../../ - -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/routes/routes-oper-editRouteInformation.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/06-edit-routing-rules.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/06-edit-routing-rules.adoc deleted file mode 100644 index e83e26ac5..000000000 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/06-edit-routing-rules.adoc +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "编辑路由规则" -linkTitle: "编辑路由规则" -keywords: "Kubernetes, KubeSphere, 集群管理, 应用负载, 应用路由, 编辑路由规则" -description: "介绍如何编辑路由规则。" -weight: 06 ---- - -:ks_permission: **应用负载管理** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../_custom/clusterManagement/routes/routes-desc-editingRutingRules.adoc[] - - -== 前提条件 - - -:relfileprefix: ../../../../ - -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/routes/routes-oper-editRoutingRules.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/07-edit-route-annotations.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/07-edit-route-annotations.adoc deleted file mode 100644 index a86cb44ab..000000000 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/07-edit-route-annotations.adoc +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "编辑应用路由注解" -linkTitle: "编辑应用路由注解" -keywords: "Kubernetes, KubeSphere, 集群管理, 应用负载, 应用路由, 编辑应用路由注解" -description: "介绍如何编辑应用路由注解。" -weight: 07 ---- - -:ks_permission: **应用负载管理** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../_custom/clusterManagement/routes/routes-desc-editRouteAnnotations.adoc[] - - -== 前提条件 - - -:relfileprefix: ../../../../ - -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/routes/routes-oper-editRouteAnnotations.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/08-delete-routes.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/08-delete-routes.adoc deleted file mode 100644 index f1b6f12bc..000000000 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/08-delete-routes.adoc +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "删除应用路由" -linkTitle: "删除应用路由" -keywords: "Kubernetes, KubeSphere, 集群管理, 应用负载, 应用路由, 删除应用路由" -description: "介绍如何删除应用路由。" -weight: 08 ---- - -:ks_permission: **应用负载管理** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../_custom/clusterManagement/routes/routes-desc-deleteMultipleRoutes.adoc[] - - -== 前提条件 - - -:relfileprefix: ../../../../ - -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/routes/routes-oper-deleteASingleRoute.adoc[] - - -== 批量删除应用路由 - -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/routes/routes-oper-deleteRoutes.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/_index.adoc deleted file mode 100644 index 48ff1e892..000000000 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/_index.adoc +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "应用路由" -linkTitle: "应用路由" -keywords: "Kubernetes, KubeSphere, 集群管理, 应用路由" -description: "介绍如何管理应用路由。" -layout: "second" -weight: 05 ---- - - -include::../../../../_custom/clusterManagement/routes/routes-desc-routes.adoc[] - -// 使用应用路由需要启用企业空间网关、集群网关或项目网关。 - diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/_index.adoc index 83c7ce78a..c74018c90 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/_index.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/_index.adoc @@ -2,11 +2,11 @@ title: "应用负载" linkTitle: "应用负载" keywords: "Kubernetes, KubeSphere, 集群管理, 应用负载" -description: "介绍如何管理工作负载、任务、容器组、服务和应用路由。" +description: "介绍如何管理工作负载、任务、容器组和服务。" layout: "second" weight: 05 --- -本节介绍如何管理工作负载、任务、容器组、服务和应用路由。 +本节介绍如何管理工作负载、任务、容器组和服务。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/01-create-a-secret.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/01-create-a-secret.adoc index c5a842274..a2f3dd736 100644 --- a/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/01-create-a-secret.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/01-create-a-secret.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/secrets/secrets-desc-createASecre == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/02-view-a-secret-list.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/02-view-a-secret-list.adoc index ce7a0152f..6129c7744 100644 --- a/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/02-view-a-secret-list.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/02-view-a-secret-list.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/secrets/secrets-desc-viewASecretL == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/03-view-secret-details.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/03-view-secret-details.adoc index 245179307..5c0b53557 100644 --- a/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/03-view-secret-details.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/03-view-secret-details.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/secrets/secrets-desc-viewSecretDe == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/04-edit-secret-information.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/04-edit-secret-information.adoc index 68e6de868..4c2f0a9c1 100644 --- a/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/04-edit-secret-information.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/04-edit-secret-information.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/secrets/secrets-desc-editSecretIn == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/05-edit-secret-settings.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/05-edit-secret-settings.adoc index a9206dfe2..b4c31d087 100644 --- a/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/05-edit-secret-settings.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/05-edit-secret-settings.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/secrets/secrets-desc-editSecretSe == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/06-delete-secrets.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/06-delete-secrets.adoc index 06e1eb5dc..400090e96 100644 --- a/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/06-delete-secrets.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/06-delete-secrets.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/secrets/secrets-desc-deleteSecret == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 删除单个保密字典 diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/01-create-a-configmap.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/01-create-a-configmap.adoc index 9060b73b6..662a6270d 100644 --- a/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/01-create-a-configmap.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/01-create-a-configmap.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-create == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/02-view-a-configmap-list.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/02-view-a-configmap-list.adoc index 732bc1a20..2dbc55dc1 100644 --- a/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/02-view-a-configmap-list.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/02-view-a-configmap-list.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-viewAC == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/03-view-configmap-details.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/03-view-configmap-details.adoc index ba9a20eb3..f6059a8e2 100644 --- a/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/03-view-configmap-details.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/03-view-configmap-details.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-viewCo == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/04-edit-configmap-information.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/04-edit-configmap-information.adoc index 82e390785..514898492 100644 --- a/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/04-edit-configmap-information.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/04-edit-configmap-information.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-editCo == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/05-edit-configmap-settings.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/05-edit-configmap-settings.adoc index ec645b163..c3478512d 100644 --- a/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/05-edit-configmap-settings.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/05-edit-configmap-settings.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-editCo == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/06-delete-configmaps.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/06-delete-configmaps.adoc index 29ed64625..c260074e2 100644 --- a/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/06-delete-configmaps.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/06-delete-configmaps.adoc @@ -16,12 +16,8 @@ weight: 06 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 删除单个配置字典 diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/01-create-a-service-account.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/01-create-a-service-account.adoc index 65bb45fae..897d0e6e1 100644 --- a/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/01-create-a-service-account.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/01-create-a-service-account.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-d == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/02-view-a-service-account-list.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/02-view-a-service-account-list.adoc index 10c7d575b..e1f19f34c 100644 --- a/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/02-view-a-service-account-list.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/02-view-a-service-account-list.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-d == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/03-view-service-account-details.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/03-view-service-account-details.adoc index 561b0c35b..3f202005f 100644 --- a/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/03-view-service-account-details.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/03-view-service-account-details.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-d == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/04-edit-service-account-information.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/04-edit-service-account-information.adoc index 7daf9aaa1..c747374b7 100644 --- a/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/04-edit-service-account-information.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/04-edit-service-account-information.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-d == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/05-change-the-role-of-a-service-account.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/05-change-the-role-of-a-service-account.adoc index dced338b3..cd209ee6d 100644 --- a/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/05-change-the-role-of-a-service-account.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/05-change-the-role-of-a-service-account.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-d == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/06-delete-service-accounts.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/06-delete-service-accounts.adoc index 11c89e202..a6e5991ab 100644 --- a/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/06-delete-service-accounts.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/06-delete-service-accounts.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-d == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 删除单个服务帐户 diff --git a/content/zh/docs/v4.1/07-cluster-management/07-crds/01-view-a-crd-list.adoc b/content/zh/docs/v4.1/07-cluster-management/07-crds/01-view-a-crd-list.adoc index 778804f75..7a8e412de 100644 --- a/content/zh/docs/v4.1/07-cluster-management/07-crds/01-view-a-crd-list.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/07-crds/01-view-a-crd-list.adoc @@ -16,12 +16,8 @@ weight: 01 == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/07-crds/02-view-crd-details.adoc b/content/zh/docs/v4.1/07-cluster-management/07-crds/02-view-crd-details.adoc index 572956bc9..d20a1dea2 100644 --- a/content/zh/docs/v4.1/07-cluster-management/07-crds/02-view-crd-details.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/07-crds/02-view-crd-details.adoc @@ -16,12 +16,8 @@ weight: 02 == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/07-crds/03-edit-a-custom-resource.adoc b/content/zh/docs/v4.1/07-cluster-management/07-crds/03-edit-a-custom-resource.adoc index 29279cfb1..7a1488e4f 100644 --- a/content/zh/docs/v4.1/07-cluster-management/07-crds/03-edit-a-custom-resource.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/07-crds/03-edit-a-custom-resource.adoc @@ -16,12 +16,8 @@ weight: 03 == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/07-crds/04-delete-a-custom-resource.adoc b/content/zh/docs/v4.1/07-cluster-management/07-crds/04-delete-a-custom-resource.adoc index 414d2d87b..d93463fd0 100644 --- a/content/zh/docs/v4.1/07-cluster-management/07-crds/04-delete-a-custom-resource.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/07-crds/04-delete-a-custom-resource.adoc @@ -26,12 +26,8 @@ weight: 04 == 前提条件 -:relfileprefix: ../../../ - 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/01-create-a-persistent-volume-claim.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/01-create-a-persistent-volume-claim.adoc index 9980e33e0..a67905074 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/01-create-a-persistent-volume-claim.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/01-create-a-persistent-volume-claim.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent == 前提条件 -:relfileprefix: ../../../../ - 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/02-view-a-persistent-volume-claim-list.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/02-view-a-persistent-volume-claim-list.adoc index 0a5207ebf..fb98b7bec 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/02-view-a-persistent-volume-claim-list.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/02-view-a-persistent-volume-claim-list.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/pods/pods-desc-viewAPersistentVol == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 @@ -37,7 +33,7 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent * 在列表左上角的下拉列表中选择一个项目，可以查看特定项目中的持久卷声明。 -* 在列表上方点击搜索框并输入关键字，可按名称和状态搜索持久卷声明。 +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-searchForPersistentVolumeClaims.adoc[] include::../../../../../_ks_components/oper-refreshListData.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/03-view-persistent-volume-claim-details.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/03-view-persistent-volume-claim-details.adoc index 7a0c2b8b8..f28ad8f86 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/03-view-persistent-volume-claim-details.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/03-view-persistent-volume-claim-details.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent == 前提条件 -:relfileprefix: ../../../../ - 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 3ebb3b715..00763b32e 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 @@ -15,12 +15,9 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent == 前提条件 -:relfileprefix: ../../../../ * {empty} include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc[] 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 25873a6e2..d0f371e23 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 @@ -15,12 +15,9 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent == 前提条件 -:relfileprefix: ../../../../ * {empty} include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/08-edit-persistent-volume-claim-information.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/08-edit-persistent-volume-claim-information.adoc index 85c32e6e1..f8b2cd867 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/08-edit-persistent-volume-claim-information.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/08-edit-persistent-volume-claim-information.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent == 前提条件 -:relfileprefix: ../../../../ - 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/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 3755f66d5..32e256a95 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 @@ -15,12 +15,9 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent == 前提条件 -:relfileprefix: ../../../../ * {empty} include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-backData.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/10-view-a-persistent-volume-list.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/10-view-a-persistent-volume-list.adoc index 64060be9d..f05351be1 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/10-view-a-persistent-volume-list.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/10-view-a-persistent-volume-list.adoc @@ -16,12 +16,8 @@ weight: 10 == 前提条件 -:relfileprefix: ../../../../ - 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/11-view-persistent-volume-details.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/11-view-persistent-volume-details.adoc index 2177215f6..245caedb9 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/11-view-persistent-volume-details.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/11-view-persistent-volume-details.adoc @@ -16,12 +16,8 @@ weight: 11 == 前提条件 -:relfileprefix: ../../../../ - 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/12-edit-persistent-volume-information.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/12-edit-persistent-volume-information.adoc index 8210cbd7f..eb731418e 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/12-edit-persistent-volume-information.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/12-edit-persistent-volume-information.adoc @@ -18,12 +18,8 @@ weight: 12 == 前提条件 -:relfileprefix: ../../../../ - 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 ce4abf200..1111b4b82 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 @@ -24,12 +24,9 @@ include::../../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 -:relfileprefix: ../../../../ * {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 750864b6e..a1da30105 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 @@ -15,12 +15,9 @@ weight: 01 == 前提条件 -:relfileprefix: ../../../../ * {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/02-view-a-storage-class-list.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/02-view-a-storage-class-list.adoc index a77c29932..99eab3259 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/02-view-a-storage-class-list.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/02-view-a-storage-class-list.adoc @@ -17,12 +17,8 @@ weight: 02 -:relfileprefix: ../../../../ - 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/03-view-storage-class-details.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/03-view-storage-class-details.adoc index 5efd2e8c9..c9d070589 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/03-view-storage-class-details.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/03-view-storage-class-details.adoc @@ -16,12 +16,8 @@ weight: 03 == 前提条件 -:relfileprefix: ../../../../ - 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/04-set-a-default-storage-class.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/04-set-a-default-storage-class.adoc index 8b74f5b34..e7eaae580 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/04-set-a-default-storage-class.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/04-set-a-default-storage-class.adoc @@ -16,12 +16,8 @@ weight: 04 == 前提条件 -:relfileprefix: ../../../../ - 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 ffa76e783..5486d92d0 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 @@ -24,12 +24,9 @@ include::../../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 -:relfileprefix: ../../../../ * {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/06-edit-storage-class-information.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/06-edit-storage-class-information.adoc index 06b2ae124..f90321184 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/06-edit-storage-class-information.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/06-edit-storage-class-information.adoc @@ -18,12 +18,8 @@ weight: 06 == 前提条件 -:relfileprefix: ../../../../ - 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/07-delete-a-storage-class.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/07-delete-a-storage-class.adoc index 5725c31d8..6483d5071 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/07-delete-a-storage-class.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/07-delete-a-storage-class.adoc @@ -23,12 +23,8 @@ include::../../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 -:relfileprefix: ../../../../ - 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/01-view-cluster-basic-information.adoc b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/01-view-cluster-basic-information.adoc index 92759e0fb..69cf195c6 100644 --- a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/01-view-cluster-basic-information.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/01-view-cluster-basic-information.adoc @@ -15,12 +15,8 @@ weight: 01 == 前提条件 -:relfileprefix: ../../../../ - 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/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 ba1cf4da3..576bf1710 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 @@ -23,12 +23,8 @@ include::../../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/01-view-cluster-visibility.adoc b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/01-view-cluster-visibility.adoc index 4053585a3..37d9818f3 100644 --- a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/01-view-cluster-visibility.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/01-view-cluster-visibility.adoc @@ -16,12 +16,8 @@ weight: 01 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/02-edit-cluster-visibility.adoc b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/02-edit-cluster-visibility.adoc index 0adc1f822..0cb493757 100644 --- a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/02-edit-cluster-visibility.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/02-edit-cluster-visibility.adoc @@ -17,12 +17,8 @@ weight: 02 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/01-invite-a-user-to-a-cluster.adoc b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/01-invite-a-user-to-a-cluster.adoc index 531fdf231..82d135724 100644 --- a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/01-invite-a-user-to-a-cluster.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/01-invite-a-user-to-a-cluster.adoc @@ -16,12 +16,8 @@ weight: 01 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/02-view-a-cluster-member-list.adoc b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/02-view-a-cluster-member-list.adoc index 69ad94ffd..e9169d9e6 100644 --- a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/02-view-a-cluster-member-list.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/02-view-a-cluster-member-list.adoc @@ -16,12 +16,8 @@ weight: 02 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/03-change-the-role-of-a-cluster-member.adoc b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/03-change-the-role-of-a-cluster-member.adoc index 5ab9270d6..e77c3caab 100644 --- a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/03-change-the-role-of-a-cluster-member.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/03-change-the-role-of-a-cluster-member.adoc @@ -16,12 +16,8 @@ weight: 03 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 @@ -34,7 +30,7 @@ include::../../../../../_ks_components/oper-navigate.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/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 077f9ecc1..29a6548b1 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 @@ -23,12 +23,8 @@ include::../../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/01-view-a-cluster-role-list.adoc b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/01-view-a-cluster-role-list.adoc index f6bd7ddca..b77fd35c2 100644 --- a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/01-view-a-cluster-role-list.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/01-view-a-cluster-role-list.adoc @@ -16,12 +16,8 @@ weight: 01 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/02-view-cluster-role-details.adoc b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/02-view-cluster-role-details.adoc index 10f56cc0e..d04c1363a 100644 --- a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/02-view-cluster-role-details.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/02-view-cluster-role-details.adoc @@ -16,12 +16,8 @@ weight: 02 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 @@ -97,7 +93,7 @@ include::../../../../../_ks_components/oper-navigate.adoc[] |参数 |描述 |角色查看 -|查看集群角色列表、查年集群角色详情。 +|查看集群角色列表、查看集群角色详情。 |成员查看 |查看集群成员列表。 @@ -114,40 +110,6 @@ include::../../../../../_ks_components/oper-navigate.adoc[] |=== |权限 |允许操作 -// |项目资源查看 -// | -// * 工作负载查看：查看工作负载列表、查看工作负载详情。 - -// * 任务查看：查看任务列表、查看任务详情。 - -// * 容器组查看：查看容器组列表、查看容器组详情。 - -// * 服务查看：查看服务列表、查看服务详情。 - -// * 应用路由查看：查看应用路由列表、查看应用路由详情、通过{ks_product_left} Web 控制台访问应用路由后端服务。 - -// * 保密字典查看：查看保密字典列表、查看保密字典详情。 - -// * 配置字典查看：查看配置字典列表、查看配置字典详情。 - -// * 服务帐户查看：查看服务帐户列表、查看服务帐户详情。 - -// |项目资源管理 -// | -// * 工作负载管理：创建工作负载、编辑工作负载信息、重新创建工作负载、删除工作负载、调整容器组副本数量、停止工作负载、回退工作负载设置、编辑自动伸缩设置、编辑工作负载设置。 - -// * 任务管理：创建任务、编辑任务信息、删除任务、重新运行任务、停止任务。 - -// * 容器组管理：访问容器终端、删除容器组。 - -// * 服务管理：创建服务、编辑服务信息、编辑服务设置、编辑监控导出器、删除服务。 - -// * 应用路由管理：创建应用路由、编辑应用路由信息、编辑路由规则、编辑应用路由注解、删除应用路由。 - -// * 保密字典管理：创建保密字典、编辑保密字典信息、编辑保密字典设置、删除保密字典。 - -// * 配置字典管理：创建配置字典、编辑配置字典信息、编辑配置字典设置、删除配置字典；创建服务帐户、编辑服务帐户信息、为服务帐户分配角色、删除服务帐户。 - |项目查看 |查看项目列表、查看项目详情。 @@ -195,30 +157,34 @@ include::../../../../../_ks_components/oper-navigate.adoc[] |=== -- -// * 监控告警 -// + -// -- -// [%header,cols="1a,4a"] -// |=== -// |权限 |允许操作 +* 应用负载 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 -// |监控查看 -// |查看集群状态概览、查看物理资源状态、查看 etcd 状态、查看 API 服务器状态、查看调度器监控数据、查看节点资源用量排行、查看自定义监控面板、查看日志接收器列表。 +|应用负载查看 +| +* 工作负载查看：查看工作负载列表、查看工作负载详情。 -// |监控管理 -// |查看资源用量、查看项目资源用量排行、创建自定义监控面板、编辑自定义监控面板信息、编辑自定义监控面板、删除自定义监控面板、添加日志接收器、编辑日志接收器设置、删除日志接收器。 +* 任务查看：查看任务列表、查看任务详情。 -// |规则组查看 -// |查看规则组列表、查看规则组详情。 +* 容器组查看：查看容器组列表、查看容器组详情、查看容器详情。 -// |规则组管理 -// |创建规则组、编辑规则组、删除规则组。 +* 服务查看：查看服务列表、查看服务详情。 -// |告警查看 -// |查看告警列表。 -// |=== -// -- +|应用负载管理 +| +* 工作负载管理：创建工作负载、编辑工作负载信息、重新创建工作负载、调整容器组副本数量、停止工作负载、回退工作负载设置、编辑工作负载设置、删除工作负载。 +* 任务管理：创建任务、编辑任务信息、重新运行任务、暂停定时任务、删除任务。 + +* 容器组管理：访问容器终端、删除容器组。 + +* 服务管理：创建服务、编辑服务信息、编辑服务设置、编辑服务外部访问设置、删除服务。 +|=== +-- ==== . 在集群角色详情页面右侧点击**授权用户**页签，查看具有当前集群角色的用户。 diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/01-add-a-member-cluster-using-direct-connection.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/01-add-a-member-cluster-using-direct-connection.adoc index 1afd24a02..55a0c9c39 100644 --- a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/01-add-a-member-cluster-using-direct-connection.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/01-add-a-member-cluster-using-direct-connection.adoc @@ -1,7 +1,7 @@ --- title: "通过直接连接添加成员集群" linkTitle: "通过直接连接添加成员集群" -keywords: "Kubernetes, KubeSphere, 多集群管理, 集群, 添加成员集群" +keywords: "Kubernetes, {ks_product}, 多集群管理, 集群, 添加成员集群" description: "介绍如何通过直接连接添加成员集群。" weight: 01 --- @@ -19,23 +19,23 @@ weight: 01 == 获取成员集群 kubeconfig -在成员集群的节点上，执行以下命令获取成员集群的 kubeconfig 信息： - +. 在成员集群的节点上，执行以下命令获取成员集群的 kubeconfig 信息： ++ [,bash] ---- kubectl config view --raw ---- - -// Note -include::../../../../../../_ks_components/admonitions/note.adoc[] - -// * 您可以复制 kubeconfig 信息或点击image:/images/ks-qkcp/zh/icons/download-dark.svg[download-dark,18,18]将 **kubeconfig.yaml** 文件下载到本地。 - -请将 kubeconfig 信息中的 **clusters:cluster:server** 参数修改为成员集群的 Kubernetes API 服务的访问地址，默认在成员集群主节点的 6443 端口暴露。请确保主集群的所有节点都能访问该地址，取决于您的网络环境，您可能需要配置防火墙规则和流量转发策略。 - -include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] - +. 复制 kubeconfig 信息，并修改其中的 **clusters:cluster:server** 参数，如下： ++ +-- +[,yaml] +---- +clusters: +- cluster: + server: https://:6443 +---- +-- == 添加成员集群 @@ -51,7 +51,7 @@ include::../../../../../_custom/platformManagement/multiclusterManagement/cluste include::../../../../../_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterBasicInfo.adoc[] + 在**高级设置**下，设置集群的用途标识。 -+ + . 在**连接设置**页签，将**连接方式**设置为**直接连接**，在 **kubeconfig** 区域输入成员集群的 kubeconfig 信息，然后点击**下一步**。 @@ -59,4 +59,4 @@ include::../../../../../_custom/platformManagement/multiclusterManagement/cluste + -- 成员集群添加完成后将显示在**集群管理**页面的集群列表中。 --- +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/02-view-a-cluster-list.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/02-view-a-cluster-list.adoc index 799b92ce7..1f9e44420 100644 --- a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/02-view-a-cluster-list.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/02-view-a-cluster-list.adoc @@ -15,8 +15,7 @@ weight: 02 == 前提条件 -您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 - +include::../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/03-edit-cluster-information.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/03-edit-cluster-information.adoc index 475f1161b..e2beb1786 100644 --- a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/03-edit-cluster-information.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/03-edit-cluster-information.adoc @@ -18,8 +18,7 @@ weight: 03 == 前提条件 -您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 - +include::../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/04-add-cluster-tags.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/04-add-cluster-tags.adoc index c03374ba0..d31b2ef8e 100644 --- a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/04-add-cluster-tags.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/04-add-cluster-tags.adoc @@ -6,7 +6,6 @@ description: "介绍如何添加集群标签。" weight: 04 --- -:ks_menu: **平台管理 > 集群管理** :ks_permission: **集群管理** @@ -18,7 +17,8 @@ weight: 04 == 前提条件 -* 您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 +* {empty} +include::../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] * 您需要提前创建集群标签。有关更多信息，请参阅link:../../02-cluster-tags/01-create-a-cluster-tag/[创建集群标签]。 diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-update-kubeconfig.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-update-kubeconfig.adoc index 4846e84f2..4fe794845 100644 --- a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-update-kubeconfig.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-update-kubeconfig.adoc @@ -13,7 +13,7 @@ weight: 05 本节介绍如何更新成员集群 kubeconfig 信息。 -成员集群添加在主集群的{ks_product_both}平台后，如果成员集群的访问信息发生变化，您需要更新成员集群的 kubeconfig 信息。 +在{ks_product_both}平台添加成员集群后，如果成员集群的访问信息发生变化，您需要更新成员集群的 kubeconfig 信息。 // Note include::../../../../../_ks_components/admonitions/note.adoc[] @@ -25,7 +25,7 @@ include::../../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 -您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 +include::../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/06-remove-a-member-cluster.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/06-remove-a-member-cluster.adoc index 156bf2d1a..84ed1422a 100644 --- a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/06-remove-a-member-cluster.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/06-remove-a-member-cluster.adoc @@ -42,7 +42,7 @@ include::../../../../_custom/platformManagement/multiclusterManagement/clusters/ . 在需要操作的集群右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**移除集群**。 -. 在**移除集群**对话框，确认需要移除的集群的信息，将滑块拖动到右侧，输入需要移除的集群的名称，根据需要选择或取消选择**删除集群中的所有通知配置数据**，然后点击**确定**。 +. 在**移除集群**对话框，确认需要移除的集群的信息，将滑块拖动到右侧，输入需要移除的集群的名称，根据需要选择或取消选择**删除集群中的所有通知配置数据**，然后点击**移除**。 + -- // Note @@ -70,31 +70,18 @@ include::../../../../_custom/platformManagement/extensionManagement/extensionMan + -- // Bash -include::../../../../../_ks_components/code/bash.adoc[] - +[,bash] +---- kubectl delete cluster - ---- -- == 清理多集群配置数据 -. 以具有 **platform-admin** 角色的用户登录被移除集群的 Web 控制台。 - -+ - -include::../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-openKubectl.adoc[] - -+ - -. 在 **kubectl** 对话框，执行以下命令清理集群中的多集群配置数据： -+ --- -// Bash -include::../../../../../_ks_components/code/bash.adoc[] - -for ns in $(kubectl get ns --field-selector status.phase!=Terminating -o jsonpath='{.items[*].metadata.name}'); do kubectl label ns $ns kubesphere.io/workspace- && kubectl patch ns $ns --type merge -p '{"metadata":{"ownerReferences":[]}}'; done +登录被移除的成员集群节点，执行以下命令清理集群中的多集群配置数据： +[,bash] +---- +for ns in $(kubectl get ns --field-selector status.phase!=Terminating -o jsonpath='{.items[*].metadata.name}'); do kubectl label ns $ns kubesphere.io/workspace- && kubectl patch ns $ns --type merge -p '{"metadata":{"ownerReferences":[]}}'; done ---- --- diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/01-create-a-cluster-tag.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/01-create-a-cluster-tag.adoc index 7b897f188..79520fb22 100644 --- a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/01-create-a-cluster-tag.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/01-create-a-cluster-tag.adoc @@ -6,7 +6,6 @@ description: "介绍如何创建集群标签。" weight: 01 --- -:ks_menu: **平台管理 > 集群管理** :ks_permission: **集群管理** @@ -15,7 +14,7 @@ weight: 01 == 前提条件 -您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 +include::../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/02-edit-a-cluster-tag.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/02-edit-a-cluster-tag.adoc index 99926a2b6..55cd1f7aa 100644 --- a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/02-edit-a-cluster-tag.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/02-edit-a-cluster-tag.adoc @@ -6,7 +6,6 @@ description: "介绍如何编辑集群标签。" weight: 02 --- -:ks_menu: **平台管理 > 集群管理** :ks_permission: **集群管理** @@ -15,7 +14,7 @@ weight: 02 == 前提条件 -您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 +include::../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/03-add-a-tag-to-clusters.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/03-add-a-tag-to-clusters.adoc index 62f7ae9f3..0f91e0663 100644 --- a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/03-add-a-tag-to-clusters.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/03-add-a-tag-to-clusters.adoc @@ -6,7 +6,6 @@ description: "介绍如何将标签添加到集群。" weight: 03 --- -:ks_menu: **平台管理 > 集群管理** :ks_permission: **集群管理** @@ -15,7 +14,7 @@ weight: 03 == 前提条件 -您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 +include::../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/04-remove-a-tag-from-clusters.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/04-remove-a-tag-from-clusters.adoc index e6fbded9c..b1c4863ff 100644 --- a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/04-remove-a-tag-from-clusters.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/04-remove-a-tag-from-clusters.adoc @@ -6,7 +6,6 @@ description: "介绍如何从集群上移除标签。" weight: 04 --- -:ks_menu: **平台管理 > 集群管理** :ks_permission: **集群管理** @@ -15,7 +14,7 @@ weight: 04 == 前提条件 -您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 +include::../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] == 操作步骤 diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/05-delete-cluster-tags.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/05-delete-cluster-tags.adoc index 678050c4b..255e4aad2 100644 --- a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/05-delete-cluster-tags.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/05-delete-cluster-tags.adoc @@ -6,7 +6,6 @@ description: "介绍如何删除集群标签。" weight: 05 --- -:ks_menu: **平台管理 > 集群管理** :ks_permission: **集群管理** @@ -22,7 +21,7 @@ include::../../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 -您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 +include::../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] == 删除单个标签 @@ -39,7 +38,7 @@ include::../../../../_custom/platformManagement/multiclusterManagement/clusterTa + -. 在需要从集群上移除的标签右侧点击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/08-workspace-management/01-web-console/_index.adoc b/content/zh/docs/v4.1/08-workspace-management/01-web-console/_index.adoc index c7edde85d..264cbcf66 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 @@ -2,7 +2,7 @@ title: "进入企业空间" linkTitle: "进入企业空间" keywords: "Kubernetes, KubeSphere, 企业空间管理, Web 控制台" -description: "介绍如何登录 KubeSphere Web 控制台并进入企业空间，以及修改用户的邮箱、语言和密码。" +description: "介绍如何登录 KubeSphere Web 控制台并进入企业空间。" layout: "second" weight: 01 --- diff --git a/content/zh/docs/v4.1/08-workspace-management/02-workspaces/01-create-a-workspace.adoc b/content/zh/docs/v4.1/08-workspace-management/02-workspaces/01-create-a-workspace.adoc index 11af24f69..a234137a7 100644 --- a/content/zh/docs/v4.1/08-workspace-management/02-workspaces/01-create-a-workspace.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/02-workspaces/01-create-a-workspace.adoc @@ -6,7 +6,7 @@ description: "介绍如何创建企业空间。" weight: 01 --- -:ks_permission: **企业空间管理** +:ks_permission: **企业空间创建** 本节介绍如何创建企业空间。 @@ -14,11 +14,12 @@ weight: 01 == 前提条件 -您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 +include::../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] == 操作步骤 -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +include::../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] ++ . 点击**企业空间管理**。 . 在页面点击**创建**。 . 在**创建企业空间**页面，设置企业空间的基本信息，然后点击**下一步**。 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 36b3690e4..cff18bf99 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 @@ -13,11 +13,12 @@ weight: 02 == 前提条件 -您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 +include::../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] == 操作步骤 -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +include::../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] ++ . 点击**企业空间管理**。 + -- diff --git a/content/zh/docs/v4.1/08-workspace-management/02-workspaces/03-edit-workspace-information.adoc b/content/zh/docs/v4.1/08-workspace-management/02-workspaces/03-edit-workspace-information.adoc index d8a896ed3..5808a7314 100644 --- a/content/zh/docs/v4.1/08-workspace-management/02-workspaces/03-edit-workspace-information.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/02-workspaces/03-edit-workspace-information.adoc @@ -16,11 +16,12 @@ weight: 03 == 前提条件 -您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 +include::../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] == 操作步骤 -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +include::../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] ++ . 点击**企业空间管理**。 . 在需要操作的企业空间右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 . 在**编辑信息**对话框设置企业空间的别名和描述，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/08-workspace-management/02-workspaces/04-delete-workspaces.adoc b/content/zh/docs/v4.1/08-workspace-management/02-workspaces/04-delete-workspaces.adoc index 8f9af7f58..27a3c3812 100644 --- a/content/zh/docs/v4.1/08-workspace-management/02-workspaces/04-delete-workspaces.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/02-workspaces/04-delete-workspaces.adoc @@ -24,21 +24,24 @@ weight: 04 == 前提条件 -您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 +include::../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] == 删除单个企业空间 -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +include::../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] ++ . 点击**企业空间管理**。 . 在需要操作的企业空间右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 . 在**删除企业空间**对话框，输入企业空间的名称，然后点击**确定**。 == 批量删除企业空间 -. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 + +include::../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] ++ . 点击**企业空间管理**。 -. 选择需要删除的企业空间左侧的复选框，然后在项目列表上方点击**删除**。 +. 选择需要删除的企业空间左侧的复选框，然后在企业空间列表上方点击**删除**。 . 在**批量删除企业空间**对话框，输入企业空间的名称，然后点击**确定**。 + [.admon.note,cols="a"] diff --git a/content/zh/docs/v4.1/08-workspace-management/03-overview/01-view-workspace-resource-usage.adoc b/content/zh/docs/v4.1/08-workspace-management/03-overview/01-view-workspace-resource-usage.adoc index 1318fd5f6..7ab16e386 100644 --- a/content/zh/docs/v4.1/08-workspace-management/03-overview/01-view-workspace-resource-usage.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/03-overview/01-view-workspace-resource-usage.adoc @@ -16,12 +16,8 @@ weight: 01 == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/03-overview/03-view-cluster-resource-usage.adoc b/content/zh/docs/v4.1/08-workspace-management/03-overview/03-view-cluster-resource-usage.adoc index df7232e9f..c978453a6 100644 --- a/content/zh/docs/v4.1/08-workspace-management/03-overview/03-view-cluster-resource-usage.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/03-overview/03-view-cluster-resource-usage.adoc @@ -17,12 +17,8 @@ weight: 03 == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/04-projects/01-create-a-project.adoc b/content/zh/docs/v4.1/08-workspace-management/04-projects/01-create-a-project.adoc index 6b461d5fb..288fcf2c6 100644 --- a/content/zh/docs/v4.1/08-workspace-management/04-projects/01-create-a-project.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/04-projects/01-create-a-project.adoc @@ -16,12 +16,8 @@ weight: 01 == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/04-projects/02-view-a-project-list.adoc b/content/zh/docs/v4.1/08-workspace-management/04-projects/02-view-a-project-list.adoc index e47f019c0..d4e41a04b 100644 --- a/content/zh/docs/v4.1/08-workspace-management/04-projects/02-view-a-project-list.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/04-projects/02-view-a-project-list.adoc @@ -15,12 +15,8 @@ include::../../../_custom/workspaceManagement/projects/projects-desc-viewProject == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/04-projects/03-edit-project-information.adoc b/content/zh/docs/v4.1/08-workspace-management/04-projects/03-edit-project-information.adoc index 81f0b1a42..54508fadc 100644 --- a/content/zh/docs/v4.1/08-workspace-management/04-projects/03-edit-project-information.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/04-projects/03-edit-project-information.adoc @@ -17,12 +17,8 @@ include::../../../_custom/clusterManagement/projects/projects-note-editInformati == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/04-projects/04-edit-project-annotations.adoc b/content/zh/docs/v4.1/08-workspace-management/04-projects/04-edit-project-annotations.adoc index 3a479951b..344a7675d 100644 --- a/content/zh/docs/v4.1/08-workspace-management/04-projects/04-edit-project-annotations.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/04-projects/04-edit-project-annotations.adoc @@ -18,12 +18,8 @@ weight: 04 == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/04-projects/05-edit-project-quotas.adoc b/content/zh/docs/v4.1/08-workspace-management/04-projects/05-edit-project-quotas.adoc index 7c9be23f7..e2c783413 100644 --- a/content/zh/docs/v4.1/08-workspace-management/04-projects/05-edit-project-quotas.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/04-projects/05-edit-project-quotas.adoc @@ -15,12 +15,8 @@ include::../../../_custom/clusterManagement/projects/projects-desc-editQuotas.ad == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/04-projects/06-delete-projects.adoc b/content/zh/docs/v4.1/08-workspace-management/04-projects/06-delete-projects.adoc index 3b23e60bc..aee0d7699 100644 --- a/content/zh/docs/v4.1/08-workspace-management/04-projects/06-delete-projects.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/04-projects/06-delete-projects.adoc @@ -15,12 +15,8 @@ include::../../../_custom/clusterManagement/projects/projects-desc-deleteProject == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 删除单个项目 diff --git a/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/01-add-an-app-repository.adoc b/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/01-add-an-app-repository.adoc index ba1be5258..f877f3c68 100644 --- a/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/01-add-an-app-repository.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/01-add-an-app-repository.adoc @@ -15,12 +15,9 @@ weight: 01 == 前提条件 -:relfileprefix: ../../../../ * {empty} include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - * 已提前创建 Helm Chart 仓库。有关如何创建 Helm Chart 仓库，请参阅 link:https://helm.sh/zh/docs/topics/chart_repository/[Helm 官方文档]。 diff --git a/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/02-view-an-app-repository-list.adoc b/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/02-view-an-app-repository-list.adoc index 782789bae..7261a5026 100644 --- a/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/02-view-an-app-repository-list.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/02-view-an-app-repository-list.adoc @@ -2,7 +2,7 @@ title: "查看应用仓库列表" linkTitle: "查看应用仓库列表" keywords: "Kubernetes, KubeSphere, 企业空间, 应用仓库, 查看应用仓库列表" -description: "介绍如何查看应用模板列表。" +description: "介绍如何查看应用仓库列表。" weight: 02 --- @@ -16,12 +16,8 @@ weight: 02 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] @@ -54,7 +50,6 @@ include::../../../../../_ks_components/oper-navigate.adoc[] |URL |Helm Chart 仓库的 URL。 - |=== -- diff --git a/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/03-edit-an-app-repository.adoc b/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/03-edit-an-app-repository.adoc index 5d56c8f8c..da64cfe36 100644 --- a/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/03-edit-an-app-repository.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/03-edit-an-app-repository.adoc @@ -15,12 +15,8 @@ weight: 03 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/04-sync-an-app-repository-with-a-helm-chart-repository.adoc b/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/04-sync-an-app-repository-with-a-helm-chart-repository.adoc index ad785968d..b5922a71f 100644 --- a/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/04-sync-an-app-repository-with-a-helm-chart-repository.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/04-sync-an-app-repository-with-a-helm-chart-repository.adoc @@ -19,12 +19,8 @@ weight: 04 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/05-delete-an-app-repository.adoc b/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/05-delete-an-app-repository.adoc index c8ca7b761..8c788ee6f 100644 --- a/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/05-delete-an-app-repository.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/05-delete-an-app-repository.adoc @@ -23,12 +23,8 @@ include::../../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/05-app-management/_index.adoc b/content/zh/docs/v4.1/08-workspace-management/05-app-management/_index.adoc index a5b12770c..7d60969cf 100644 --- a/content/zh/docs/v4.1/08-workspace-management/05-app-management/_index.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/05-app-management/_index.adoc @@ -2,7 +2,7 @@ title: "应用管理" linkTitle: "应用管理" keywords: "Kubernetes, KubeSphere, 企业空间, 应用管理" -description: "介绍如何上通过企业空间管理应用模板和应用仓库。" +description: "介绍如何通过企业空间管理应用仓库。" layout: "second" weight: 05 --- diff --git a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/01-view-workspace-basic-information.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/01-view-workspace-basic-information.adoc index 87e4f7910..aa1cb831f 100644 --- a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/01-view-workspace-basic-information.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/01-view-workspace-basic-information.adoc @@ -33,7 +33,7 @@ include::../../../../../_ks_components/oper-navigate.adoc[] |参数 |描述 |企业空间信息 -|当前企业空间的信息，包括企业空间的名称、管理员、创建时间、项目数量、DevOps 项目数量、企业空间成员数量。 +|当前企业空间的信息，包括企业空间的名称、管理员、创建时间、企业空间成员数量。 |网络隔离 |授权给企业空间的集群的网络隔离状态。当授权给企业空间的集群开启网络隔离后，属于该企业空间且运行在该集群中的容器组将不能被企业空间外部的客户端访问，也不能被集群外部的客户端访问。属于该企业空间且运行在该集群中的容器组的出站流量不受限制。 diff --git a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/02-edit-workspace-information.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/02-edit-workspace-information.adoc index 90fe76082..39dbcfe68 100644 --- a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/02-edit-workspace-information.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/02-edit-workspace-information.adoc @@ -18,12 +18,8 @@ weight: 02 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/04-delete-a-workspace.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/04-delete-a-workspace.adoc index c0d0e9d42..25dab6d4f 100644 --- a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/04-delete-a-workspace.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/04-delete-a-workspace.adoc @@ -23,12 +23,8 @@ include::../../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/01-edit-workspace-quotas.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/01-edit-workspace-quotas.adoc index 765cba1bc..45eaddca8 100644 --- a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/01-edit-workspace-quotas.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/01-edit-workspace-quotas.adoc @@ -12,18 +12,14 @@ weight: 01 本节介绍如何编辑企业空间配额。 -在{ks_product_both}平台，多个集群可以授权给同一个企业空间，您可以在企业空间中设置针对每个集群设置资源配额。 +在{ks_product_both}平台，多个集群可以授权给同一个企业空间，您可以在企业空间中针对每个集群设置资源配额。 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/02-view-workspace-quotas.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/02-view-workspace-quotas.adoc index 13acfc7dc..582a73113 100644 --- a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/02-view-workspace-quotas.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/02-view-workspace-quotas.adoc @@ -16,12 +16,8 @@ weight: 02 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/_index.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/_index.adoc index 73c865b77..8aef5c3ae 100644 --- a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/_index.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/_index.adoc @@ -11,7 +11,7 @@ weight: 02 本节介绍如何查看和管理企业空间资源配额。 -在{ks_product_both}平台，多个集群可以授权给同一个企业空间，您可以在企业空间中设置针对每个集群设置资源配额。企业空间配额包括两类设置： +在{ks_product_both}平台，多个集群可以授权给同一个企业空间，您可以在企业空间中针对每个集群设置资源配额。企业空间配额包括两类设置： * 资源预留：容器的资源预留是系统为单个容器预留的资源，企业空间资源预留是企业空间运行在单个集群中所有容器资源预留总和的最大值。{ks_product_right}平台目前支持设置企业空间的 CPU 预留和内存预留。 diff --git a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/01-invite-a-user-to-a-workspace.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/01-invite-a-user-to-a-workspace.adoc index 16e0b14fb..8684458ec 100644 --- a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/01-invite-a-user-to-a-workspace.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/01-invite-a-user-to-a-workspace.adoc @@ -16,12 +16,8 @@ weight: 01 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/02-view-a-workspace-member-list.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/02-view-a-workspace-member-list.adoc index 5b6522537..674d6af3f 100644 --- a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/02-view-a-workspace-member-list.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/02-view-a-workspace-member-list.adoc @@ -16,12 +16,8 @@ weight: 02 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/03-view-workspace-member-details.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/03-view-workspace-member-details.adoc index 33b060fae..0f3c69c74 100644 --- a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/03-view-workspace-member-details.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/03-view-workspace-member-details.adoc @@ -16,12 +16,8 @@ weight: 03 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/04-change-the-role-of-a-workspace-member.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/04-change-the-role-of-a-workspace-member.adoc index 618d0acf6..8edc5c7b3 100644 --- a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/04-change-the-role-of-a-workspace-member.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/04-change-the-role-of-a-workspace-member.adoc @@ -16,12 +16,8 @@ weight: 04 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/05-remove-a-workspace-member.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/05-remove-a-workspace-member.adoc index 82ce7cdfb..540fad0f4 100644 --- a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/05-remove-a-workspace-member.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/05-remove-a-workspace-member.adoc @@ -23,12 +23,8 @@ include::../../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 @@ -43,7 +39,7 @@ 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/08-workspace-management/06-workspace-settings/04-workspace-roles/01-create-a-workspace-role.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/01-create-a-workspace-role.adoc index 8b095052d..c282c39d3 100644 --- a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/01-create-a-workspace-role.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/01-create-a-workspace-role.adoc @@ -16,12 +16,8 @@ weight: 01 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/02-view-a-workspace-role-list.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/02-view-a-workspace-role-list.adoc index 6f2e05ae9..eb7afac9a 100644 --- a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/02-view-a-workspace-role-list.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/02-view-a-workspace-role-list.adoc @@ -18,12 +18,8 @@ weight: 02 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/03-view-workspace-role-details.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/03-view-workspace-role-details.adoc index 6e332f6e2..c7bc6913c 100644 --- a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/03-view-workspace-role-details.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/03-view-workspace-role-details.adoc @@ -16,12 +16,8 @@ weight: 03 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/04-edit-workspace-role-information.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/04-edit-workspace-role-information.adoc index 71c96bb4a..ee5021103 100644 --- a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/04-edit-workspace-role-information.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/04-edit-workspace-role-information.adoc @@ -18,12 +18,8 @@ weight: 04 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/05-edit-permissions-of-a-workspace-role.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/05-edit-permissions-of-a-workspace-role.adoc index 6239435d7..9d7da4c92 100644 --- a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/05-edit-permissions-of-a-workspace-role.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/05-edit-permissions-of-a-workspace-role.adoc @@ -17,12 +17,8 @@ weight: 05 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/06-delete-a-workspace-role.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/06-delete-a-workspace-role.adoc index 0e8de721f..58cfcc4ee 100644 --- a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/06-delete-a-workspace-role.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/06-delete-a-workspace-role.adoc @@ -17,15 +17,9 @@ weight: 06 == 前提条件 - -:relfileprefix: ../../../../ - * {empty} include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] -:relfileprefix: ./ - - * 如果需要删除的企业空间角色已经分配给企业空间成员，您需要删除企业空间成员或修改其角色。 diff --git a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/_index.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/_index.adoc index 89f656c43..75cd7673b 100644 --- a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/_index.adoc +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/_index.adoc @@ -1,8 +1,8 @@ --- title: "企业空间设置" linkTitle: "企业空间设置" -keywords: "KubeSphere, 网络隔离，部门管理，企业空间配额" -description: "介绍如何设置企业空间基本信息、修改企业空间配额以及管理部门。" +keywords: "KubeSphere, Kubernetes, 企业空间配额" +description: "介绍如何设置企业空间基本信息、修改企业空间配额，以及管理企业空间角色和成员。" layout: "second" weight: 06 --- 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 3a1b7e700..12f475f3d 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 @@ -2,11 +2,11 @@ title: "进入项目" linkTitle: "进入项目" keywords: "Kubernetes, KubeSphere, 项目管理, Web 控制台" -description: "介绍如何登录 KubeSphere Web 控制台并进入项目，以及修改用户的邮箱、语言和密码。" +description: "介绍如何登录 KubeSphere Web 控制台并进入项目。" layout: "second" weight: 01 --- -本节介绍如何登录{ks_product_left} Web 控制台并进入项目。 +本节介绍如何登录{ks_product_left} Web 控制台并进入项目。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/09-project-management/02-overview/01-view-project-overall-information.adoc b/content/zh/docs/v4.1/09-project-management/02-overview/01-view-project-overall-information.adoc index 9d42b066f..b73b0da75 100644 --- a/content/zh/docs/v4.1/09-project-management/02-overview/01-view-project-overall-information.adoc +++ b/content/zh/docs/v4.1/09-project-management/02-overview/01-view-project-overall-information.adoc @@ -16,12 +16,8 @@ weight: 01 == 前提条件 -:relfileprefix: ../../../ - include::../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/01-install-an-app-from-the-app-store.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/01-install-an-app-from-the-app-store.adoc index 562868b7d..d23cf301d 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/01-install-an-app-from-the-app-store.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/01-install-an-app-from-the-app-store.adoc @@ -1,8 +1,8 @@ --- title: "从应用商店安装应用" linkTitle: "从应用商店安装应用" -keywords: "Kubernetes, KubeSphere, 项目管理, 应用, 查看项目概览信息" -description: "介绍如何查看项目概览信息。" +keywords: "Kubernetes, KubeSphere, 项目管理, 应用" +description: "介绍如何从应用商店安装应用。" weight: 01 --- @@ -16,12 +16,8 @@ weight: 01 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/02-install-an-app-using-an-app-template.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/02-install-an-app-using-an-app-template.adoc index a8773f90e..1c3e03922 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/02-install-an-app-using-an-app-template.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/02-install-an-app-using-an-app-template.adoc @@ -19,18 +19,14 @@ weight: 02 |说明 | -若要使用企业空间的应用模板，需要安装并启用“应用商店”扩展组件。安装后，企业空间的**应用管理**菜单下将显示**应用模板**选项。然后由具有相关权限的企业空间成员创建企业空间的应用模板。 +若要使用企业空间的应用模板，需要安装并启用“应用商店管理”扩展组件。安装后，企业空间的**应用管理**菜单下将显示**应用模板**选项。然后由具有相关权限的企业空间成员创建企业空间的应用模板。 |=== == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 @@ -51,6 +47,11 @@ include::../../../../../_ks_components/oper-clickCreate.adoc[] . 在**应用模板**页面，点击**当前企业空间**下拉列表，选择**当前企业空间**或一个应用仓库。 . 点击需要使用的应用模板，然后点击**安装**。 + ++ + +include::../../../../_custom/projectManagement/apps/apps-oper-installApp.adoc[] + + -- // Note @@ -58,18 +59,7 @@ 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/09-project-management/03-application-workloads/01-apps/04-view-an-app-list.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/04-view-an-app-list.adoc index 1acbd636c..77e3d07d1 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/04-view-an-app-list.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/04-view-an-app-list.adoc @@ -16,12 +16,8 @@ weight: 04 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 @@ -31,9 +27,6 @@ include::../../../../_custom/projectManagement/projectManagement-oper-openProjec include::../../../../../_ks_components/oper-navigate.adoc[] -+ - -. 在**应用**页面，点击**基于模板的应用**打开应用列表。 + ==== * 应用列表提供以下信息： diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/05-view-template-based-app-details.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/05-view-template-based-app-details.adoc index 30f788b3e..a84045fa0 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/05-view-template-based-app-details.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/05-view-template-based-app-details.adoc @@ -16,12 +16,8 @@ weight: 05 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/06-edit-app-information.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/06-edit-app-information.adoc index c70fe5b8c..c30ea72be 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/06-edit-app-information.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/06-edit-app-information.adoc @@ -19,12 +19,8 @@ weight: 06 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/08-edit-app-settings.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/08-edit-app-settings.adoc index a45620c23..529ed2fd3 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/08-edit-app-settings.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/08-edit-app-settings.adoc @@ -18,12 +18,8 @@ weight: 08 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/10-delete-apps.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/10-delete-apps.adoc index b4351371d..0ede4c550 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/10-delete-apps.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/10-delete-apps.adoc @@ -15,12 +15,8 @@ weight: 10 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 删除单个应用 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/01-create-a-stateful-or-stateless-service.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/01-create-a-stateful-or-stateless-service.adoc index 52b165583..647e8a0b3 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/01-create-a-stateful-or-stateless-service.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/01-create-a-stateful-or-stateless-service.adoc @@ -15,13 +15,8 @@ weight: 01 == 前提条件 - -:relfileprefix: ../../../../../ - include::../../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/02-create-an-external-service.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/02-create-an-external-service.adoc index 5cd0a7182..90dbcee53 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/02-create-an-external-service.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/02-create-an-external-service.adoc @@ -17,13 +17,8 @@ weight: 02 == 前提条件 - -:relfileprefix: ../../../../../ - include::../../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/05-create-a-service-using-existing-workloads.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/05-create-a-service-using-existing-workloads.adoc index 000553cc4..d2c1ff4b4 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/05-create-a-service-using-existing-workloads.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/05-create-a-service-using-existing-workloads.adoc @@ -16,12 +16,9 @@ weight: 05 == 前提条件 -:relfileprefix: ../../../../../ * {empty} include::../../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - * 您需要提前在项目创建工作负载。有关更多信息，请参阅link:../../../03-workloads/01-create-a-workload/[创建工作负载]。 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/04-view-service-details.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/04-view-service-details.adoc index c95bc3bfc..67bf06f05 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/04-view-service-details.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/04-view-service-details.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/services/services-desc-viewServic == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/05-edit-service-information.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/05-edit-service-information.adoc index 1dbf50543..c7324de65 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/05-edit-service-information.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/05-edit-service-information.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/services/services-desc-editServic == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/06-edit-service-settings.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/06-edit-service-settings.adoc index 96ffd796c..4416051a0 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/06-edit-service-settings.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/06-edit-service-settings.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/services/services-desc-editServic == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/07-edit-service-external-access-settings.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/07-edit-service-external-access-settings.adoc index 066b5c64a..7578a03f4 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/07-edit-service-external-access-settings.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/07-edit-service-external-access-settings.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/services/services-desc-editServic == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/09-delete-services.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/09-delete-services.adoc index 3c2d234f8..056557373 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/09-delete-services.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/09-delete-services.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/services/services-desc-deleteServ == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 删除单个服务 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/01-create-a-workload.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/01-create-a-workload.adoc index ee2c2484a..1182b628d 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/01-create-a-workload.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/01-create-a-workload.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-createAW == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/02-view-a-workload-list.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/02-view-a-workload-list.adoc index 85bde1e73..eecb4e38d 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/02-view-a-workload-list.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/02-view-a-workload-list.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-viewAWor == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/03-view-workload-details.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/03-view-workload-details.adoc index ae8441f38..8f88b8731 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/03-view-workload-details.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/03-view-workload-details.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-viewWork == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/04-edit-workload-information.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/04-edit-workload-information.adoc index a22ae4e2a..bf0c40d4c 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/04-edit-workload-information.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/04-edit-workload-information.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-editWork == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/05-re-create-a-workload.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/05-re-create-a-workload.adoc index 625c667d4..13b08e54f 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/05-re-create-a-workload.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/05-re-create-a-workload.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-recreate == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/06-adjust-the-number-of-pod-replicas.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/06-adjust-the-number-of-pod-replicas.adoc index ed009430d..2d7455e8a 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/06-adjust-the-number-of-pod-replicas.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/06-adjust-the-number-of-pod-replicas.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-adjustTh == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/07-stop-workloads.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/07-stop-workloads.adoc index 006639ac8..8a49c6084 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/07-stop-workloads.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/07-stop-workloads.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-stopWork == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/08-roll-back-workload-settings.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/08-roll-back-workload-settings.adoc index ee3aca1a2..f6e6c2bad 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/08-roll-back-workload-settings.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/08-roll-back-workload-settings.adoc @@ -15,13 +15,9 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-rollBack == 前提条件 - -:relfileprefix: ../../../../ * {empty} include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - include::../../../../_custom/clusterManagement/workloads/workloads-prer-workloadEdited.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/10-edit-workload-settings.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/10-edit-workload-settings.adoc index 410ce2ee0..7c19ba3e5 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/10-edit-workload-settings.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/10-edit-workload-settings.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-editWork == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 @@ -101,6 +97,12 @@ include::../../../../_custom/clusterManagement/workloads/createWorkload/workload include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] -- +* 容器 > 容器设置 > 生命周期管理 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] +-- + * 容器 > 容器设置 > 启动命令 + -- @@ -138,8 +140,6 @@ include::../../../../_custom/clusterManagement/workloads/createWorkload/workload // 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[] diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/11-delete-workloads.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/11-delete-workloads.adoc index eaf374153..c709c1f00 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/11-delete-workloads.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/11-delete-workloads.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-deleteWo == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 删除单个工作负载 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/01-create-a-job.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/01-create-a-job.adoc index e4cf9c776..4f3660da6 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/01-create-a-job.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/01-create-a-job.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/jobs/jobs-desc-createAJob.adoc[] == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/02-view-a-job-list.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/02-view-a-job-list.adoc index 4952a1465..455835a4e 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/02-view-a-job-list.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/02-view-a-job-list.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/jobs/jobs-desc-viewAJobList.adoc[ == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/03-view-job-details.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/03-view-job-details.adoc index e396b39da..ce457ce12 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/03-view-job-details.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/03-view-job-details.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/jobs/jobs-desc-viewJobDetails.ado == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/04-edit-job-information.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/04-edit-job-information.adoc index 54cb4cfb9..47089aa64 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/04-edit-job-information.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/04-edit-job-information.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/jobs/jobs-desc-editJobInformation == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/05-rerun-a-job.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/05-rerun-a-job.adoc index 5c3d8d418..fcebe9021 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/05-rerun-a-job.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/05-rerun-a-job.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/jobs/jobs-desc-rerunAJob.adoc[] == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/06-pause-a-cronjob.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/06-pause-a-cronjob.adoc index 777daa7c3..efe5f1cf9 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/06-pause-a-cronjob.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/06-pause-a-cronjob.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/jobs/jobs-desc-pauseACronjob.adoc == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/07-delete-jobs.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/07-delete-jobs.adoc index 9daf376be..6e537c44e 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/07-delete-jobs.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/07-delete-jobs.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/jobs/jobs-desc-deleteJobs.adoc[] == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 删除单个任务 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/01-create-a-route.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/01-create-a-route.adoc deleted file mode 100644 index 79e790ca2..000000000 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/01-create-a-route.adoc +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "创建应用路由" -linkTitle: "创建应用路由" -keywords: "Kubernetes, KubeSphere, 项目管理, 应用负载, 应用路由, 创建应用路由" -description: "介绍如何创建应用路由。" -weight: 01 ---- - -:ks_permission: **应用负载管理** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../_custom/clusterManagement/routes/routes-desc-createARoute.adoc[] - - -== 前提条件 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* 如需创建支持 HTTPS 协议的应用路由，您需要创建 **TLS 信息**类型的保密字典，保密字典中必须包含 Base64 编码的证书和私钥。有关更多信息，请参阅link:../../../05-configuration/01-secrets/01-create-a-secret/[创建保密字典]。 - -* 应用路由所属的项目中存在至少一个服务。有关更多信息，请参阅link:../../02-services/01-create-a-service/01-create-a-stateful-or-stateless-service/[创建服务]。 - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../../_ks_components/oper-clickCreate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/routes/routes-oper-createARoute_v4.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/02-view-a-route-list.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/02-view-a-route-list.adoc deleted file mode 100644 index 0b8d617e7..000000000 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/02-view-a-route-list.adoc +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "查看应用路由列表" -linkTitle: "查看应用路由列表" -keywords: "Kubernetes, KubeSphere, 项目管理, 应用负载, 应用路由, 查看应用路由列表" -description: "介绍如何查看应用路由列表。" -weight: 02 ---- - -:ks_permission: **应用负载查看** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../_custom/clusterManagement/routes/routes-desc-viewARouteList.adoc[] - - -== 前提条件 - - -: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-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/09-project-management/03-application-workloads/05-routes/03-view-route-details.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/03-view-route-details.adoc deleted file mode 100644 index a2b9209c6..000000000 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/03-view-route-details.adoc +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "查看应用路由详情" -linkTitle: "查看应用路由详情" -keywords: "Kubernetes, KubeSphere, 项目管理, 应用负载, 应用路由, 查看应用路由详情" -description: "介绍如何查看应用路由详情。" -weight: 03 ---- - -:ks_permission: **应用负载查看** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../_custom/clusterManagement/routes/routes-desc-viewRouteDetails.adoc[] - - -== 前提条件 - - -: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-openDetailsPage.adoc[] - -+ - -include::../../../../_custom/clusterManagement/routes/routes-oper-viewRouteDetails.adoc[] 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 deleted file mode 100644 index 74bf44907..000000000 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/04-access-a-backend-service-of-a-route.adoc +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "访问应用路由的后端服务" -linkTitle: "访问应用路由的后端服务" -keywords: "Kubernetes, KubeSphere, 项目管理, 应用负载, 应用路由, 访问应用路由的后端服务" -description: "介绍如何访问应用路由的后端服务。" -weight: 04 ---- - -:ks_permission: **应用负载查看** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../_custom/clusterManagement/routes/routes-desc-accessABackendServiceOfARoute.adoc[] - - -== 前提条件 - -:relfileprefix: ../../../../ -* {empty} -include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] - -:relfileprefix: ./ - -* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件，然后启用集群网关或项目网关。 -// 有关更多信息，请参阅 link:../../../../11-use-extensions/12-gateway[KubeSphere 网关]。 - -include::../../../../_custom/clusterManagement/routes/routes-prer-accessABackendServiceOfARoute.adoc[] - - -== 操作步骤 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/routes/routes-oper-openDetailsPage.adoc[] - -+ - -include::../../../../_custom/clusterManagement/routes/routes-oper-accessABackendServiceOfARoute.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/05-edit-route-information.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/05-edit-route-information.adoc deleted file mode 100644 index 419f76f33..000000000 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/05-edit-route-information.adoc +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "编辑应用路由信息" -linkTitle: "编辑应用路由信息" -keywords: "Kubernetes, KubeSphere, 项目管理, 应用负载, 应用路由, 编辑应用路由信息" -description: "介绍如何编辑应用路由信息。" -weight: 05 ---- - -:ks_permission: **应用负载管理** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../_custom/clusterManagement/routes/routes-desc-editRouteInformation.adoc[] - - -== 前提条件 - - -: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-editRouteInformation.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/06-edit-routing-rules.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/06-edit-routing-rules.adoc deleted file mode 100644 index cb3e0ad5a..000000000 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/06-edit-routing-rules.adoc +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "编辑路由规则" -linkTitle: "编辑路由规则" -keywords: "Kubernetes, KubeSphere, 项目管理, 应用负载, 应用路由, 编辑路由规则" -description: "介绍如何编辑路由规则。" -weight: 06 ---- - -:ks_permission: **应用负载管理** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../_custom/clusterManagement/routes/routes-desc-editingRutingRules.adoc[] - - -== 前提条件 - - -: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-editRoutingRules.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/07-edit-route-annotations.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/07-edit-route-annotations.adoc deleted file mode 100644 index f5d4984d2..000000000 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/07-edit-route-annotations.adoc +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "编辑应用路由注解" -linkTitle: "编辑应用路由注解" -keywords: "Kubernetes, KubeSphere, 项目管理, 应用负载, 应用路由, 编辑应用路由注解" -description: "介绍如何应用路由注解。" -weight: 07 ---- - -:ks_permission: **应用负载管理** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../_custom/clusterManagement/routes/routes-desc-editRouteAnnotations.adoc[] - - -== 前提条件 - - -: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-editRouteAnnotations.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/08-delete-routes.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/08-delete-routes.adoc deleted file mode 100644 index de3e4faef..000000000 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/08-delete-routes.adoc +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "删除应用路由" -linkTitle: "删除应用路由" -keywords: "Kubernetes, KubeSphere, 项目管理, 应用负载, 应用路由, 删除应用路由" -description: "介绍如何删除应用路由。" -weight: 08 ---- - -:ks_permission: **应用负载管理** -:ks_navigation: **应用负载 > 应用路由** - - -include::../../../../_custom/clusterManagement/routes/routes-desc-deleteMultipleRoutes.adoc[] - - -== 前提条件 - - -: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-deleteASingleRoute.adoc[] - - -== 批量删除应用路由 - -include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] - -+ - -include::../../../../../_ks_components/oper-navigate.adoc[] - -+ - -include::../../../../_custom/clusterManagement/routes/routes-oper-deleteRoutes.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/_index.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/_index.adoc deleted file mode 100644 index e0fb641a6..000000000 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/_index.adoc +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "应用路由" -linkTitle: "应用路由" -keywords: "Kubernetes, KubeSphere, 项目管理, 应用负载, 应用路由" -description: "介绍如何管理应用路由。" -layout: "second" -weight: 05 ---- - - - -include::../../../../_custom/clusterManagement/routes/routes-desc-routes.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/01-view-a-pod-list.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/01-view-a-pod-list.adoc index 6f19aa517..3f3f3a5df 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/01-view-a-pod-list.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/01-view-a-pod-list.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/pods/pods-desc-viewAPodList.adoc[ == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/02-view-pod-details.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/02-view-pod-details.adoc index 93a93d906..11ba7fce6 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/02-view-pod-details.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/02-view-pod-details.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/pods/pods-desc-viewPodDetails.ado == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/03-view-container-details.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/03-view-container-details.adoc index ae2080c55..9cb7310b3 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/03-view-container-details.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/03-view-container-details.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/pods/pods-desc-viewContainerDetai == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/04-access-a-container-terminal.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/04-access-a-container-terminal.adoc index 5efce0e8e..52f694f56 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/04-access-a-container-terminal.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/04-access-a-container-terminal.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/pods/pods-desc-accessAContainerTe == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/05-delete-pods.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/05-delete-pods.adoc index 6e003e982..a8e6c554e 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/05-delete-pods.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/05-delete-pods.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/pods/pods-desc-deletePods.adoc[] == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 删除单个容器组 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/_index.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/_index.adoc index df6739807..88caf5935 100644 --- a/content/zh/docs/v4.1/09-project-management/03-application-workloads/_index.adoc +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/_index.adoc @@ -8,4 +8,4 @@ weight: 03 --- -本节介绍如何管理应用、服务、工作负载、任务、应用路由和容器组。 +本节介绍如何管理应用、服务、工作负载、任务和容器组。 diff --git a/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/01-create-a-persistent-volume-claim.adoc b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/01-create-a-persistent-volume-claim.adoc index b968c3c73..dbbb5bc2f 100644 --- a/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/01-create-a-persistent-volume-claim.adoc +++ b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/01-create-a-persistent-volume-claim.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/02-view-a-persistent-volume-claim-list.adoc b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/02-view-a-persistent-volume-claim-list.adoc index 700569a80..a6a657b25 100644 --- a/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/02-view-a-persistent-volume-claim-list.adoc +++ b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/02-view-a-persistent-volume-claim-list.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/pods/pods-desc-viewAPersistentVol == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/03-view-persistent-volume-claim-details.adoc b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/03-view-persistent-volume-claim-details.adoc index 87613ded4..be238f870 100644 --- a/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/03-view-persistent-volume-claim-details.adoc +++ b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/03-view-persistent-volume-claim-details.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/04-clone-a-persistent-volume.adoc b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/04-clone-a-persistent-volume.adoc index 26252b615..822ad7c3e 100644 --- a/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/04-clone-a-persistent-volume.adoc +++ b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/04-clone-a-persistent-volume.adoc @@ -15,11 +15,9 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent == 前提条件 -:relfileprefix: ../../../../ * {empty} include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.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 415fec3e7..a11afd721 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 @@ -7,7 +7,7 @@ weight: 06 --- :ks_permission: **持久卷声明管理** -:ks_navigation: **存储 > 扩展持久卷** +:ks_navigation: **存储 > 持久卷声明** include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-expandAPersistentVolumeClaim.adoc[] @@ -15,13 +15,9 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent == 前提条件 - -:relfileprefix: ../../../../ * {empty} include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/07-edit-persistent-volume-claim-information.adoc b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/07-edit-persistent-volume-claim-information.adoc index fdb754895..4cc597c62 100644 --- a/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/07-edit-persistent-volume-claim-information.adoc +++ b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/07-edit-persistent-volume-claim-information.adoc @@ -7,7 +7,7 @@ weight: 07 --- :ks_permission: **持久卷声明管理** -:ks_navigation: **存储 > 扩展持久卷** +:ks_navigation: **存储 > 持久卷声明** include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-editPersistentVolumeClaimInformation.adoc[] @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/08-delete-persistent-volume-claims.adoc b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/08-delete-persistent-volume-claims.adoc index 3d6edb6f8..2b29fc55e 100644 --- a/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/08-delete-persistent-volume-claims.adoc +++ b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/08-delete-persistent-volume-claims.adoc @@ -7,7 +7,7 @@ weight: 08 --- :ks_permission: **持久卷声明管理** -:ks_navigation: **存储 > 扩展持久卷** +:ks_navigation: **存储 > 持久卷声明** include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-deletePersistentVolumeClaims.adoc[] @@ -15,13 +15,9 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent == 前提条件 - -:relfileprefix: ../../../../ * {empty} include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-backData.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/01-create-a-secret.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/01-create-a-secret.adoc index 7377fd2db..48ccec8c8 100644 --- a/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/01-create-a-secret.adoc +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/01-create-a-secret.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/secrets/secrets-desc-createASecre == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/02-view-a-secret-list.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/02-view-a-secret-list.adoc index e6b007e16..bb4b9ee8d 100644 --- a/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/02-view-a-secret-list.adoc +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/02-view-a-secret-list.adoc @@ -7,7 +7,7 @@ weight: 02 --- :ks_permission: **保密字典查看** -:ks_navigation: **存储 > 保密字典** +:ks_navigation: **配置 > 保密字典** include::../../../../_custom/clusterManagement/secrets/secrets-desc-viewASecretList.adoc[] @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/secrets/secrets-desc-viewASecretL == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/03-view-secret-details.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/03-view-secret-details.adoc index 2a85f80c2..56935572a 100644 --- a/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/03-view-secret-details.adoc +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/03-view-secret-details.adoc @@ -7,7 +7,7 @@ weight: 03 --- :ks_permission: **保密字典查看** -:ks_navigation: **存储 > 保密字典** +:ks_navigation: **配置 > 保密字典** include::../../../../_custom/clusterManagement/secrets/secrets-desc-viewSecretDetails.adoc[] @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/secrets/secrets-desc-viewSecretDe == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/04-edit-secret-information.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/04-edit-secret-information.adoc index d571c953c..dad839c40 100644 --- a/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/04-edit-secret-information.adoc +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/04-edit-secret-information.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/secrets/secrets-desc-editSecretIn == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/05-edit-secret-settings.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/05-edit-secret-settings.adoc index 30334eccc..66dced462 100644 --- a/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/05-edit-secret-settings.adoc +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/05-edit-secret-settings.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/secrets/secrets-desc-editSecretSe == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/06-delete-secrets.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/06-delete-secrets.adoc index 38670f089..d64fbcd11 100644 --- a/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/06-delete-secrets.adoc +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/06-delete-secrets.adoc @@ -16,17 +16,13 @@ include::../../../../_custom/clusterManagement/secrets/secrets-desc-deleteSecret == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 删除单个保密字典 -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + @@ -39,7 +35,7 @@ include::../../../../_custom/clusterManagement/secrets/secrets-oper-deleteASingl == 批量删除保密字典 -include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/01-create-a-configmap.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/01-create-a-configmap.adoc index eb78e981a..37cb8db6d 100644 --- a/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/01-create-a-configmap.adoc +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/01-create-a-configmap.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-create == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/02-view-a-configmap-list.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/02-view-a-configmap-list.adoc index 86bcef87e..3cd07d151 100644 --- a/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/02-view-a-configmap-list.adoc +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/02-view-a-configmap-list.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-viewAC == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/03-view-configmap-details.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/03-view-configmap-details.adoc index f3312d4f7..ba8599ae9 100644 --- a/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/03-view-configmap-details.adoc +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/03-view-configmap-details.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-viewCo == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/04-edit-configmap-information.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/04-edit-configmap-information.adoc index 9bb904075..3f13ffd19 100644 --- a/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/04-edit-configmap-information.adoc +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/04-edit-configmap-information.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-editCo == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/05-edit-configmap-settings.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/05-edit-configmap-settings.adoc index ff3fa9013..950e14a35 100644 --- a/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/05-edit-configmap-settings.adoc +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/05-edit-configmap-settings.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-editCo == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/06-delete-configmaps.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/06-delete-configmaps.adoc index 2ece93658..b0db2fdc1 100644 --- a/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/06-delete-configmaps.adoc +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/06-delete-configmaps.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-delete == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 删除单个配置字典 diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/01-create-a-service-account.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/01-create-a-service-account.adoc index 7751e17a6..9d12aea9e 100644 --- a/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/01-create-a-service-account.adoc +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/01-create-a-service-account.adoc @@ -7,7 +7,7 @@ weight: 01 --- :ks_permission: **服务帐户管理** -:ks_navigation: **存储 > 服务帐户** +:ks_navigation: **配置 > 服务帐户** include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-createAServiceAccount.adoc[] @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-d == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 @@ -34,4 +30,4 @@ include::../../../../../_ks_components/oper-navigate.adoc[] + -include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-createAServiceAccount_new.adoc[] +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-createAServiceAccount.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/02-view-a-service-account-list.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/02-view-a-service-account-list.adoc index a2cd7d026..bac1750b4 100644 --- a/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/02-view-a-service-account-list.adoc +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/02-view-a-service-account-list.adoc @@ -7,7 +7,7 @@ weight: 02 --- :ks_permission: **服务帐户查看** -:ks_navigation: **存储 > 服务帐户** +:ks_navigation: **配置 > 服务帐户** include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-viewAServiceAccountList.adoc[] @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-d == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/03-view-service-account-details.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/03-view-service-account-details.adoc index 42531a19d..d21be4b3c 100644 --- a/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/03-view-service-account-details.adoc +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/03-view-service-account-details.adoc @@ -7,7 +7,7 @@ weight: 03 --- :ks_permission: **服务帐户查看** -:ks_navigation: **存储 > 服务帐户** +:ks_navigation: **配置 > 服务帐户** include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-viewServiceAccountDetails.adoc[] @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-d == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/04-edit-service-account-information.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/04-edit-service-account-information.adoc index 7f3f7585e..1014d9a9b 100644 --- a/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/04-edit-service-account-information.adoc +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/04-edit-service-account-information.adoc @@ -7,7 +7,7 @@ weight: 04 --- :ks_permission: **服务帐户管理** -:ks_navigation: **存储 > 服务帐户** +:ks_navigation: **配置 > 服务帐户** include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-editServiceAccountInformation.adoc[] @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-d == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/05-change-the-role-of-a-service-account.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/05-change-the-role-of-a-service-account.adoc index c44b5b5a8..14f3de292 100644 --- a/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/05-change-the-role-of-a-service-account.adoc +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/05-change-the-role-of-a-service-account.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-d == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/06-delete-service-accounts.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/06-delete-service-accounts.adoc index 5898b39e5..d205a3b55 100644 --- a/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/06-delete-service-accounts.adoc +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/06-delete-service-accounts.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-d == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 删除单个服务帐户 diff --git a/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/01-view-project-basic-information.adoc b/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/01-view-project-basic-information.adoc index c53d93f52..834db427b 100644 --- a/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/01-view-project-basic-information.adoc +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/01-view-project-basic-information.adoc @@ -16,12 +16,8 @@ weight: 01 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/02-edit-project-information.adoc b/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/02-edit-project-information.adoc index 7e1a5abcc..bb29254a8 100644 --- a/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/02-edit-project-information.adoc +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/02-edit-project-information.adoc @@ -18,12 +18,8 @@ weight: 02 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/03-edit-project-quotas.adoc b/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/03-edit-project-quotas.adoc index b398b71e7..94723b0e8 100644 --- a/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/03-edit-project-quotas.adoc +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/03-edit-project-quotas.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/projects/projects-desc-editQuotas == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/04-edit-default-container-quotas.adoc b/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/04-edit-default-container-quotas.adoc index 954cd06d8..089d69522 100644 --- a/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/04-edit-default-container-quotas.adoc +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/04-edit-default-container-quotas.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/projects/projects-desc-editDefaul == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/05-delete-a-project.adoc b/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/05-delete-a-project.adoc index 200987c28..c59263a7c 100644 --- a/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/05-delete-a-project.adoc +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/05-delete-a-project.adoc @@ -16,12 +16,8 @@ include::../../../../_custom/clusterManagement/projects/projects-desc-deleteProj == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/01-create-a-project-role.adoc b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/01-create-a-project-role.adoc index f523f9ea0..0ccb79da1 100644 --- a/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/01-create-a-project-role.adoc +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/01-create-a-project-role.adoc @@ -16,12 +16,8 @@ weight: 01 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/02-view-a-project-role-list.adoc b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/02-view-a-project-role-list.adoc index 4ae5ae7de..c840dd8c4 100644 --- a/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/02-view-a-project-role-list.adoc +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/02-view-a-project-role-list.adoc @@ -16,12 +16,8 @@ weight: 02 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/03-view-project-role-details.adoc b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/03-view-project-role-details.adoc index 0f1f013b3..c52a7a5ba 100644 --- a/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/03-view-project-role-details.adoc +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/03-view-project-role-details.adoc @@ -16,12 +16,8 @@ weight: 03 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/04-edit-project-role-information.adoc b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/04-edit-project-role-information.adoc index 1de793354..41374c4cc 100644 --- a/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/04-edit-project-role-information.adoc +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/04-edit-project-role-information.adoc @@ -18,12 +18,8 @@ weight: 04 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/05-edit-permissions-of-a-project-role.adoc b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/05-edit-permissions-of-a-project-role.adoc index 25e385446..3e0bd0dc8 100644 --- a/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/05-edit-permissions-of-a-project-role.adoc +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/05-edit-permissions-of-a-project-role.adoc @@ -17,12 +17,8 @@ weight: 05 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/06-delete-a-project-role.adoc b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/06-delete-a-project-role.adoc index e668e785d..6b16cb1f8 100644 --- a/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/06-delete-a-project-role.adoc +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/06-delete-a-project-role.adoc @@ -17,12 +17,9 @@ weight: 06 == 前提条件 -:relfileprefix: ../../../../ * {empty} include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - * 如果需要删除的项目角色已经分配给项目成员，您需要删除项目成员或修改其角色。 diff --git a/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/_index.adoc b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/_index.adoc index c6647a840..4482566a8 100644 --- a/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/_index.adoc +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/_index.adoc @@ -10,7 +10,7 @@ weight: 02 本节介绍如何管理项目角色。 -每个企业空间角色都包含特定的项目管理或查看权限。您可以将包含特定权限的角色授予项目成员，以控制项目成员在项目中的权限。 +每个项目角色都包含特定的项目管理或查看权限。您可以将包含特定权限的角色授予项目成员，以控制项目成员在项目中的权限。 // Note include::../../../../../_ks_components/admonitions/note.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/01-invite-a-user-to-a-project.adoc b/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/01-invite-a-user-to-a-project.adoc index 6f7bb6f19..25f6f051e 100644 --- a/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/01-invite-a-user-to-a-project.adoc +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/01-invite-a-user-to-a-project.adoc @@ -15,12 +15,9 @@ weight: 01 == 前提条件 -:relfileprefix: ../../../../ * {empty} include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - * 被邀请的的用户需要先加入项目所属的企业空间。 diff --git a/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/02-view-a-project-member-list.adoc b/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/02-view-a-project-member-list.adoc index ab993bfed..57cd34446 100644 --- a/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/02-view-a-project-member-list.adoc +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/02-view-a-project-member-list.adoc @@ -16,12 +16,8 @@ weight: 02 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 @@ -50,7 +46,7 @@ include::../../../../../_ks_components/oper-navigate.adoc[] include::../../../../_custom/clusterManagement/clusterMembers/clusterMembers-para-userStatus.adoc[] |角色 -|项目成员在集群中的角色。 +|项目成员在项目中的角色。 |最近登录 |项目成员最近一次登录{ks_product_left} Web 控制台的时间。 diff --git a/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/03-change-the-role-of-a-project-member.adoc b/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/03-change-the-role-of-a-project-member.adoc index 62ac9a926..32935556f 100644 --- a/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/03-change-the-role-of-a-project-member.adoc +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/03-change-the-role-of-a-project-member.adoc @@ -6,7 +6,7 @@ description: "介绍如何修改项目成员的角色。" weight: 03 --- -:ks_permission: **成员查看** +:ks_permission: **成员管理** :ks_navigation: **项目设置 > 项目成员** @@ -16,12 +16,8 @@ weight: 03 == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 diff --git a/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/04-remove-a-project-member.adoc b/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/04-remove-a-project-member.adoc index 84b017c8e..3dd82d7c3 100644 --- a/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/04-remove-a-project-member.adoc +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/04-remove-a-project-member.adoc @@ -23,12 +23,8 @@ include::../../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 -:relfileprefix: ../../../../ - include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] -:relfileprefix: ./ - == 操作步骤 @@ -43,7 +39,7 @@ 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/09-project-management/_index.adoc b/content/zh/docs/v4.1/09-project-management/_index.adoc index 211edb2b4..42a0e4c1a 100644 --- a/content/zh/docs/v4.1/09-project-management/_index.adoc +++ b/content/zh/docs/v4.1/09-project-management/_index.adoc @@ -2,7 +2,7 @@ title: "项目管理" linkTitle: "项目管理" keywords: "Kubernetes, KubeSphere, 项目管理" -description: "介绍如何管理项目，以及如何在项目中管理应用负载、存储资源、配置资源、灰度发布任务、镜像构建器、监控告警和项目设置。" +description: "介绍如何管理项目，以及如何在项目中管理应用负载、存储资源、配置资源和项目设置。" layout: "second" weight: 09 icon: "/images/docs/common/docs.svg" diff --git a/content/zh/docs/v4.1/10-toolbox/01-use-kubectl-tool.adoc b/content/zh/docs/v4.1/10-toolbox/01-use-kubectl-tool.adoc index 530681d99..d348f49c2 100644 --- a/content/zh/docs/v4.1/10-toolbox/01-use-kubectl-tool.adoc +++ b/content/zh/docs/v4.1/10-toolbox/01-use-kubectl-tool.adoc @@ -35,6 +35,7 @@ kubectl get pods -A . 在终端窗口中使用以下语法运行 kubectl 命令： + +-- [,bash] ---- kubectl [command] [TYPE] [NAME] [flags] @@ -48,5 +49,8 @@ include::../../../_ks_components/admonitions/note.adoc[] ** TYPE：指定link:https://kubernetes.io/zh-cn/docs/reference/kubectl/#resource-types[资源类型]。资源类型不区分大小写，您可以指定单数、复数或缩写形式。 ** NAME：指定资源的名称。名称区分大小写。如果省略名称，则会显示所有资源的详细信息，例如 `kubectl get pods`。 ** flags：指定可选的参数。例如，您可以使用 -s 或 --server 参数指定 Kubernetes API 服务器的地址和端口。 + * 如果您需要帮助，请在终端窗口运行 `kubectl help` 或者参阅 link:https://kubernetes.io/zh/docs/reference/kubectl/overview/[Kubernetes Kubectl 文档]。 + include::../../../_ks_components/admonitions/admonEnd.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/10-toolbox/02-view-a-kubeconfig-file.adoc b/content/zh/docs/v4.1/10-toolbox/02-view-a-kubeconfig-file.adoc index 7f93f8770..3794e9a66 100644 --- a/content/zh/docs/v4.1/10-toolbox/02-view-a-kubeconfig-file.adoc +++ b/content/zh/docs/v4.1/10-toolbox/02-view-a-kubeconfig-file.adoc @@ -1,8 +1,8 @@ --- -title: "查看 kubeconfig 文件" -linkTitle: "查看 kubeconfig 文件" +title: "查看和下载 kubeconfig 文件" +linkTitle: "查看和下载 kubeconfig 文件" keywords: "Kubernetes, KubeSphere, 项目管理, 工具箱, 查看 kubeconfig 文件" -description: "介绍如何查看 kubeconfig 文件。" +description: "介绍如何查看和下载 kubeconfig 文件。" weight: 02 --- diff --git a/content/zh/news/kubesphere-v4-ga-announcement.md b/content/zh/news/kubesphere-v4-ga-announcement.md new file mode 100644 index 000000000..c6b2aac2b --- /dev/null +++ b/content/zh/news/kubesphere-v4-ga-announcement.md @@ -0,0 +1,168 @@ +--- +title: 'KubeSphere v4 开源并发布全新可插拔架构 LuBan' +tag: '产品动态' +keyword: '社区, 开源, KubeSphere, KubeSphere LuBan, release, 可插拔架构, 扩展组件' +description: 'KubeSphere v4 是基于全新的云原生可扩展开放架构——KubeSphere LuBan 打造的云原生操作系统。' +createTime: '2024-10-10' +author: 'KubeSphere' +image: 'https://pek3b.qingstor.com/kubesphere-community/images/ks-v4-ga-cover.png' +--- + +2024 年 10 月 10 日，KubeSphere 开源社区激动地向大家宣布，KubeSphere v4（开源版）已正式发布，同时发布全新可插拔架构 KubeSphere LuBan。 + +相较于 KubeSphere 之前所有的版本，KubeSphere v4 可以说是有了颠覆性的变化。KubeSphere v4 是基于全新的云原生可扩展开放架构——KubeSphere LuBan 打造的云原生操作系统，对于 KubeSphere 而言具有非凡的意义。 + +## KubeSphere LuBan + +### 什么是 KubeSphere LuBan + +鲁班（LuBan），是中国古代工匠的始祖。作为广大劳动人民智慧与创造力的象征，他通过工具提高劳动效率，将劳动者从原始繁重的任务中解放出来，使土木工艺呈现崭新面貌。KubeSphere 将全新微内核架构（KubeSphere Core）命名为 LuBan，借此寓意，期待为企业与开发者提供低成本、快速迭代和灵活集成的云原生产品，并带来专业、全能和极富创造力的使用与开发体验。 + +KubeSphere LuBan，是一个分布式的云原生可扩展开放架构，为扩展组件提供一个可热插拔的微内核。自此，KubeSphere 所有功能组件及第三方组件都会基于 KubeSphere LuBan，以扩展组件的方式无缝融入到 KubeSphere 控制台中，并独立维护版本，真正实现即插即用的应用级云原生操作系统。 + +KubeSphere LuBan 架构设计如下图所示。 + +![](https://kubesphere.io/images/ks-qkcp/zh/v4.0/4.0-architecture.png) + +### 为什么推出 KubeSphere LuBan + +自 2018 年以来，KubeSphere 混合多云容器管理平台已发布过十几个版本，其中包括三个重大版本。为了满足用户需求，KubeSphere 集成了众多企业级功能，如多租户管理，多集群管理，DevOps，GitOps，服务网格，微服务，可观测（包括监控、告警、日志、审计、事件、通知等），应用商店，边缘计算，网络与存储管理等。 + +虽然 KubeSphere 的一站式容器解决方案极大地提升了用户的容器使用体验，但也带来了如下挑战： + +- **发版周期长**：在发布新版本时，需要等待所有组件完成开发、测试并通过集成测试。 + +- **响应用户不及时**：由于各组件无法单独迭代，KubeSphere 发布后，对社区和用户组件反馈处理需要等待 KubeSphere 发布新版本后才能一并交付给用户，导致响应不够及时。 + +- **代码耦合**：尽管目前已能实现单独启用/禁用特定组件，但这些组件的前后端代码仍然耦合在一起，容易互相影响，架构上不够优雅。 + +- **系统资源占用过多**：部分组件默认启用，对于没有相关需求的用户来说，可能会占用过多的系统资源。 + +### KubeSphere LuBan 的优势有哪些 + +- **插件式的核心框架**：支持独立开发和部署组件以扩展系统的功能。组件可以根据需求进行添加、升级或移除，而不需要修改核心框架的代码。 + +- **全开放的基础 UI 组件库**：组件对所有人开放，任何人都可以自由地访问、使用和扩展这些组件。用户根据自己的需求进行定制和扩展，以满足不同的设计和功能要求。 + +- **前后端热更新、热修复**：开发者可以在系统运行时对前端和后端进行实时更新和修复，提高了开发和运维的效率，同时保证了应用程序的可用性和用户体验。 + +- **开放性扩展中心，生态共建**：我们提供一个开放的平台，鼓励第三方开发者通过组件向系统添加新的功能或增强现有功能，在系统的框架内进行开发和集成，并将他们的组件与系统进行无缝连接，共同构建一个健康、繁荣的生态系统。 + +### 基于 KubeSphere LuBan 可以做什么 + +1. KubeSphere 用户 + +KubeSphere 用户可以自由选择启用哪些 KubeSphere 扩展组件。同时还能将自己的应用无缝融入到 KubeSphere 控制台。此外，随着 KubeSphere 扩展组件生态的丰富，用户可以在 KubeSphere 扩展市场中自由选择更丰富的产品和服务，最终实现容器管理平台的千人千面的效果。 + +2. KubeSphere 维护者 + +扩展机制使得维护者可以更聚焦 KubeSphere 核心功能的开发，并可使得 KubeSphere Core 更加轻量，版本发布节奏也可以加快。此外，因为扩展组件能够独立进行迭代，能够更及时地满足用户的需求。 + +3. KubeSphere 贡献者 + +扩展机制的引入使得 KubeSphere Core 及 KubeSphere 其他扩展组件变得更加松耦合，开发也更加易于上手。 + +4. 云原生应用开发商（ISV）或其他开源项目 + +众多 ISV 或其他开源项目可以低成本将产品或开源项目无缝融入到 KubeSphere 生态系统中。比如 Karmada/KubeEdge 的开发人员可以基于 KubeSphere LuBan 开发独立的 Karmada/KubeEdge 控制台。 + +## KubeSphere v4 简介 + +KubeSphere v4，是 KubeSphere 团队打造的全新云原生操作系统，不仅继承了之前版本的企业级资源与业务管理、一站式云原生解决方案等强大功能，还能轻松实现应用的上下游联动、随时随地集成各类优质扩展组件，并提供无缝融合的业务能力与高度一致的产品体验。 + +其中内核部分（KubeSphere Core）仅包含系统运行的必备基础功能，而将独立的业务模块分别封装在各个扩展组件（Extensions）中。 + +### 新特性 + +* 基于全新微内核架构 KubeSphere LuBan 重构 +* 内置 KubeSphere 扩展市场 +* 支持通过扩展中心统一管理扩展组件 +* 支持 UI、API 扩展 +* 支持通过 kubeconfig 一键导入 member 集群 +* 支持 KubeSphere 服务帐户 +* 支持动态扩展 Resource API +* 支持添加集群、企业空间、项目到快捷访问 +* 支持通过容器终端进行文件上传和下载 +* 支持适配不同厂商的云原生网关（Kubernetes Ingress API） +* 支持 API 限流 +* 支持在页面创建持久卷 +* 支持基于 OCI 的 Helm Chart 仓库 + +另外，KubeSphere 4.1.2 增加了默认的扩展组件仓库（见下文）。 + +同时修复了 KubeSphere 4.1.1 存在的以下问题： + +- 部分扩展组件页面白屏的问题 +- ks-core 卸载时部分资源残留的问题 +- K8s 1.19 环境无法安装的问题 + +其他变化请查看变更说明： +- https://www.kubesphere.io/zh/docs/v4.1/20-release-notes/release-v411/ +- https://www.kubesphere.io/zh/docs/v4.1/20-release-notes/release-v412/ + +### KubeSphere 扩展组件 + +KubeSphere 扩展组件用于扩展 KubeSphere 的平台能力，用户可在系统运行时动态地安装、卸载、启用、禁用扩展组件。 + +监控、告警、通知、项目网关和集群网关、卷快照、网络隔离等功能，将由扩展组件来提供。 + +目前，我们已经开源了 20 个扩展组件，分别是： + +* KubeSphere 网络 +* KubeSphere 应用商店管理 +* KubeSphere 服务网格 +* KubeSphere 存储 +* KubeSphere 多集群代理连接 +* KubeSphere 网关 +* DevOps +* 联邦集群应用管理 +* OpenSearch 分布式检索与分析引擎 +* Grafana for WhizardTelemetry +* Grafana Loki for WhizardTelemetry +* WhizardTelemetry 数据流水线 +* WhizardTelemetry 平台服务 +* WhizardTelemetry 告警 +* WhizardTelemetry 事件 +* WhizardTelemetry 日志 +* WhizardTelemetry 监控 +* WhizardTelemetry 通知 +* Metrics Server +* Gatekeeper + +扩展组件仓库： https://github.com/kubesphere-extensions/ks-extensions/。 + +### 安装试用 + +**特别说明：目前不支持从 3.4.x 版本直接升级到 v4 版本，需要先卸载原来的版本，再安装 v4 版本。** + +- 参考文档： https://www.kubesphere.io/zh/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere/ + +- 安装扩展组件参考文档： https://www.kubesphere.io/zh/docs/v4.1/06-extension-user-guide/01-install-components-pdf/ + +从 v4.1.1 升级到 v4.1.2，升级和安装部署可以使用以下命令： + +``` +helm upgrade --install -n kubesphere-system --create-namespace ks-core https://charts.kubesphere.io/main/ks-core-1.1.2.tgz --debug --wait +``` + +详细文档请参考： https://kubesphere.io/zh/docs/v4.1/02-quickstart/01-install-kubesphere。 + +## 参与贡献 + +正如前文所说，扩展机制的引入使得 KubeSphere Core 及 KubeSphere 其他扩展组件变得更加松耦合，开发也更加易于上手。 + +社区目前正在逐步发布开源的扩展组件，为各位用户提供更多的功能，让各位用户有更多的选择。同时，社区也非常欢迎各位开发者以及 ISV 参与进来，开发自己的扩展组件，共同丰富扩展组件生态。 + +目前，已经有一位参与开源之夏的学生贡献者张豈明，开发了一款扩展组件 Pod Status Analysis Tool，地址： https://github.com/kubesphere-extensions/ks-extensions-contrib/tree/main/pod-analyzer。 + +- 贡献仓库： https://github.com/kubesphere-extensions/ks-extensions-contrib + +- 开发指南： https://dev-guide.kubesphere.io/extension-dev-guide/zh/ + +## 未来计划与展望 + +KubeSphere 愿景是打造一个以 Kubernetes 为内核的云原生分布式操作系统，它的架构可以非常方便地使第三方应用与云原生生态组件进行即插即用（plug-and-play）的集成，支持云原生应用在多云与多集群的统一分发和运维管理。 + +KubeSphere v4 将正式实现这个愿景，真正成为可插拔架构的产品，让用户可以选择自己需要的组件。 + +后续，我们将开源更多的扩展组件，为用户提供更多的选择。 \ No newline at end of file diff --git a/data/en/footer.yaml b/data/en/footer.yaml index af6545941..1194b02e6 100644 --- a/data/en/footer.yaml +++ b/data/en/footer.yaml @@ -34,11 +34,11 @@ footer: - title: KubeSphere Docs list: - content: Introduction - link: '../../../docs/v3.4/introduction/what-is-kubesphere/' + link: '../../../docs/v4.1/01-intro/01-introduction/' - content: Installation - link: '../../../docs/v3.4/quick-start/all-in-one-on-linux/' + link: '../../../docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere/' - content: Tutorial - link: '../../../docs/v3.4/quick-start/create-workspace-and-project/' + link: '../../../docs/v4.1/02-quickstart/' - content: API Documentation link: '../../../docs/v3.4/reference/api-docs/' diff --git a/data/zh/footer.yaml b/data/zh/footer.yaml index 80d8f41d2..4ea54ed90 100644 --- a/data/zh/footer.yaml +++ b/data/zh/footer.yaml @@ -39,11 +39,11 @@ footer: - title: 文档中心 list: - content: 产品介绍 - link: '../../../zh/docs/v4.1/01-intro/01-introduction.adoc' + link: '../../../zh/docs/v4.1/01-intro/01-introduction/' - content: 如何安装 - link: '../../../zh/docs/v4.1/02-quickstart/01-install-kubesphere.adoc' + link: '../../../zh/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere/' - content: 快速入门 - link: '../../../zh/docs/v4.1/02-quickstart/create-workspace-and-project/' + link: '../../../zh/docs/v4.1/02-quickstart/' - content: API 文档 link: '../../../zh/docs/v3.4/reference/api-docs/' diff --git a/layouts/partials/header.html b/layouts/partials/header.html index e776af1c7..4195b4cb1 100644 --- a/layouts/partials/header.html +++ b/layouts/partials/header.html @@ -4,8 +4,7 @@ {{ if eq .Site.Language.Lang "zh"}}
- 🚀 KubeSphere v4.1.1 已经发布，全新的可插拔架构，欢迎体验！ 请查看 Release notes → + 🚀 KubeSphere v4.1.2 发布，多项优化与改进，欢迎体验！ 请查看 Release notes → close
@@ -13,9 +12,7 @@ {{ if eq .Site.Language.Lang "en"}}
- 🚀 KubeSphere v4.1.1 with Pluggable architecture is available now. Read the release notes for v4.1.1 → + 🚀 KubeSphere v4.1.2 with Enhancements and Bug Fixes is available now. Read the release notes for v4.1.2 → close
diff --git a/static/images/ks-qkcp/en/v4.0/kubectl.png b/static/images/ks-qkcp/en/v4.0/kubectl.png new file mode 100644 index 000000000..81dd80cd8 Binary files /dev/null and b/static/images/ks-qkcp/en/v4.0/kubectl.png differ