diff --git a/config/_default/config.toml b/config/_default/config.toml index d55a5426b..9ef74e13e 100644 --- a/config/_default/config.toml +++ b/config/_default/config.toml @@ -1,6 +1,7 @@ baseURL = "https://www.kubesphere.io/" enableRobotsTXT = true +ignorefiles = [ ".*/_custom" ] [markup] [markup.goldmark.extensions] @@ -11,12 +12,66 @@ enableRobotsTXT = true startLevel = 2 [markup.goldmark.renderer] unsafe= true + [markup.asciidocExt] + backend = 'html5' + extensions = [] + failureLevel = 'fatal' + noHeaderOrFooter = true + preserveTOC = false + safeMode = 'unsafe' + sectionNumbers = false + trace = false + verbose = false + workingFolderCurrent = true + [markup.asciidocExt.attributes] + toc = "null" + toclevels = 2 + file_output_type = "html" + relfilesuffix = "/" + ks_product = " KubeSphere 企业版" + ks_product_left = " KubeSphere 企业版" + ks_product_right = "KubeSphere 企业版" + ks_product_both = " KubeSphere 企业版" + ks_product_full = "KubeSphere 企业版" + ks_product_full_left = " KubeSphere 企业版" + ks_product_full_right = "KubeSphere 企业版" + ks_product_full_both = " KubeSphere 企业版" + ks_product_abbr_full = "KubeSphere 企业版" + ks_product_abbr_full_left = " KubeSphere 企业版" + ks_product_abbr_full_right = "KubeSphere 企业版" + ks_product_abbr_full_both = " KubeSphere 企业版" + ks_product_low = "kubesphere-enterprise" + ks_product_ver = "v3.4.0" + clickhouse_product_ver = "v2.1.1" + mysql_product_ver = "v2.3.0" + kafka_product_ver = "v1.0.0" + opensearch_product_ver = "v1.0.0" + postgresql_product_ver = "v1.2.0" + redis_cluster_product_ver = "v1.0.0" + redis_sentinel_product_ver = "v1.0.0" + eck_product_ver = "v2.2.0" + mongodb_product_ver = "v2.1.2" +[security] + enableInlineShortcodes = false + [security.exec] + allow = ['^(dart-)?sass(-embedded)?$', '^go$', '^npx$', '^postcss$', '^asciidoctor$'] + osEnv = ['(?i)^((HTTPS?|NO)_PROXY|PATH(EXT)?|APPDATA|TE?MP|TERM|GO\w+|(XDG_CONFIG_)?HOME|USERPROFILE|SSH_AUTH_SOCK|DISPLAY|LANG|SYSTEMDRIVE)$'] + [security.funcs] + getenv = ['^HUGO_', '^CI$'] + [security.http] + methods = ['(?i)GET|POST'] + urls = ['.*'] [Taxonomies] [params] logo = "images/logo.svg" +description = "这是青云云计算文档页面" +keywords = "云计算,青云,QingCloud,文档" +logoLink = "/" +disableVersions = false +disablePdf = false githubUrl = "https://github.com/kubesphere/website" @@ -162,6 +217,12 @@ hasChildren = true URL = "https://v1-0.docs.kubesphere.io/docs/" weight = 8 + [[languages.en.menu.main]] + parent = "Documentation" + name = "v4.1" + URL = "/docs/v4.1" + weight = 9 + [[languages.en.menu.main]] weight = 5 hasChildren = true @@ -329,6 +390,12 @@ name = "文档中心" URL = "https://v1-0.docs.kubesphere.io/docs/zh-CN/" weight = 8 + [[languages.zh.menu.main]] + parent = "文档中心" + name = "v4.1" + URL = "/docs/v4.1" + weight = 9 + [[languages.zh.menu.main]] weight = 5 hasChildren = true diff --git a/content/zh/_ks_components/admonitions/admonEnd.adoc b/content/zh/_ks_components/admonitions/admonEnd.adoc new file mode 100644 index 000000000..89cd94105 --- /dev/null +++ b/content/zh/_ks_components/admonitions/admonEnd.adoc @@ -0,0 +1 @@ +|=== diff --git a/content/zh/_ks_components/admonitions/note.adoc b/content/zh/_ks_components/admonitions/note.adoc new file mode 100644 index 000000000..77fca188f --- /dev/null +++ b/content/zh/_ks_components/admonitions/note.adoc @@ -0,0 +1,5 @@ +[.admon.note,cols="a"] +|=== +|说明 + +| diff --git a/content/zh/_ks_components/admonitions/tip.adoc b/content/zh/_ks_components/admonitions/tip.adoc new file mode 100644 index 000000000..413046380 --- /dev/null +++ b/content/zh/_ks_components/admonitions/tip.adoc @@ -0,0 +1,5 @@ +[.admon.tip,cols="a"] +|=== +|提示 + +| \ No newline at end of file diff --git a/content/zh/_ks_components/admonitions/warning.adoc b/content/zh/_ks_components/admonitions/warning.adoc new file mode 100644 index 000000000..6e6a763b0 --- /dev/null +++ b/content/zh/_ks_components/admonitions/warning.adoc @@ -0,0 +1,5 @@ +[.admon.warning,cols="a"] +|=== +|警告 + +| \ No newline at end of file diff --git a/content/zh/_ks_components/bloc-ClusterManagementGuideGlossary.adoc b/content/zh/_ks_components/bloc-ClusterManagementGuideGlossary.adoc new file mode 100755 index 000000000..1d94f013d --- /dev/null +++ b/content/zh/_ks_components/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/zh/_ks_components/bloc-InstallationGuideGlossary.adoc b/content/zh/_ks_components/bloc-InstallationGuideGlossary.adoc new file mode 100644 index 000000000..a6ca92be7 --- /dev/null +++ b/content/zh/_ks_components/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/zh/_ks_components/bloc-ProjectManagementGuideGlossary.adoc b/content/zh/_ks_components/bloc-ProjectManagementGuideGlossary.adoc new file mode 100755 index 000000000..19ca77587 --- /dev/null +++ b/content/zh/_ks_components/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/zh/_ks_components/bloc-WorkspaceManagementGuideGlossary.adoc b/content/zh/_ks_components/bloc-WorkspaceManagementGuideGlossary.adoc new file mode 100644 index 000000000..3db69195b --- /dev/null +++ b/content/zh/_ks_components/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/zh/_ks_components/bloc-devopsManagementGuideGlossary.adoc b/content/zh/_ks_components/bloc-devopsManagementGuideGlossary.adoc new file mode 100644 index 000000000..45727f84d --- /dev/null +++ b/content/zh/_ks_components/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/zh/_ks_components/bloc-pdfFrontMatter.adoc b/content/zh/_ks_components/bloc-pdfFrontMatter.adoc new file mode 100644 index 000000000..61a184796 --- /dev/null +++ b/content/zh/_ks_components/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_full} + +{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/zh/_ks_components/bloc-platformManagementGuideGlossary.adoc b/content/zh/_ks_components/bloc-platformManagementGuideGlossary.adoc new file mode 100644 index 000000000..6a4f36c1e --- /dev/null +++ b/content/zh/_ks_components/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/zh/_ks_components/bloc-radondbClickhouseManagementGuideGlossary.adoc b/content/zh/_ks_components/bloc-radondbClickhouseManagementGuideGlossary.adoc new file mode 100644 index 000000000..836f240c0 --- /dev/null +++ b/content/zh/_ks_components/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/zh/_ks_components/bloc-sectionFrontMatter.adoc b/content/zh/_ks_components/bloc-sectionFrontMatter.adoc new file mode 100644 index 000000000..1a247ed9c --- /dev/null +++ b/content/zh/_ks_components/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/zh/_ks_components/bloc-springcloudManagementGuideGlossary.adoc b/content/zh/_ks_components/bloc-springcloudManagementGuideGlossary.adoc new file mode 100644 index 000000000..24fdbcf22 --- /dev/null +++ b/content/zh/_ks_components/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/zh/_ks_components/code/bash.adoc b/content/zh/_ks_components/code/bash.adoc new file mode 100644 index 000000000..4855f31e9 --- /dev/null +++ b/content/zh/_ks_components/code/bash.adoc @@ -0,0 +1,2 @@ +[source,shell,subs="+attributes"] +---- diff --git a/content/zh/_ks_components/code/go.adoc b/content/zh/_ks_components/code/go.adoc new file mode 100644 index 000000000..3a1f905b9 --- /dev/null +++ b/content/zh/_ks_components/code/go.adoc @@ -0,0 +1,2 @@ +[source,go,subs="+attributes"] +---- \ No newline at end of file diff --git a/content/zh/_ks_components/code/html.adoc b/content/zh/_ks_components/code/html.adoc new file mode 100644 index 000000000..bcfc6283e --- /dev/null +++ b/content/zh/_ks_components/code/html.adoc @@ -0,0 +1,2 @@ +[source,html,subs="+attributes"] +---- diff --git a/content/zh/_ks_components/code/javascript.adoc b/content/zh/_ks_components/code/javascript.adoc new file mode 100644 index 000000000..a5c8d3bb8 --- /dev/null +++ b/content/zh/_ks_components/code/javascript.adoc @@ -0,0 +1,2 @@ +[source,javascript,subs="+attributes"] +---- diff --git a/content/zh/_ks_components/code/json.adoc b/content/zh/_ks_components/code/json.adoc new file mode 100644 index 000000000..9564359b3 --- /dev/null +++ b/content/zh/_ks_components/code/json.adoc @@ -0,0 +1,2 @@ +[source,json,subs="+attributes"] +---- diff --git a/content/zh/_ks_components/code/yaml.adoc b/content/zh/_ks_components/code/yaml.adoc new file mode 100644 index 000000000..c68b6e26f --- /dev/null +++ b/content/zh/_ks_components/code/yaml.adoc @@ -0,0 +1,2 @@ +[source,yaml,subs="+attributes"] +---- diff --git a/content/zh/_ks_components/oper-Autorefresh.adoc b/content/zh/_ks_components/oper-Autorefresh.adoc new file mode 100644 index 000000000..c2434cfc0 --- /dev/null +++ b/content/zh/_ks_components/oper-Autorefresh.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: ec0f4321f3a8496cb29e4a605d5d28bc +* 在右上角点击 image:/images/ks-qkcp/zh/icons/start-dark.svg[start,18,18]/image:/images/ks-qkcp/zh/icons/pause.svg[pause,18,18] 可开启/停止实时数据刷新。 diff --git a/content/zh/_ks_components/oper-clickCreate.adoc b/content/zh/_ks_components/oper-clickCreate.adoc new file mode 100644 index 000000000..caf7aa6df --- /dev/null +++ b/content/zh/_ks_components/oper-clickCreate.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d183e3529a4d49b0b7a05f96151355c1 +. 在页面点击**创建**。 \ No newline at end of file diff --git a/content/zh/_ks_components/oper-clickInvite.adoc b/content/zh/_ks_components/oper-clickInvite.adoc new file mode 100644 index 000000000..ab0a5832a --- /dev/null +++ b/content/zh/_ks_components/oper-clickInvite.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 09975a5d93ed49ddb6c7c3b42ec274f7 +. 在页面右侧点击**邀请**。 \ No newline at end of file diff --git a/content/zh/_ks_components/oper-customizeColumns.adoc b/content/zh/_ks_components/oper-customizeColumns.adoc new file mode 100644 index 000000000..162f7c7eb --- /dev/null +++ b/content/zh/_ks_components/oper-customizeColumns.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 42b64c64491a4e459b1d34958715d6f8 +* 在列表右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]可定制列表中显示的信息。 diff --git a/content/zh/_ks_components/oper-navigate.adoc b/content/zh/_ks_components/oper-navigate.adoc new file mode 100644 index 000000000..fc30decdc --- /dev/null +++ b/content/zh/_ks_components/oper-navigate.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: b773f29ad54e4ebd84187b0924c41f21 +. 在左侧导航栏选择pass:a,q[{ks_navigation}]。 diff --git a/content/zh/_ks_components/oper-refreshData.adoc b/content/zh/_ks_components/oper-refreshData.adoc new file mode 100644 index 000000000..e848f8131 --- /dev/null +++ b/content/zh/_ks_components/oper-refreshData.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 4bba5db43c504475853edcfabbcf5652 +* 在右上角点击 image:/images/ks-qkcp/zh/icons/refresh-dark.svg[refresh,18,18] 可手动刷新数据。 \ No newline at end of file diff --git a/content/zh/_ks_components/oper-refreshListData.adoc b/content/zh/_ks_components/oper-refreshListData.adoc new file mode 100644 index 000000000..cbcac4f49 --- /dev/null +++ b/content/zh/_ks_components/oper-refreshListData.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 28a65f11229c45f0bcd1b632d006acbb +* 在列表右上角点击image:/images/ks-qkcp/zh/icons/refresh-light.svg[refresh,18,18]可刷新列表信息。 diff --git a/content/zh/_ks_components/oper-selectMenu.adoc b/content/zh/_ks_components/oper-selectMenu.adoc new file mode 100644 index 000000000..37a480f46 --- /dev/null +++ b/content/zh/_ks_components/oper-selectMenu.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: f19343cbb46b40ed9e124afde952b084 +. 在页面左上角选择pass:a,q[{ks_menu}]。 diff --git a/content/zh/_ks_components/oper-selectTimeRange.adoc b/content/zh/_ks_components/oper-selectTimeRange.adoc new file mode 100644 index 000000000..7389ba7a4 --- /dev/null +++ b/content/zh/_ks_components/oper-selectTimeRange.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9a5774e5ba9d4e5d950143cba4a5111d +* 在右上角点击 image:/images/ks-qkcp/zh/icons/timed-task.svg[timed-task,18,18] 可设置数据的时间范围。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/alerts/alerts-desc-viewAnAlertingMessageList.adoc b/content/zh/docs/_custom/clusterManagement/alerts/alerts-desc-viewAnAlertingMessageList.adoc new file mode 100644 index 000000000..e4c3a15f3 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/alerts/alerts-desc-viewAnAlertingMessageList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 7a00832787eb484492170688816b225c +本节介绍如何查看告警列表。 diff --git a/content/zh/docs/_custom/clusterManagement/alerts/alerts-oper-openListPage.adoc b/content/zh/docs/_custom/clusterManagement/alerts/alerts-oper-openListPage.adoc new file mode 100644 index 000000000..d5e42f5ee --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/alerts/alerts-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: a11cb13f4c4d44e59332bb4fe44859c0 +. 在**告警**页面点击**来源于自定义规则**或**来源于内置规则**打开告警列表。 diff --git a/content/zh/docs/_custom/clusterManagement/alerts/alerts-oper-searchForAlertingMessages.adoc b/content/zh/docs/_custom/clusterManagement/alerts/alerts-oper-searchForAlertingMessages.adoc new file mode 100644 index 000000000..c6d692274 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/alerts/alerts-oper-searchForAlertingMessages.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c6a3057001e24f3d85a69f8429cf509c +* 在列表上方点击搜索框并设置搜索条件，可按告警状态、告警级别和规则名称搜索告警。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/alerts/alerts-oper-searchForAlertingMessages_new.adoc b/content/zh/docs/_custom/clusterManagement/alerts/alerts-oper-searchForAlertingMessages_new.adoc new file mode 100644 index 000000000..1a61ccc82 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/alerts/alerts-para-alertingMessageList.adoc b/content/zh/docs/_custom/clusterManagement/alerts/alerts-para-alertingMessageList.adoc new file mode 100644 index 000000000..f0c465342 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/alerts/alerts-para-alertingStatus.adoc b/content/zh/docs/_custom/clusterManagement/alerts/alerts-para-alertingStatus.adoc new file mode 100644 index 000000000..6ecb50241 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/alerts/alerts-para-alertingStatus.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: eb9742b579e948b29be0240b89d9335b +* **验证中**：监控指标满足预设的条件，但未满足预设的持续时间。 + +* **已触发**：监控指标满足预设的条件，并且满足预设的持续时间。 diff --git a/content/zh/docs/_custom/clusterManagement/clusterManagement-desc-configuration.adoc b/content/zh/docs/_custom/clusterManagement/clusterManagement-desc-configuration.adoc new file mode 100644 index 000000000..00a9f2a07 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/clusterManagement-desc-configuration.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 156b3180d19240238f9195fd4cc024c5 +本节介绍如何管理配置资源。 + +{ks_product_right}支持管理以下三类配置资源： + +* 保密字典：包含 Base64 编码的键值对，用于存储密码、令牌、密钥等保密数据。 + +* 配置字典：包含明文键值对，用于存储普通配置数据。 + +* 服务帐户：存储当前{ks_product_both}集群的访问信息，用于向应用程序提供{ks_product_both}集群的访问权限。 diff --git a/content/zh/docs/_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc b/content/zh/docs/_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc new file mode 100644 index 000000000..3d980db5e --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: ac11303d404249078087f1c605445e15 +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群。 diff --git a/content/zh/docs/_custom/clusterManagement/clusterManagement-para-eventsTab.adoc b/content/zh/docs/_custom/clusterManagement/clusterManagement-para-eventsTab.adoc new file mode 100644 index 000000000..2aabdb5c4 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/clusterManagement-para-eventsTab.adoc @@ -0,0 +1,21 @@ +// :ks_include_id: 28089246770746498a85c468382fdb76 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|类型 +|事件的类型，包括**正常**和**告警**两种类型。 + +|原因 +|事件发生的原因。 + +|发生时间 +|事件发生的时间。 + +|来源 +|上报事件的组件。 + +|消息 +|事件消息的内容。 +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission.adoc b/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission.adoc new file mode 100644 index 000000000..58adabe19 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: f3341457c4584e59b799240a35ca496d +您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:05-cluster-management/12-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:05-cluster-management/12-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 diff --git a/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc b/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc new file mode 100644 index 000000000..c3af2cb9a --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc b/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc new file mode 100644 index 000000000..e188e56a4 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: f3341457c4584e59b799240a35ca496d +您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 diff --git a/content/zh/docs/_custom/clusterManagement/clusterMembers/clusterMembers-desc-initialClusterAdmin.adoc b/content/zh/docs/_custom/clusterManagement/clusterMembers/clusterMembers-desc-initialClusterAdmin.adoc new file mode 100644 index 000000000..4df2a1e5f --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/clusterMembers/clusterMembers-desc-initialClusterAdmin.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 498ec63e8fb645ccab190e0595b053f8 +在多集群系统中，添加集群的用户自动成为集群管理员。此外，{ks_product_right}平台的 **admin** 用户默认在所有集群中具有所有权限。在集群初始状态下，可由以上用户邀请其他用户加入集群并设置用户在集群中的角色。 diff --git a/content/zh/docs/_custom/clusterManagement/clusterMembers/clusterMembers-para-presetClusterRoles.adoc b/content/zh/docs/_custom/clusterManagement/clusterMembers/clusterMembers-para-presetClusterRoles.adoc new file mode 100644 index 000000000..1dd57bab7 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/clusterMembers/clusterMembers-para-presetClusterRoles.adoc @@ -0,0 +1,13 @@ +// :ks_include_id: 8fa15cb04f8048cfa5479d1a77ddf099 +{ks_product_right}平台提供以下预置集群角色： + +[%header,cols="1a,4a"] +|=== +|角色 |描述 + +|cluster-admin +|集群管理员，在集群内具有除创建和删除集群以外的所有权限。 + +|cluster-viewer +|集群观察员，在集群内具有所有资源的查看权限。 +|=== diff --git a/content/zh/docs/_custom/clusterManagement/clusterMembers/clusterMembers-para-userStatus.adoc b/content/zh/docs/_custom/clusterManagement/clusterMembers/clusterMembers-para-userStatus.adoc new file mode 100644 index 000000000..64be71c0c --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/clusterMembers/clusterMembers-para-userStatus.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 431b5c3a6af541aa9bf2e1607c05789d +* **活跃**：用户当前状态正常。 + +* **等待中**：系统正在创建用户。 + +* **已禁用**：用户被平台管理员禁用，无法登录{ks_product_left} Web 控制台。 + +* **限制登录**：用户在 10 分钟内连续 10 次登录失败，在 10 分钟内被禁止登录{ks_product_left} Web 控制台。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/clusterRoles/clusterRoles-para-authorizedUsers.adoc b/content/zh/docs/_custom/clusterManagement/clusterRoles/clusterRoles-para-authorizedUsers.adoc new file mode 100644 index 000000000..515e7d297 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/clusterRoles/clusterRoles-para-authorizedUsers.adoc @@ -0,0 +1,16 @@ +// :ks_include_id: 532573492da34fcbb954ea832aa9fcd5 +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|用户名 +|获得授权的用户的名称。 + +|状态 +|获得授权的用户当前的状态。 + +include::../clusterMembers/clusterMembers-para-userStatus.adoc[] + +|最近登录 +|获得授权的用户最近一次登录{ks_product_left} Web 控制台的时间。 +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/clusterStatus/clusterStatus-oper-exportJsonData.adoc b/content/zh/docs/_custom/clusterManagement/clusterStatus/clusterStatus-oper-exportJsonData.adoc new file mode 100644 index 000000000..eb3bd32d2 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/clusterStatus/clusterStatus-oper-sortAscendingDescending.adoc b/content/zh/docs/_custom/clusterManagement/clusterStatus/clusterStatus-oper-sortAscendingDescending.adoc new file mode 100644 index 000000000..67e6651f1 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-configmaps.adoc b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-configmaps.adoc new file mode 100644 index 000000000..4783cadb5 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-configmaps.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 9843a92f1beb463bb37db27a61c06fe3 +本节介绍如何管理配置字典。 + +配置字典以键值对的形式存储环境变量、命令行参数和配置文件等非保密数据。配置字典允许用户将容器和配置数据分离，使用户更容易管理配置、保证应用程序的可移植性。 diff --git a/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-createAConfigmap.adoc b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-createAConfigmap.adoc new file mode 100644 index 000000000..04f85d081 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-createAConfigmap.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9207e2fe36e84eb6bffadb973c32ac47 +本节介绍如何创建配置字典。 diff --git a/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-deleteConfigmaps.adoc b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-deleteConfigmaps.adoc new file mode 100644 index 000000000..c28479fad --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-deleteConfigmaps.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 7758d91595c844e4b4614bb148e72c76 +本节介绍如何删除配置字典。 + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +配置字典删除后不能恢复，请谨慎执行此操作。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-editConfigmapInformation.adoc b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-editConfigmapInformation.adoc new file mode 100644 index 000000000..452f3d916 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-editConfigmapInformation.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 72794be0413646dd87bf86ef97c6443b +本节介绍如何编辑配置字典信息。 + +您可以编辑配置字典的别名和描述。{ks_product_right}不支持编辑配置字典的名称。 diff --git a/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-editConfigmapSettings.adoc b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-editConfigmapSettings.adoc new file mode 100644 index 000000000..1f575597e --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-editConfigmapSettings.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 1c55971dc47241c0916ca8bb7a0877b2 +本节介绍如何编辑配置字典数据设置。 diff --git a/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-viewAConfigmapList.adoc b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-viewAConfigmapList.adoc new file mode 100644 index 000000000..3de2b9509 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-viewAConfigmapList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 25de9a77f93843dfb3408a738abd70c2 +本节介绍如何查看配置字典列表。 diff --git a/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-viewConfigmapDetails.adoc b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-viewConfigmapDetails.adoc new file mode 100644 index 000000000..13c8a0dfd --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-desc-viewConfigmapDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 1ca4dafa438c4ae7850540566a7de0e5 +本节介绍如何查看配置字典详情。 diff --git a/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-createAConfigmap.adoc b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-createAConfigmap.adoc new file mode 100644 index 000000000..f58a9c0ff --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-createAConfigmap.adoc @@ -0,0 +1,31 @@ +// :ks_include_id: 9ff97f501cfe40f195a859dfd82902da +. 在**基本信息**页签，设置保密字典的基本信息，然后点击**下一步**。 ++ +-- + +[%header,cols="1,4"] +|=== +|参数 |描述 + +|名称 +|配置字典的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 + +|别名 +|配置字典的别名。不同配置字典的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|项目 +|配置字典所属的项目。 + +|描述 +|配置字典的描述信息。描述可包含任意字符，最长 256 个字符。 + +|=== +-- + +. 在**数据设置**页签，设置配置字典的键值对数据，然后点击**创建**。 ++ +-- +include::../secrets/secrets-para-data.adoc[] + +配置字典创建完成后将显示在配置字典列表中。 +-- diff --git a/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-deleteASingleConfigmap.adoc b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-deleteASingleConfigmap.adoc new file mode 100644 index 000000000..f30cd88b0 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-deleteASingleConfigmap.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 971bac7a7fb84650bc6d4d9712a6b6b3 +. 在需要删除的配置字典右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除配置字典**对话框，输入配置字典的名称，然后点击**确定**。 diff --git a/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-deleteMultipleConfigmaps.adoc b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-deleteMultipleConfigmaps.adoc new file mode 100644 index 000000000..a7cff171c --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-deleteMultipleConfigmaps.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 7120cca5f1fc4d69be0d4be24670e48b +. 选择需要删除的配置字典左侧的复选框，然后在配置字典列表上方点击**删除**。 + +. 在**批量删除配置字典**对话框，输入配置字典的名称，然后点击**确定**。 ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-editConfigmapInformation.adoc b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-editConfigmapInformation.adoc new file mode 100644 index 000000000..af8ea063b --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-editConfigmapInformation.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: 8cd64aa84f8d425e8b7b7c6aa75e531a +. 在需要操作的配置字典右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置配置字典的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|配置字典的别名。不同配置字典的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|配置字典的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-editConfigmapSettings.adoc b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-editConfigmapSettings.adoc new file mode 100644 index 000000000..3c43b37e7 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-editConfigmapSettings.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 713230cd132746e194d0cad61dade1d9 +. 在需要编辑的配置字典右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑设置**。 + +. 在**编辑设置**对话框，设置配置字典的键值对数据，然后点击**创建**。 ++ +-- +include::../secrets/secrets-para-data.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-openDetailsPage.adoc b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-openDetailsPage.adoc new file mode 100644 index 000000000..956e9d3f4 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 4b348a728ca04df6ae2deda14d323b4c +. 在配置字典列表中点击一个配置字典的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-searchForConfigmaps.adoc b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-searchForConfigmaps.adoc new file mode 100644 index 000000000..2bcd3b4dc --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-searchForConfigmaps.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: cb26ec7cf74d406f97f87eb302012018 +* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的配置字典。 diff --git a/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-viewConfigmapDetails.adoc b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-viewConfigmapDetails.adoc new file mode 100644 index 000000000..1a0bebfba --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-oper-viewConfigmapDetails.adoc @@ -0,0 +1,23 @@ +// :ks_include_id: 3f82abc69113418ca3d40eefd6554bb4 +. 在配置字典详情页面左侧的**属性**区域查看配置字典的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群 +|配置字典所属的集群。 + +|项目 +|配置字典所属的项目。 + +|创建时间 +|配置字典的创建时间。 + +|创建者 +|创建配置字典的用户。 +|=== +-- + +. 在配置字典右侧的**数据**页签查看配置字典中存储的键值对数据。 diff --git a/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-para-configmapList.adoc b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-para-configmapList.adoc new file mode 100644 index 000000000..a6bce8277 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-para-configmapList.adoc @@ -0,0 +1,21 @@ +// :ks_include_id: a5dabd56ec624707998a0b18161628be +* 配置字典列表提供以下信息： ++ +-- +[%header,cols="1,4"] +|=== +|参数 |描述 + +|名称 +|配置字典的名称和描述。 + +|项目 +|配置字典所属的项目。 + +|字段 +|配置字典存储的键值对数据的键名称。不同的键通过半角逗号（,）分隔。 + +|创建时间 +|配置字典的创建时间。 +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-para-configmapList_new.adoc b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-para-configmapList_new.adoc new file mode 100644 index 000000000..3df6a62e0 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/configmaps/configmaps-para-configmapList_new.adoc @@ -0,0 +1,21 @@ +// :ks_include_id: a5dabd56ec624707998a0b18161628be +* 配置字典列表提供以下信息： ++ +-- +[%header,cols="1,4"] +|=== +|参数 |描述 + +|名称 +|配置字典的名称和描述。 + +// |项目 +// |配置字典所属的项目。 + +|字段 +|配置字典存储的键值对数据的键名称。不同的键通过半角逗号（,）分隔。 + +|创建时间 +|配置字典的创建时间。 +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/crds/crds-oper-openDetailsPage.adoc b/content/zh/docs/_custom/clusterManagement/crds/crds-oper-openDetailsPage.adoc new file mode 100644 index 000000000..25ef666b6 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/crds/crds-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 58f8c216756e41e8976edccd0d0fe3be +. 在定制资源定义列表中点击一个定制资源定义的名称打开其详情页面。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/crds/crds-para-scope.adoc b/content/zh/docs/_custom/clusterManagement/crds/crds-para-scope.adoc new file mode 100644 index 000000000..3312db4b5 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/crds/crds-para-scope.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 6c86123b72d442d2af494a87b1b826cf +使用定制资源定义创建的定制资源的作用域。 + +* **Namespaced**：使用定制资源定义创建的定制资源属于某一个项目。 + +* **Cluster**：使用定制资源定义创建的定制资源属于整个集群。 diff --git a/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-createACustomMonitoringDashboard.adoc b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-createACustomMonitoringDashboard.adoc new file mode 100644 index 000000000..0ced96155 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-createACustomMonitoringDashboard.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 09ffce0603e5476d9b35342407c90402 +本节介绍如何创建自定义监控面板。 diff --git a/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-customMonitoringDashboards.adoc b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-customMonitoringDashboards.adoc new file mode 100644 index 000000000..62f06c64f --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-customMonitoringDashboards.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 3f3c9d810bbb43449843917a945b0d18 +本节介绍如何使用自定义监控面板。 diff --git a/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-deleteCustomMonitoringDashboards.adoc b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-deleteCustomMonitoringDashboards.adoc new file mode 100644 index 000000000..d0df1a238 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-deleteCustomMonitoringDashboards.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: ebf1355e06284d8a8c1f0d1c6ae2dcdf +本节介绍如何删除自定义监控面板。 + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +自定义监控面板删除后无法恢复，请谨慎执行此操作。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-editACustomMonitoringDashboard.adoc b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-editACustomMonitoringDashboard.adoc new file mode 100644 index 000000000..bf95ed4c1 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-editACustomMonitoringDashboard.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 0a4f15a804bd4a04b35fa4baec7bca69 +本节介绍如何编辑自定义监控面板。 diff --git a/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-exposeMetrics.adoc b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-exposeMetrics.adoc new file mode 100644 index 000000000..c841f358b --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-exposeMetrics.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: fb5da34edef1455388ca60e23308095f +. 配置运行在容器中的应用程序，将符合 Prometheus 规范的监控指标暴露在某个服务端路径下。有关更多信息，请参阅 link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus 官方文档]。 + +. 在{ks_product_left} Web 控制台，在用于暴露工作负载的服务上设置监控导出器，以声明提供应用程序监控指标的路径。{ks_product_right}将根据监控导出器的相关参数获取应用程序的监控指标。 diff --git a/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-howToUse.adoc b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-howToUse.adoc new file mode 100644 index 000000000..9fc88eef0 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-howToUse.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 86dce4cf97db45baa0af638a00a5a435 +{ks_product_right}支持通过自定义监控面板对应用程序的运行状态进行监控。您可以通过以下方式使用自定义监控面板： diff --git a/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-viewACustomMonitoringDashboard.adoc b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-viewACustomMonitoringDashboard.adoc new file mode 100644 index 000000000..f3255c3d1 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-viewACustomMonitoringDashboard.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 459d38d3365247858833ed44c54b075d +本节介绍如何查看自定义监控面板。 diff --git a/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-createACustomMonitoringDashboard.adoc b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-createACustomMonitoringDashboard.adoc new file mode 100644 index 000000000..118a9c41f --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-createACustomMonitoringDashboard.adoc @@ -0,0 +1,42 @@ +// :ks_include_id: 5b3a15eedffe4ef39e6a46e6adc2b335 +. 在**创建自定义监控面板**对话框，设置监控面板的名称、描述和模板，然后点击**下一步**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|自定义监控面板的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 + +|描述 +|自定义监控面板的描述信息。描述可包含任意字符，最长 256 个字符。 + +|模板 +|自定义监控面板的模板。 + +* {ks_product_right}提供预置了 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/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteASingleCustomMonitoringDashboard.adoc b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteASingleCustomMonitoringDashboard.adoc new file mode 100644 index 000000000..b8b84215a --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteMultipleCustomMonitoringDashboards.adoc b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteMultipleCustomMonitoringDashboards.adoc new file mode 100644 index 000000000..091db3ab2 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteMultipleCustomMonitoringDashboards.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: da77b27e5b9840dab0503615aec625a4 +. 选择需要删除的自定义监控面板左侧的复选框，然后在自定义监控面板列表上方点击**删除**。 + +. 在**批量删除自定义监控面板**对话框，输入自定义监控面板的名称，然后点击**确定**。 ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editACustomMonitoringDashboard.adoc b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editACustomMonitoringDashboard.adoc new file mode 100644 index 000000000..d495236aa --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editCustomMonitoringDashboardInformation.adoc b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editCustomMonitoringDashboardInformation.adoc new file mode 100644 index 000000000..e2748e99f --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-useCustomMonitoringDashboard.adoc b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-useCustomMonitoringDashboard.adoc new file mode 100644 index 000000000..b9c80c014 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-useCustomMonitoringDashboard.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: b79841529a1d49a19e7e17eac5decf19 +. 在{ks_product_left} Web 控制台，使用监控指标创建自定义监控面板，从而对应用程序的运行状况进行监控。 diff --git a/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-viewACustomMonitoringDashboard.adoc b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-viewACustomMonitoringDashboard.adoc new file mode 100644 index 000000000..528242561 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-monitoringChart.adoc b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-monitoringChart.adoc new file mode 100644 index 000000000..aa4f845fc --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-monitoringMetric.adoc b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-monitoringMetric.adoc new file mode 100644 index 000000000..045cceba7 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-textMetric.adoc b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-para-textMetric.adoc new file mode 100644 index 000000000..25ad7e064 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-prer-exposeMetrics.adoc b/content/zh/docs/_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-prer-exposeMetrics.adoc new file mode 100644 index 000000000..93d7118da --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-desc-gateway.adoc b/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-desc-gateway.adoc new file mode 100644 index 000000000..df4310f2d --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-desc-gateway.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 854355fa9af44f41886ade72f0ee39da +网关为{ks_product_both}平台上的服务提供反向代理。网关需要根据应用路由工作，来自客户端的业务流量先通过域名解析先发送给网关，网关再根据应用路由中定义的规则将业务流量转发给不同的服务。网关本身也是通过服务暴露的工作负载，因而网关也支持 NodePort 和 LoadBalancer 两种外部访问模式。 diff --git a/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-disableGateway.adoc b/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-disableGateway.adoc new file mode 100644 index 000000000..c77050ceb --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-disableGateway.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 7ea2a84e80b6439cb0d2da5db17f8e35 +. 在页面右侧选择**管理 > 禁用**。 + +. 在弹出的对话框点击**确定**。 diff --git a/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings.adoc b/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings.adoc new file mode 100644 index 000000000..2151178f7 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 17ab622bc96f45e68b3581c076cb1223 +. 在页面右侧选择**管理 > 编辑**。 + +. 在弹出的对话框，修改网关的参数，然后点击**确定**。 ++ +-- +include::gatewaySettings-para-enableGateway.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings_v4.adoc b/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings_v4.adoc new file mode 100644 index 000000000..b6f901cbe --- /dev/null +++ b/content/zh/docs/_custom/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] + +|链路追踪 +|是否对网关启用链路追踪功能。如需使用链路追踪功能，{ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 + +|配置选项 +|网关的配置选项。{ks_product_right}的网关功能底层基于 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/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails.adoc b/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails.adoc new file mode 100644 index 000000000..1c368dd5b --- /dev/null +++ b/content/zh/docs/_custom/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/oper-selectTimeRange.adoc[] + +include::../../../../_ks_components/oper-Autorefresh.adoc[] + +include::../../../../_ks_components/oper-refreshData.adoc[] +==== + +. 在网关详情页面右侧点击**配置选项**查看网关的配置选项。{ks_product_right}的网关功能底层基于 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/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails_v4.adoc b/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails_v4.adoc new file mode 100644 index 000000000..216969f57 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails_v4.adoc @@ -0,0 +1,125 @@ +// :ks_include_id: 2603654cc618449f9ae430c3041a361f +. 在页面右侧选择**管理 > 查看详情**打开网关详情页面。 + +. 在网关详情页面左侧的**属性**区域查看网关的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群 +|网关所属的集群。 + +|创建时间 +|网关的创建时间。 + +|更新时间 +|网关的更新时间 + +|创建者 +|启用网关的用户。 +|=== +-- + +. 在网关详情页面右侧点击**配置选项**查看网关的配置选项。{ks_product_right}的网关功能底层基于 Nginx Ingress Controller 实现，有关网关配置选项的更多信息，请参阅 link:https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/[Nginx Ingress Controller 官方文档]。 + +. 在页面右侧的**监控**页签查看网关的请求数据。 ++ +==== +[.admon.note,cols="a"] +|=== +|说明 + +| +如需使用网关监控功能，{ks_product_right}平台需要安装并启用 **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/oper-selectTimeRange.adoc[] + +include::../../../../_ks_components/oper-Autorefresh.adoc[] + +include::../../../../_ks_components/oper-refreshData.adoc[] +==== + +. 在网关详情页面右侧点击**网关日志**查看网关的日志。 ++ +-- +[.admon.note,cols="a"] +|=== +|说明 + +| +如需使用网关日志搜索功能，{ks_product_right}平台需要安装并启用 **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/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-para-address.adoc b/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-para-address.adoc new file mode 100644 index 000000000..eb71cc9cf --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway.adoc b/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway.adoc new file mode 100644 index 000000000..0e3a397dc --- /dev/null +++ b/content/zh/docs/_custom/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_right}的网关功能底层基于 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/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway_v4.adoc b/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway_v4.adoc new file mode 100644 index 000000000..4f887cbf5 --- /dev/null +++ b/content/zh/docs/_custom/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_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 + +|配置选项 +|网关的配置选项。{ks_product_right}的网关功能底层基于 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/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-para-gatewayCard.adoc b/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-para-gatewayCard.adoc new file mode 100644 index 000000000..04e199499 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-warn-disableGateway.adoc b/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-warn-disableGateway.adoc new file mode 100644 index 000000000..0679834dc --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/gatewaySettings/gatewaySettings-warn-disableGateway.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: fbcc6577f08345e9a2b32a571da90898 +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +网关禁用后客户端将无法访问由网关反向代理的服务，相关业务可能会中断，请谨慎执行此操作。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-createAJob.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-createAJob.adoc new file mode 100644 index 000000000..935d7634d --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-createAJob.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 7f14023bc6974772b201bc6c0b92e13b +本节介绍如何创建任务。 diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-deleteJobs.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-deleteJobs.adoc new file mode 100644 index 000000000..54629b1d6 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-deleteJobs.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 53cddf67368844919fec7ab2ca897ef6 +本节介绍如何删除任务。 + +include::../../../../_ks_components/admonitions/warning.adoc[] + +此操作将删除任务及其管理的所有容器组，如果任务正在运行，运行中的业务将中断，请谨慎执行此操作。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-editJobInformation.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-editJobInformation.adoc new file mode 100644 index 000000000..77407c49d --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-editJobInformation.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: b4a8007c076840f1aaef0251117dd232 +本节介绍如何编辑任务信息。 + +您可以编辑任务的别名和描述。{ks_product_right}不支持编辑已创建任务的名称。 diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-jobs.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-jobs.adoc new file mode 100644 index 000000000..58ffd1f55 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-jobs.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 3965f0c407e24d6dae5c945b45abbd6e +本节介绍如何管理任务。 + +在{ks_product_both}平台上，应用程序运行在容器组中。任务用于管理仅运行一次或周期性运行的容器组。{ks_product_right}平台支持以下任务类型： + +* 普通任务：用于管理仅运行一次的容器组。如果容器组运行失败，系统将根据任务中设置的策略重启容器组，直到满足特定条件。 + +* 定时任务：用于管理周期性运行的容器组。系统根据定时任务中设置的周期创建普通任务并运行。每次运行容器组时，如果容器组运行失败，定时任务都将根据用户设置的策略重启容器组，直到满足特定条件。 diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-pauseACronjob.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-pauseACronjob.adoc new file mode 100644 index 000000000..2482d3a35 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-pauseACronjob.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: a773823d564e4c93b67e89f11ac3bc64 +本节介绍如何暂停定时任务。 + +定时任务暂停后，系统将不会在未来计划的时间点创建任务并运行，正在运行的任务不受影响。此操作仅对定时任务可用。 diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-rerunAJob.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-rerunAJob.adoc new file mode 100644 index 000000000..117ec01b7 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-rerunAJob.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 81c337c82d7743cba51347779b603d00 +本节介绍如何重新运行任务。此操作仅对普通任务可用。 + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +{ks_product_right}仅允许重新运行已结束的任务。正在运行中的任务不支持此操作。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-setJobMetadata.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-setJobMetadata.adoc new file mode 100644 index 000000000..367bd4569 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-setJobMetadata.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 941b85f6a2d149249751ac5843925f97 +设置任务的标签和注解。 diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-viewAJobList.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-viewAJobList.adoc new file mode 100644 index 000000000..cc0b3aeb0 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-viewAJobList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d134e4938b2447beadf1dfb8261c70a1 +本节介绍如何查看任务列表。 diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-viewJobDetails.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-viewJobDetails.adoc new file mode 100644 index 000000000..6f10b1fdf --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-desc-viewJobDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 3d8cf6ff7e434f25b6e0854742aaf84d +本节介绍如何查看任务详情。 diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-createAJob.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-createAJob.adoc new file mode 100644 index 000000000..b93070bee --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-createAJob.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: ade6d86d1f0d4f1db635fb9dd96b2348 +. 在**基本信息**页签，设置任务的基本信息，以及定时任务策略，然后点击**下一步**。 + +. 在**策略设置**页签，设置单次任务的策略，然后点击**下一步**。 + +. 在**容器组设置**页签，为任务管理的容器组设置重启策略和容器，然后点击**下一步**。 + +. 在**存储设置**页签，为任务管理的容器挂载卷，然后点击**下一步**。 + +. 在**高级设置**页签，为任务管理的容器组指定 IP 池和节点，并设置任务的元数据，然后点击**创建**。任务创建完成后将显示在任务列表中。 diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-deleteASingleJob.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-deleteASingleJob.adoc new file mode 100644 index 000000000..e4132bd3d --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-deleteASingleJob.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 3e648f1c3f8d41a0a4ff221ad9efd72d +. 在需要删除的任务右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除任务**对话框，输入任务的名称，然后点击**确定**。 diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-deleteMultipleJobs.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-deleteMultipleJobs.adoc new file mode 100644 index 000000000..f9b70d4af --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-deleteMultipleJobs.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: ae8fc7f6ef7a43999d61c74c6fa39fe5 +. 选择需要删除的任务左侧的复选框，然后在任务列表上方点击**删除**。 + +. 在**批量删除任务**对话框，输入任务的名称，然后点击**确定**。 ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-editJobInformation.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-editJobInformation.adoc new file mode 100644 index 000000000..497345630 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-editJobInformation.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: 71ed2df8398646ea982d8084536b45d9 +. 在需要操作的任务右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置任务的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|任务的别名。不同任务的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|任务的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-openDetailsPage.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-openDetailsPage.adoc new file mode 100644 index 000000000..73b1c9497 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: ca11e2b37deb4d04aa5fa7241ff673c9 +. 在**任务**页面，点击**任务**或**定时任务**，然后在列表中点击一个任务的名称打开其详情页面。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-openListPage.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-openListPage.adoc new file mode 100644 index 000000000..489d8c1ac --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 8619d925ec5a486cae57b4b228b668b2 +. 在**任务**页面，点击**任务**或**定时任务**打开任务列表。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-pauseACronjob.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-pauseACronjob.adoc new file mode 100644 index 000000000..0b3f6f15e --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-pauseACronjob.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: eae4a035080a4f1bb09cb87fc6034aed +. 在需要操作的定时任务右侧点击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/_custom/clusterManagement/jobs/jobs-oper-rerunAJob.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-rerunAJob.adoc new file mode 100644 index 000000000..d9a3dab98 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-rerunAJob.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 24f7afe576124e6396922b7bd7234929 +. 在需要操作的任务右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**重新运行**。任务将重新按照用户设置的策略重新开始运行。 diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-searchForJobs.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-searchForJobs.adoc new file mode 100644 index 000000000..19f031c2e --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-searchForJobs.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: cc4f326315a24232ba3df5a314ef63f3 +* 在列表上方点击搜索框并设置搜索条件，可按名称或状态搜索任务。 diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-viewJobDetails.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-viewJobDetails.adoc new file mode 100644 index 000000000..c19efb20a --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-viewJobDetails.adoc @@ -0,0 +1,144 @@ +// :ks_include_id: ae48f9c2af1e46bca4bede49d4447413 +. 在任务详情页面左侧的**属性**区域查看任务的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群 +|任务所属的集群。 + +|项目 +|任务所属的项目。 + +|状态 +| +任务当前的状态。 + +include::jobs-para-jobStatus.adoc[] + +|最大重试次数 +|任务中的容器组可以重启的最大次数。如果达到最大重试次数仍未满足任务完成条件，任务将被标记为失败。仅对普通任务显示。 + +|容器组完成数量 +|将任务标记为完成所需成功完成的容器组数量。仅对普通任务显示。 + +|并行容器组数量 +|任务中并行运行的容器组副本数量。仅对普通任务显示。 + +|最大运行时间 +|任务的最大运行时间，单位为秒。如果达到最大运行时间仍未满足任务完成条件，任务将被终止并被标记为失败。仅对普通任务显示。 + +|定时计划 +|定时任务运行周期的 CRON 表达式。仅对定时任务显示。 + +|最大启动延后时间 +|由于某种原因未能按计划启动任务时，任务启动的最大延后时间。仅对定时任务显示。 + +|成功任务保留数量 +|允许保留的成功任务的个数。默认值为 3。仅对定时任务显示。 + +|失败任务保留数量 +|允许保留的失败任务的个数。默认值为 1。仅对定时任务显示。 + +|并发策略 +|定时任务创建的多个任务发生重叠时系统采取的策略。 + +* **同时运行任务**：新任务和旧任务并发运行。 + +* **跳过新任务**：不运行新任务。 + +* **跳过旧任务**：立即终止旧任务然后运行新任务。 + +仅对定时任务显示。 + +|创建时间 +|任务的创建时间。 + +|创建者 +|创建任务的用户。 +|=== +-- + +. 在任务详情页面右侧的**运行记录**页签查看任务的运行记录。 ++ +-- +用户手动重新运行普通任务或定时任务按照定时计划运行时，系统将生成运行记录。 + +对于定时任务，**运行记录**页签显示以下信息： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|序号 +|任务运行的序号，表示每条记录是任务第几次运行。 + +|状态 +|每次运行任务的状态结果。 + +include::jobs-para-jobStatus.adoc[] + +* **未完成**：任务运行过程中用户手动重新运行任务。 + +|消息 +|任务运行返回的消息。 + +|开始时间 +|任务运行开始运行的时间。 + +|结束时间 +|任务运行结束的时间。 +|=== + +对于普通任务，**运行记录**页签显示以下信息： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|任务 +|定时任务创建的普通任务的名称。 + +|状态 +|定时任务创建的普通任务的状态。 + +include::jobs-para-jobStatus.adoc[] + +|开始时间 +|定时任务的普通任务开始运行的创建时间。 + +|结束时间 +|任务运行结束的时间。 +|=== +-- + +. 对于普通任务，在任务详情页面右侧点击**资源状态**页签查看任务中的容器端口和容器组。 ++ +-- + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|端口 +|任务中的容器的端口名称、协议和端口号。 + +|容器组 +| +任务中的容器组。 + +include::../nodes/nodes-para-podList.adoc[] +|=== +-- + +. 在任务详情页面右侧点击**元数据**页签查看任务的标签和注解。 + +. 对于普通任务，在任务详情页面右侧点击**环境变量**页签查看任务中的所有容器的环境变量。 + +. 在任务详情页面右侧点击**事件**页签查看任务相关的事件。 ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-viewJobDetails_new.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-viewJobDetails_new.adoc new file mode 100644 index 000000000..d3144c20a --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-oper-viewJobDetails_new.adoc @@ -0,0 +1,144 @@ +// :ks_include_id: ae48f9c2af1e46bca4bede49d4447413 +. 在任务详情页面左侧的**属性**区域查看任务的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群 +|任务所属的集群。 + +|项目 +|任务所属的项目。 + +|状态 +| +任务当前的状态。 + +include::jobs-para-jobStatus.adoc[] + +|最大重试次数 +|任务中的容器组可以重启的最大次数。如果达到最大重试次数仍未满足任务完成条件，任务将被标记为失败。仅对普通任务显示。 + +|容器组完成数量 +|将任务标记为完成所需成功完成的容器组数量。仅对普通任务显示。 + +|并行容器组数量 +|任务中并行运行的容器组副本数量。仅对普通任务显示。 + +|最大运行时间 +|任务的最大运行时间，单位为秒。如果达到最大运行时间仍未满足任务完成条件，任务将被终止并被标记为失败。仅对普通任务显示。 + +|定时计划 +|定时任务运行周期的 CRON 表达式。仅对定时任务显示。 + +|最大启动延后时间 +|由于某种原因未能按计划启动任务时，任务启动的最大延后时间。仅对定时任务显示。 + +|成功任务保留数量 +|允许保留的成功任务的个数。默认值为 3。仅对定时任务显示。 + +|失败任务保留数量 +|允许保留的失败任务的个数。默认值为 1。仅对定时任务显示。 + +|并发策略 +|定时任务创建的多个任务发生重叠时系统采取的策略。 + +* **同时运行任务**：新任务和旧任务并发运行。 + +* **跳过新任务**：不运行新任务。 + +* **跳过旧任务**：立即终止旧任务然后运行新任务。 + +仅对定时任务显示。 + +|创建时间 +|任务的创建时间。 + +|创建者 +|创建任务的用户。 +|=== +-- + +. 在任务详情页面右侧的**运行记录**页签查看任务的运行记录。 ++ +-- +用户手动重新运行普通任务或定时任务按照定时计划运行时，系统将生成运行记录。 + +对于普通任务，**运行记录**页签显示以下信息： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|序号 +|任务运行的序号，表示每条记录是任务第几次运行。 + +|状态 +|每次运行任务的状态结果。 + +include::jobs-para-jobStatus.adoc[] + +* **未完成**：任务运行过程中用户手动重新运行任务。 + +|消息 +|任务运行返回的消息。 + +|开始时间 +|任务运行开始运行的时间。 + +|结束时间 +|任务运行结束的时间。 +|=== + +对于定时任务，**运行记录**页签显示以下信息： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|任务 +|定时任务创建的普通任务的名称。 + +|状态 +|定时任务创建的普通任务的状态。 + +include::jobs-para-jobStatus.adoc[] + +|开始时间 +|定时任务的普通任务开始运行的创建时间。 + +|结束时间 +|任务运行结束的时间。 +|=== +-- + +. 对于普通任务，在任务详情页面右侧点击**资源状态**页签查看任务中的容器组副本数和容器组。 ++ +-- + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|副本 +|任务中的容器组副本数。 + +|容器组 +| +任务中的容器组。 + +include::../nodes/nodes-para-podList.adoc[] +|=== +-- + +. 在任务详情页面右侧点击**元数据**页签查看任务的标签和注解。 + +. 对于普通任务，在任务详情页面右侧点击**环境变量**页签查看任务中的所有容器的环境变量。 + +. 在任务详情页面右侧点击**事件**页签查看任务相关的事件。 ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-para-basicInformation.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-para-basicInformation.adoc new file mode 100644 index 000000000..34074cd7b --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-para-basicInformation.adoc @@ -0,0 +1,42 @@ +// :ks_include_id: b3230b385e724f75b412f086ba00503e +* 基本信息 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|任务的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 + +|别名 +|任务的别名。不同任务的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|项目 +|任务所属的项目。系统项目通常用于管理系统资源，建议选择用户项目。 + +|描述 +|任务的描述信息。描述可包含任意字符，最长 256 个字符。 + +|定时计划 +|定时任务的运行周期的 CRON 表达式。{ks_product_right}默认使用 UTC 时间，您需要根据您所在的时区进行调整。仅对定时任务可用。 + +|最大启动延后时间 +|由于某种原因未能按计划启动任务时，任务启动的最大延后时间。仅对定时任务可用。 + +|成功任务保留数量 +|允许保留的成功任务的个数，默认值为 **3**。定时任务每次运行都会创建任务，您可以指定保留一定数量的任务作为历史记录。仅对定时任务可用。 + +|失败任务保留数量 +|允许保留的失败任务的个数，默认值为 **1**。定时任务每次运行都会创建任务，您可以指定保留一定数量的任务作为历史记录。仅对定时任务可用。 + +|并发策略 +|定时任务创建的多个任务发生重叠时，系统采取的策略。仅对定时任务可用。包括以下策略类型： + +* **同时运行任务**：新任务和旧任务并发运行。 + +* **跳过新任务**：不运行新任务。 + +* **跳过旧任务**：立即终止旧任务然后运行新任务。 +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-para-jobList.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-para-jobList.adoc new file mode 100644 index 000000000..ae091423f --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-para-jobList.adoc @@ -0,0 +1,28 @@ +// :ks_include_id: f4fbda985b234075830531d6835efefe +* 任务列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|任务的名称和描述信息。 + +|状态 +| +任务当前的状态。 + +* **运行中**：任务正在运行中。 + +* **已完成**：任务运行成功并且已完成。 + +* **失败**：任务运行失败。 + +|项目 +|任务所属的项目。 + +|上次运行时间 +|任务上一次运行的时间。 +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-para-jobStatus.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-para-jobStatus.adoc new file mode 100644 index 000000000..cc36b6b2c --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-para-jobStatus.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 88bc02980e93473eaec099d0e0f6b2c4 +* **运行中**：任务正在运行中。 + +* **已完成**：任务运行成功并且已完成。 + +* **失败**：任务运行失败。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-para-restartPolicy.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-para-restartPolicy.adoc new file mode 100644 index 000000000..77b30fecb --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-para-restartPolicy.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: e492eb63e19b4c8d88cb2d2a4b800815 +* 容器组设置 > 重启策略 ++ +-- +设置容器运行失败时系统采取的策略。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|重新创建容器组 +|系统将重新创建整个容器组。 + +|重启容器 +|系统将重启容器。 +|=== +-- \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/jobs/jobs-para-strategySettings.adoc b/content/zh/docs/_custom/clusterManagement/jobs/jobs-para-strategySettings.adoc new file mode 100644 index 000000000..c2bd73418 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/jobs/jobs-para-strategySettings.adoc @@ -0,0 +1,23 @@ +// :ks_include_id: fefe006cd58c414c825a62b8b3066867 +* 策略设置 ++ +-- +设置每次运行任务的策略。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|最大重试次数 +|任务中的容器组可以重启的最大次数。如果达到最大重试次数仍未满足任务完成条件，任务将被标记为失败。 + +|容器组完成数量 +|将任务标记为完成所需成功完成的容器组数量。 + +|并行容器组数量 +|任务中并行运行的容器组副本数量。 + +|最大运行时间 +|任务的最大运行时间，单位为秒。如果达到最大运行时间仍未满足任务完成条件，任务将被终止并被标记为失败。 +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/logReceivers/logReceivers-desc-logTypes.adoc b/content/zh/docs/_custom/clusterManagement/logReceivers/logReceivers-desc-logTypes.adoc new file mode 100644 index 000000000..f64cbbf27 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/logReceivers/logReceivers-desc-logTypes.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 3b493272487d4c41acba72e256f15c2e +* 容器日志：从容器标准输出获取的日志。容器日志的内容由容器中运行的应用程序决定。 + +* 资源事件：工作负载、任务、容器组、服务、应用路由等各类资源的事件。 + +* 审计日志：{ks_product} API 服务器接收请求的记录。 diff --git a/content/zh/docs/_custom/clusterManagement/logReceivers/logReceivers-oper-openDetailsPage.adoc b/content/zh/docs/_custom/clusterManagement/logReceivers/logReceivers-oper-openDetailsPage.adoc new file mode 100644 index 000000000..fce00206e --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/logReceivers/logReceivers-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 5dbadd4f7bcf45adbae22159fa533a09 +. 在**日志接收器**页面，点击**容器日志**、**资源事件**或**审计日志**，然后在列表中点击一个日志接收器的名称打开其详情页面。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/logReceivers/logReceivers-oper-openListPage.adoc b/content/zh/docs/_custom/clusterManagement/logReceivers/logReceivers-oper-openListPage.adoc new file mode 100644 index 000000000..5078e1b7c --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/logReceivers/logReceivers-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 4165043cdef34a04aabf44d19b27f0b4 +. 在**日志接收器**页面，点击**容器日志**、**资源事件**或**审计日志**打开日志接收器列表。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/logReceivers/logReceivers-para-addLogReceiver.adoc b/content/zh/docs/_custom/clusterManagement/logReceivers/logReceivers-para-addLogReceiver.adoc new file mode 100644 index 000000000..8e101380d --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/logReceivers/logReceivers-para-address.adoc b/content/zh/docs/_custom/clusterManagement/logReceivers/logReceivers-para-address.adoc new file mode 100644 index 000000000..8f597961f --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/logReceivers/logReceivers-para-address.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 52e9e8100b4444ebb9fbb42175d917f3 +日志接收器的服务地址和服务端口。{ks_product_right}会将日志发送给该地址和端口。{ks_product_right}默认使用的 OpenSearch 的服务地址和服务端口为 **opensearch-cluster-data.kubesphere-logging-system.svc:9200**。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/networkPolicies/networkPolicies-para-information.adoc b/content/zh/docs/_custom/clusterManagement/networkPolicies/networkPolicies-para-information.adoc new file mode 100644 index 000000000..3fb6387f6 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/networkPolicies/networkPolicies-para-information.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 9f53c0bd64274d80baa502171017a705 +|名称 +|网络策略的名称。 + +|项目 +|网络策略所属的项目。 + +|创建时间 +|网络策略的创建时间。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/networkPolicies/networkPolicies-para-target.adoc b/content/zh/docs/_custom/clusterManagement/networkPolicies/networkPolicies-para-target.adoc new file mode 100644 index 000000000..1ec586e59 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/networkPolicies/networkPolicies-para-target.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: ff94c103e4f841cfa4bed82610aac7a6 +规则适用的容器组的信息。 + +* **项目**：规则所属的项目。网络策略中的规则仅适用于网络策略所属项目中的容器组。 + +* **标签**：规则适用的容器组所具有的标签。如果未设置标签，则规则适用于网络策略所属的项目中的所有容器组。 diff --git a/content/zh/docs/_custom/clusterManagement/networkPolicies/networkPolicies-prer-enableNetworkPolicy.adoc b/content/zh/docs/_custom/clusterManagement/networkPolicies/networkPolicies-prer-enableNetworkPolicy.adoc new file mode 100644 index 000000000..8606b9958 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/networkPolicies/networkPolicies-prer-enableNetworkPolicy.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: c68e65ce33ae49d898727cd2c7e06306 +ifeval::["{file_output_type}" == "html"] +* {ks_product_right}平台需要启用网络策略扩展组件。 +endif::[] +ifeval::["{file_output_type}" == "pdf"] +* {ks_product_right}平台需要启用网络策略扩展组件。有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。 +endif::[] diff --git a/content/zh/docs/_custom/clusterManagement/nodes/nodes-oper-openListPage.adoc b/content/zh/docs/_custom/clusterManagement/nodes/nodes-oper-openListPage.adoc new file mode 100644 index 000000000..d0c0180d9 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/nodes/nodes-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 18321be0ac1a40aca5c8142bce4195c6 +. 在左侧导航栏选择**节点 > 集群节点**或**节点 > 边缘节点**打开节点列表。 diff --git a/content/zh/docs/_custom/clusterManagement/nodes/nodes-oper-openListPage_new.adoc b/content/zh/docs/_custom/clusterManagement/nodes/nodes-oper-openListPage_new.adoc new file mode 100644 index 000000000..5403a4238 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/nodes/nodes-oper-openListPage_new.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 18321be0ac1a40aca5c8142bce4195c6 +. 在左侧导航栏选择**节点 > 集群节点**打开节点列表。 diff --git a/content/zh/docs/_custom/clusterManagement/nodes/nodes-para-nodeRole.adoc b/content/zh/docs/_custom/clusterManagement/nodes/nodes-para-nodeRole.adoc new file mode 100644 index 000000000..1e871ee51 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/nodes/nodes-para-nodeRole.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: aa9a7a75dbc34278bbd88723c93fcca5 +各节点在集群中的角色，取值为**控制平面节点**、**工作节点**或**边缘节点**。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/nodes/nodes-para-nodeRole_new.adoc b/content/zh/docs/_custom/clusterManagement/nodes/nodes-para-nodeRole_new.adoc new file mode 100644 index 000000000..abb02f969 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/nodes/nodes-para-nodeRole_new.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: aa9a7a75dbc34278bbd88723c93fcca5 +各节点在集群中的角色，取值为**控制平面节点**、**工作节点**。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/nodes/nodes-para-nodeStatus.adoc b/content/zh/docs/_custom/clusterManagement/nodes/nodes-para-nodeStatus.adoc new file mode 100644 index 000000000..842cc5e71 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/nodes/nodes-para-nodeStatus.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 0724df9ec5f247dcbf50e5ed6abcdf40 +各节点的运行状态。 + +* **运行中**：节点运行正常。 + +* **无法调度**：节点被用户手动设置为不可调度。如果节点处在此状态，容器组将不能被调度到该节点。 + +* **告警**：节点上存在告警。您可以在节点详情页面的**运行状态 > 健康状态** 区域查看节点的告警类型。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/nodes/nodes-para-nodeStatus_new.adoc b/content/zh/docs/_custom/clusterManagement/nodes/nodes-para-nodeStatus_new.adoc new file mode 100644 index 000000000..2cc31fe2a --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/nodes/nodes-para-nodeStatus_new.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 0724df9ec5f247dcbf50e5ed6abcdf40 +各节点的运行状态。 + +* **运行中**：节点运行正常。 + +* **无法调度**：节点被用户手动设置为不可调度。如果节点处在此状态，容器组将不能被调度到该节点。 + +// * **告警**：节点上存在告警。您可以在节点详情页面的**运行状态 > 健康状态** 区域查看节点的告警类型。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/nodes/nodes-para-podList.adoc b/content/zh/docs/_custom/clusterManagement/nodes/nodes-para-podList.adoc new file mode 100644 index 000000000..4222ea352 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/nodes/nodes-para-podList.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 5fa3835b046e429ca339319d7a09aefe +* 点击image:/images/ks-qkcp/zh/icons/chevron-down.svg["chevron-down",18,18]可查看容器组中运行的容器的信息。 + +* 点击容器组的名称可查看容器组详情。 + +* 在容器组列表上方的搜索框中输入关键字，可搜索名称包含特定关健字的容器组。 + +* 在容器组列表右上角点击image:/images/ks-qkcp/zh/icons/refresh-light.svg[refresh,18,18]可刷新列表信息。 diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-cloneAPersistentVolume.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-cloneAPersistentVolume.adoc new file mode 100644 index 000000000..a82d4b5eb --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-cloneAPersistentVolume.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 19d9bf1ea982422ea0b931f92715f227 +本节介绍如何克隆持久卷。 + +持久卷声明和持久卷创建后，您可以通过克隆为持久卷声明和持久卷分别创建相同的副本。 diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAPersistentVolumeClaim.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAPersistentVolumeClaim.adoc new file mode 100644 index 000000000..398b637a3 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAPersistentVolumeClaim.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: ba578c6d273d47d6b41c1255d1fa8488 +本节介绍如何创建持久卷声明。 diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAVolumeSnapshot.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAVolumeSnapshot.adoc new file mode 100644 index 000000000..d8bdac5a7 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAVolumeSnapshot.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 10cd1bc2be6f48dd994fe2be6c747e10 +本节介绍如何创建卷快照。 diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-deletePersistentVolumeClaims.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-deletePersistentVolumeClaims.adoc new file mode 100644 index 000000000..b4ab23c5a --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-deletePersistentVolumeClaims.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: f294119a3b1a45a49ff83ed852f8fadd +本节介绍如何删除持久卷声明。 + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +持久卷声明删除后不能恢复，并且默认情况下持久卷声明对应的持久卷也将被删除，请谨慎执行此操作以避免数据丢失。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-editPersistentVolumeClaimInformation.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-editPersistentVolumeClaimInformation.adoc new file mode 100644 index 000000000..24f28b820 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-editPersistentVolumeClaimInformation.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: e8b3859a8e1d48b4afe313a86d58a9f3 +本节介绍如何编辑持久卷声明的基本信息。 + +您可以编辑持久卷声明的别名和描述。{ks_product_right}不支持编辑持久卷声明的名称。 diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-expandAPersistentVolumeClaim.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-expandAPersistentVolumeClaim.adoc new file mode 100644 index 000000000..eef7c60a5 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-expandAPersistentVolumeClaim.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 733b66fafb0d4f2cbc99a4d8dbd20458 +本节介绍如何扩展持久卷容量。 diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-viewPersistentVolumeClaimDetails.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-viewPersistentVolumeClaimDetails.adoc new file mode 100644 index 000000000..e8be4ca6e --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-viewPersistentVolumeClaimDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 3b30b4276d1c44d894011e368b54291d +本节介绍如何查看持久卷声明详情。 diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-cloneAPersistentVolume.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-cloneAPersistentVolume.adoc new file mode 100644 index 000000000..b4ea8e53a --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-cloneAPersistentVolume.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 63eda24d0c774987bc1076d5c1cc20c4 +. 在持久卷详声明情页面的左上角，选择**更多操作 > 克隆**。 + +. 在**克隆卷**对话框，设置新持久卷声明的名称，然后点击**确定**。 ++ +-- +系统将为持久卷声明和对应持久卷分别创建相同副本。 +-- \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim-for-kubefed.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim-for-kubefed.adoc new file mode 100644 index 000000000..a084ccf62 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim.adoc new file mode 100644 index 000000000..e71c61354 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim_new.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim_new.adoc new file mode 100644 index 000000000..efd6eda30 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim_new.adoc @@ -0,0 +1,60 @@ +// :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/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAVolumeSnapshot.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAVolumeSnapshot.adoc new file mode 100644 index 000000000..38a862684 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteASinglePersistentVolumeClaim.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteASinglePersistentVolumeClaim.adoc new file mode 100644 index 000000000..09ebbb2ec --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteASinglePersistentVolumeClaim.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: b7a80819469049cbae45753ff7ba3aa4 +. 在需要删除的持久卷声明右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除持久卷声明**对话框，输入持久卷声明的名称，然后点击**确定**。 diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteMultiplePersistentVolumeClaims.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteMultiplePersistentVolumeClaims.adoc new file mode 100644 index 000000000..55ba7db62 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteMultiplePersistentVolumeClaims.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 20ff9a5d22c94e289133c37037d461e6 +. 选择需要删除的持久卷声明左侧的复选框，然后在持久卷声明列表上方点击**删除**。 + +. 在**批量删除持久卷声明**对话框，输入持久卷声明的名称，然后点击**确定**。 ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-editPersistentVolumeClaimInformation.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-editPersistentVolumeClaimInformation.adoc new file mode 100644 index 000000000..e1541b8b6 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-editPersistentVolumeClaimInformation.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: 760d701b023046d9889a96949df4735e +. 在需要操作的持久卷声明右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置持久卷声明的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|持久卷声明的别名。不同持久卷声明的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|持久卷声明的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-expandAPersistentVolume.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-expandAPersistentVolume.adoc new file mode 100644 index 000000000..eadf55624 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-expandAPersistentVolume.adoc @@ -0,0 +1,15 @@ +// :ks_include_id: b1b90c0bbcf94434a5daecc86d546c03 +. 在持久卷声明详情页面的左上角，选择**更多操作 > 扩展**。 + +. 在**扩展卷**对话框，设置卷的容量，然后点击**确定**。 ++ +-- +// Note +include::../../../../_ks_components/admonitions/warning.adoc[] + +* 如果持久卷已挂载到工作负载，容量扩展操作将导致工作负载重启，业务可能出现短暂中断。 + +* 持久卷容量只能增加，不能减少。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc new file mode 100644 index 000000000..27876d8f1 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: fd9a9a3e2e00439cb6d91dd990d83b23 +. 在持久卷声明列表中点击一个持久卷声明的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-searchForPersistentVolumeClaims.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-searchForPersistentVolumeClaims.adoc new file mode 100644 index 000000000..d630f63d2 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-searchForPersistentVolumeClaims.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 8f4761e6cc6f4d4e92304c70275e7b0a +* 在列表上方点击搜索框并设置搜索条件，可按名称或状态搜索持久卷声明。 diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails-for-kubefed.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails-for-kubefed.adoc new file mode 100644 index 000000000..0906ee060 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails.adoc new file mode 100644 index 000000000..7447bb06d --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails_new.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails_new.adoc new file mode 100644 index 000000000..7675f30d5 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails_new.adoc @@ -0,0 +1,66 @@ +// :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[] +-- + diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-accessMode.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-accessMode.adoc new file mode 100644 index 000000000..327888e66 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-accessMode.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 03868826ceca4baea8a9365de6974f02 +持久卷的读写模式。 + +* **RWO**（ReadWriteOnce）：允许单个节点读取持久卷中的数据并向其中写入数据。 + +* **ROX**（ReadOnlyMany）：允许多个节点读取持久卷中的数据。 + +* **RWX**（ReadWriteMany）：允许多个节点读取持久卷中的数据并向其中写入数据。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-persistentVolumeClaimList.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-persistentVolumeClaimList.adoc new file mode 100644 index 000000000..7c25c0223 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-persistentVolumeClaimList.adoc @@ -0,0 +1,31 @@ +// :ks_include_id: 3406d7c02c52477bb228c5d190bee2a3 +* 持久卷声明列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|持久卷声明的名称、别名和存储类。 + +|状态 +| +include::persistentVolumeClaims-para-status.adoc[] + +ifndef::kubefed[] +|持久卷 +|与持久卷声明绑定的持久卷。 +endif::[] + +|访问模式 +| +include::persistentVolumeClaims-para-accessMode.adoc[] + +|挂载状态 +|持久卷声明对应的持久卷是否已经挂载到容器。 + +|创建时间 +|持久卷声明的创建时间。 +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-status.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-status.adoc new file mode 100644 index 000000000..fd66f005f --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-status.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: 3728661e623d44fcaae41fd16cf87c08 +持久卷声明当前的状态。 + +* **已绑定**：系统已根据持久卷声明创建持久卷，并且已将持久卷声明和持久卷绑定。 + +* **等待中**：系统已创建持久卷声明，但未创建对应的持久卷。 + +* **更新中**：持久卷声明的设置发生变化，系统正在更新持久卷声明。 + +* **删除中**：系统正在删除持久卷声明。 + +* **丢失**：系统已将持久卷声明和一个持久卷绑定，但是没有找到被绑定的持久卷。此状态下持久卷可能已被删除。 diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshot.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshot.adoc new file mode 100644 index 000000000..be293769e --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshot.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 7d428de9ff3a4f0fbd1cd48e49749f27 +卷快照保存了存储卷的当前数据，可用于创建持久卷声明以及对应的持久卷。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshotClass.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshotClass.adoc new file mode 100644 index 000000000..da6b9ba1c --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshotClass.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 308d3cded9ea45a5a0a4475b02e53d57 +用于创建卷快照的卷快照类。请确保卷快照类的供应者与持久卷对应的存储类的供应者一致，否则卷快照将创建失败。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-backData.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-backData.adoc new file mode 100644 index 000000000..10922235f --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-backData.adoc @@ -0,0 +1 @@ +* 请提前备份后端存储区域中的数据以避免数据丢失。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc new file mode 100644 index 000000000..d80dcb2bb --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: e7ab0deee8b44daabe6f1a91f7893150 +* 请确保系统已为持久卷声明创建持久卷。 diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-snapshotCreationEnabled.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-snapshotCreationEnabled.adoc new file mode 100644 index 000000000..b5ba48d7a --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-snapshotCreationEnabled_new.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-snapshotCreationEnabled_new.adoc new file mode 100644 index 000000000..4d3cc7023 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/persistentVolumes/persistent-volume-status.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistent-volume-status.adoc new file mode 100644 index 000000000..06bf8cb2e --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistent-volume-status.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: f3350225a1bf47a3872722fd47af4d1d +持久卷当前的状态。 + +* **可用**：持久卷未与持久卷声明绑定。{ks_product_right} Web 控制台目前不支持直接创建持久卷，如果您通过后台命令行直接创建持久卷，将出现状态为**可用**的持久卷。有关更多信息，请参阅 link:https://kubernetes.io/zh/docs/concepts/storage/persistent-volumes/[Kubernetes 官方文档]。 + +* **已绑定**：持久卷已经与持久卷声明绑定。 + +* **已释放**：与持久卷绑定的持久卷声明已被删除而持久卷尚未被删除。 + +* **失败**：持久卷存在未知错误。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-oper-openListPage.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-oper-openListPage.adoc new file mode 100644 index 000000000..d770463a4 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 1883d4e9bde042c4b93fa773d65ab3bb +. 在**持久卷声明**页面点击**持久卷**打开持久卷列表。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-para-deletionPolicy.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-para-deletionPolicy.adoc new file mode 100644 index 000000000..cebc20d6b --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-para-deletionPolicy.adoc @@ -0,0 +1 @@ +// :ks_include_id: 12ad770d75ab40c4aae388e788227746 diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-para-provisioner.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-para-provisioner.adoc new file mode 100644 index 000000000..5a7ffaec6 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-para-provisioner.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 5134b15835954a9abac8672f75fbc92f +存储类使用的存储插件。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-para-pvcInformation.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-para-pvcInformation.adoc new file mode 100644 index 000000000..c4f92258f --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-para-pvcInformation.adoc @@ -0,0 +1,27 @@ +// :ks_include_id: 97165dd8a39e4251913b19385f46901d +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|持久卷声明的名称。 + +|存储类 +| +include::persistentVolumes-para-storageClass.adoc[] + +|创建时间 +|持久卷声明的创建时间。 + +|供应者 +| +include::persistentVolumes-para-provisioner.adoc[] + +|访问模式 +| +include::../persistentVolumeClaims/persistentVolumeClaims-para-accessMode.adoc[] + +|容量 +| +include::persistentVolumes-para-volumeSize.adoc[] +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-para-reclaimPolicy.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-para-reclaimPolicy.adoc new file mode 100644 index 000000000..a3474c268 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-para-reclaimPolicy.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 05055fc19ca74178ac595789b0863f6f +持久卷的回收策略。{ks_product_right}平台默认使用 **Delete** 回收策略，即在持久卷声明被删除时同时删除持久卷。有关更多信息，请参阅 link:https://kubernetes.io/zh/docs/concepts/storage/storage-classes/[Kubernetes 官方文档]。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-para-storageClass.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-para-storageClass.adoc new file mode 100644 index 000000000..1dbee2fd9 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-para-storageClass.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 3fb3e081dbcf4e6ba9164671a38aa755 +创建持久卷声明使用的存储类。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-para-volumeSize.adoc b/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-para-volumeSize.adoc new file mode 100644 index 000000000..0ed47d881 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/persistentVolumes/persistentVolumes-para-volumeSize.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d70b04812502488cacd1e6b813dcc70d +后端存储区域的容量大小。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/podIpPools/podIpPools-prer-enablePodIpPool.adoc b/content/zh/docs/_custom/clusterManagement/podIpPools/podIpPools-prer-enablePodIpPool.adoc new file mode 100644 index 000000000..6929ad65e --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/podIpPools/podIpPools-prer-enablePodIpPool.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 07a04c60e8c342db9bc6ec8108be9412 +ifeval::["{file_output_type}" == "html"] +* {ks_product_right}平台需要启用容器组 IP 池扩展组件。 +有关更多信息，请参阅 xref:04-platform-management/01-extension-management/_index.adoc[启用可插拔组件]。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。 +endif::[] \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/podIpPools/podIpPools-prer-notUsed.adoc b/content/zh/docs/_custom/clusterManagement/podIpPools/podIpPools-prer-notUsed.adoc new file mode 100644 index 000000000..087801f5b --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/pods/pods-desc-accessAContainerTerminal.adoc b/content/zh/docs/_custom/clusterManagement/pods/pods-desc-accessAContainerTerminal.adoc new file mode 100644 index 000000000..2a420422f --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/pods/pods-desc-accessAContainerTerminal.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 3bb6ac8d7b114854992775f89ab8debb +本节介绍如何访问容器终端。 + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +{ks_product_right}仅支持访问正在运行中容器的终端。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/pods/pods-desc-deletePods.adoc b/content/zh/docs/_custom/clusterManagement/pods/pods-desc-deletePods.adoc new file mode 100644 index 000000000..c8e4fea76 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/pods/pods-desc-deletePods.adoc @@ -0,0 +1,18 @@ +// :ks_include_id: 12077b1940064dbc91b46df1bb4d2390 +本节介绍如何删除容器组。 + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +* 建议通过删除容器组的管理资源（例如工作负载或任务）来删除容器组，而不是直接删除容器组。 + +* 如果您直接删除容器组，取决于容器组管理资源的策略，系统可能会重新创建容器组。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +删除正在运行的容器组可能会导致业务中断，请谨慎执行此操作。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/pods/pods-desc-pods.adoc b/content/zh/docs/_custom/clusterManagement/pods/pods-desc-pods.adoc new file mode 100644 index 000000000..a5b9f7f41 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/pods/pods-desc-pods.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 6a773c6c880441b0b453c3426a19cc8e +本节介绍如何管理容器组。 + +在{ks_product_both}平台上，容器组是应用程序的最小管理单元。每个容器组包含一个或多个容器。同一个容器组的多个容器紧密耦合在一起，一同调度并且共享网络。容器组相当于应用程序的逻辑主机。 + +{ks_product_right} Web 控制台不支持单独创建容器组。您可以通过创建工作负载或任务间接创建容器组并对多个容器组副本进行管理。 diff --git a/content/zh/docs/_custom/clusterManagement/pods/pods-desc-viewAPersistentVolumeList.adoc b/content/zh/docs/_custom/clusterManagement/pods/pods-desc-viewAPersistentVolumeList.adoc new file mode 100644 index 000000000..ef1cbdd9e --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/pods/pods-desc-viewAPersistentVolumeList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: e493355923a646c2aeb3e6de095c8aa0 +本节介绍如何查看持久卷声明列表。 diff --git a/content/zh/docs/_custom/clusterManagement/pods/pods-desc-viewAPodList.adoc b/content/zh/docs/_custom/clusterManagement/pods/pods-desc-viewAPodList.adoc new file mode 100644 index 000000000..400bf44fd --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/pods/pods-desc-viewAPodList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 28a0c6fdb89548bb9027842de7697721 +本节介绍如何查看容器组列表。 diff --git a/content/zh/docs/_custom/clusterManagement/pods/pods-desc-viewContainerDetails.adoc b/content/zh/docs/_custom/clusterManagement/pods/pods-desc-viewContainerDetails.adoc new file mode 100644 index 000000000..20ecb529e --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/pods/pods-desc-viewContainerDetails.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 25f413cc757b4a79b6dd8d953602f1e9 +本节介绍如何查看容器详情。 + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +{ks_product_right}仅支持查看运行中的容器的详情，不支持查看已停止运行的容器的详情。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/pods/pods-desc-viewPodDetails.adoc b/content/zh/docs/_custom/clusterManagement/pods/pods-desc-viewPodDetails.adoc new file mode 100644 index 000000000..5d2f4995e --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/pods/pods-desc-viewPodDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 48b9b884c6114c8d9481866c41eda79c +本节介绍如何查看容器组详情。 diff --git a/content/zh/docs/_custom/clusterManagement/pods/pods-oper-accessAContainerTerminal.adoc b/content/zh/docs/_custom/clusterManagement/pods/pods-oper-accessAContainerTerminal.adoc new file mode 100644 index 000000000..dc43a9750 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/pods/pods-oper-accessAContainerTerminal.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 1d8e328225714a61970419e6ff20593a +. 在**资源状态**页签的**容器**区域，在容器名称右侧点击image:/images/ks-qkcp/zh/icons/terminal.svg[terminal,18,18]打开容器终端。您可以使用容器终端在容器内部执行命令。 + +. 在容器终端页面右上角的下拉列表中选择容器，可快速访问同一个容器组中其他容器的终端。 diff --git a/content/zh/docs/_custom/clusterManagement/pods/pods-oper-deleteASinglePod.adoc b/content/zh/docs/_custom/clusterManagement/pods/pods-oper-deleteASinglePod.adoc new file mode 100644 index 000000000..b325c1345 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/pods/pods-oper-deleteASinglePod.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 2a8675daa13541ae83846c5eb87d5ed7 +. 在需要删除的容器组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除容器组**对话框，输入容器组的名称，然后点击**确定**。 diff --git a/content/zh/docs/_custom/clusterManagement/pods/pods-oper-deleteMultiplePods.adoc b/content/zh/docs/_custom/clusterManagement/pods/pods-oper-deleteMultiplePods.adoc new file mode 100644 index 000000000..900dc7e02 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/pods/pods-oper-deleteMultiplePods.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: c221a68eab6c49a89248bbc09f41a6f6 +. 选择需要删除的容器组左侧的复选框，然后在容器组列表上方点击**删除**。 + +. 在**批量删除容器组**对话框，输入容器组的名称，然后点击**确定**。 ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/pods/pods-oper-openDetails.adoc b/content/zh/docs/_custom/clusterManagement/pods/pods-oper-openDetails.adoc new file mode 100644 index 000000000..d97d20ccf --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/pods/pods-oper-openDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 30ad6c73ec764c0bab8d3e7638696a4a +. 在容器组列表中点击一个容器组的名称打开其详情页面。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/pods/pods-oper-searchForPods.adoc b/content/zh/docs/_custom/clusterManagement/pods/pods-oper-searchForPods.adoc new file mode 100644 index 000000000..90b9bf46a --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/pods/pods-oper-searchForPods.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 991e787c19f9470cbc29655c78ddda5d +* 在列表上方点击搜索框并设置搜索条件，可按名称、状态或容器组 IP 地址搜索容器组。 diff --git a/content/zh/docs/_custom/clusterManagement/pods/pods-oper-viewContainerDetails.adoc b/content/zh/docs/_custom/clusterManagement/pods/pods-oper-viewContainerDetails.adoc new file mode 100644 index 000000000..bd2d7e142 --- /dev/null +++ b/content/zh/docs/_custom/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/oper-selectTimeRange.adoc[] + +include::../../../../_ks_components/oper-Autorefresh.adoc[] + +include::../../../../_ks_components/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/zh/docs/_custom/clusterManagement/pods/pods-oper-viewContainerDetails_new.adoc b/content/zh/docs/_custom/clusterManagement/pods/pods-oper-viewContainerDetails_new.adoc new file mode 100644 index 000000000..3bfbc0596 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/pods/pods-oper-viewContainerDetails_new.adoc @@ -0,0 +1,70 @@ +// :ks_include_id: 8517e102a81e4402a8f9784a7931ff0c +. 在容器组详情页面右侧的**资源状态**页签，在**容器**区域点击一个容器的名称打开容器详情页面。 + +. 在容器详情页面左侧的**属性**区域查看容器的资源属性。 ++ +-- + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群 +|容器所属的集群。 + +|项目 +|容器所属的项目。 + +|应用 +|容器所属的应用。 + +|状态 +|容器的状态。 + +include::../workloads/workloads-para-containerStatus.adoc[] + +|镜像 +|容器使用的镜像。 + +|镜像 ID +|容器使用的镜像的 ID。 + +|端口 +|容器的端口。 + +|命令 +|容器启动时在容器内部执行的命令。 + +|资源预留 +|系统为容器预留的 CPU 和内存资源。 + +|资源上限 +|容器可以使用的 CPU 和内存资源上限。 + +|镜像拉取策略 +|容器的镜像拉取策略。 + +* **优先使用本地镜像**：容器组创建或更新时，优先使用容器运行时存储在节点的镜像文件。 + +* **每次都拉取镜像**：容器组创建或更新时，每次都尝试从镜像服务拉取镜像。 + +* **仅使用本地镜像**：容器组创建或更新时，仅使用容器运行时存储在节点的镜像。如果本地不存在所需的镜像，容器创建将出现异常。 + +|重启次数 +|容器的重启次数。 +|=== +-- + +. 在容器详情页面右侧的**资源状态**页签查看容器中挂载卷、卷的挂载路径和访问模式。 + +. 在容器详情页面右侧的**环境变量**页签查看容器的环境变量。 + +// . 在容器详情页面右侧点击**容器日志**页签查看容器的标准输出日志。 +// + +// -- +// * 在右上角点击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/zh/docs/_custom/clusterManagement/pods/pods-oper-viewPodDetails.adoc b/content/zh/docs/_custom/clusterManagement/pods/pods-oper-viewPodDetails.adoc new file mode 100644 index 000000000..e0f2e3a45 --- /dev/null +++ b/content/zh/docs/_custom/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/oper-selectTimeRange.adoc[] + +include::../../../../_ks_components/oper-Autorefresh.adoc[] + +include::../../../../_ks_components/oper-refreshData.adoc[] +-- + +. 在容器组详情页面右侧点击**环境变量**页签查看容器组中的所有容器的环境变量。 + +. 在容器组详情页面右侧点击**事件**页签查看容器组相关的事件。 ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/pods/pods-oper-viewPodDetails_new.adoc b/content/zh/docs/_custom/clusterManagement/pods/pods-oper-viewPodDetails_new.adoc new file mode 100644 index 000000000..d0ded4bae --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/pods/pods-oper-viewPodDetails_new.adoc @@ -0,0 +1,99 @@ +// :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]则表明尚未完成启动步骤。 + +* **运行中**：容器组当前的状态是否为**运行中**。 + +* **容器组调度完成**：容器组是否已调度到节点。 + +* **容器组初始化完成**：容器组中的所有初始化容器是否已启动完成。 + +* **所有容器就绪**：容器组中的所有容器是否已启动完成。 + +* **容器组就绪**：容器组是否已就绪。 +|=== +-- + +. 在容器组详情页面右侧点击**元数据**页签查看容器组的标签和注解。 + +. 在容器组详情页面右侧点击**环境变量**页签查看容器组中的所有容器的环境变量。 + +. 在容器组详情页面右侧点击**事件**页签查看容器组相关的事件。 ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/pods/pods-para-podIpPool.adoc b/content/zh/docs/_custom/clusterManagement/pods/pods-para-podIpPool.adoc new file mode 100644 index 000000000..ff8e1e778 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/pods/pods-para-podIpPool.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 279e5268acd74e4bb37c530cc08cc373 +|容器组 IP 地址 +|容器组在集群内部的虚拟 IP 地址。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/pods/pods-para-podList.adoc b/content/zh/docs/_custom/clusterManagement/pods/pods-para-podList.adoc new file mode 100644 index 000000000..548d37317 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/pods/pods-para-podList.adoc @@ -0,0 +1,28 @@ +// :ks_include_id: 9b12ede280884331985685925cf5dfc4 +* 容器组列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|容器组的名称。 + +|状态 +|容器组的状态。 + +include::pods-para-podStatus.adoc[] + +|节点 +|容器组所在的节点和节点的 IP 地址。 + +include::pods-para-podIpPool.adoc[] + +|应用 +|容器组所属的应用。 + +|更新时间 +|容器组的更新时间。 +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/pods/pods-para-podStatus.adoc b/content/zh/docs/_custom/clusterManagement/pods/pods-para-podStatus.adoc new file mode 100644 index 000000000..f537a33b2 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/pods/pods-para-podStatus.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: 8cc83a9c58b8460cbcf369b1a07288b1 + +* **运行中**：容器组已分配给某个节点，容器组中的所有容器都已被创建，至少有一个容器正在运行、启动或重启。 + +* **等待中**：容组器已被系统接受，但有至少一个容器尚未创建也未运行。此状态下，容器组可能正在等待调度，或等待容器镜像下载完成。 + +* **已完成**：容器组中的所有容器都成功终止（以 0 退出码终止），并且不再重启。 + +* **失败**：容器组中的所有容器都已终止，并且至少有一个容器以非 0 退出码终止。 + +* **未知**：系统无法获取容器组状态。出现这种状态通常是由于系统与容器组所在的主机通信失败。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/pods/pods-para-qosTypes.adoc b/content/zh/docs/_custom/clusterManagement/pods/pods-para-qosTypes.adoc new file mode 100644 index 000000000..4299912c8 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/pods/pods-para-qosTypes.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 6dc8492ff19d4f1bb83db24a36e18f07 +* **Guaranteed**：容器组中的每个容器都具有内存上限、内存请求、CPU 上限、CPU 请求，并且内存上限等于内存请求，CPU 上限等于 CPU 请求。 + +* **Burstable**：容器组中至少有一个容器不满足 **Guaranteed** 类型的要求。 + +* **BestEffort**：容器组中的容器没有配置任何内存上限、内存请求、CPU 上限或CPU 请求。 + +容器组的 QoS 类型将决定容器组运行的优先级。当系统中资源不足以运行所有容器组时，系统优先保证运行 QoS 类型为 **Guaranteed** 的容器组，其次保证运行 QoS 类型为 **Burstable** 的容器组，最后保证运行 QoS 类型为 **BestEffort** 的容器组。 diff --git a/content/zh/docs/_custom/clusterManagement/projects/projects-desc-deleteProjects.adoc b/content/zh/docs/_custom/clusterManagement/projects/projects-desc-deleteProjects.adoc new file mode 100644 index 000000000..484c82ab0 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/projects/projects-desc-deleteProjects.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 375914907c6948b08ccff616aa99831d +本节介绍如何删除项目。 + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +项目删除后不能恢复，同时项目中的所有的资源也将被删除，请谨慎执行此操作。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/projects/projects-desc-editDefaultContainerQuotas.adoc b/content/zh/docs/_custom/clusterManagement/projects/projects-desc-editDefaultContainerQuotas.adoc new file mode 100644 index 000000000..cb6f6577b --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/projects/projects-desc-editDefaultContainerQuotas.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 61bf4ea84b3d4363b5a4ebfacd921138 +本节介绍如何编辑默认容器配额。 + +默认容器配额是项目中容器的资源预留和资源上限的默认值。在项目中创建容器时，如果用户未指定资源预留和资源限制，{ks_product_right}系统将自动使用默认容器配额。 + +默认容器配额包括两类设置： + +* 资源预留：系统为容器预留的资源。 + +* 资源上限：容器可使用的资源上限。 diff --git a/content/zh/docs/_custom/clusterManagement/projects/projects-desc-editInformation.adoc b/content/zh/docs/_custom/clusterManagement/projects/projects-desc-editInformation.adoc new file mode 100644 index 000000000..c793667c6 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/projects/projects-desc-editInformation.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 3b10cc989bca4453829299e49cd5a026 +本节介绍如何编辑项目信息。 diff --git a/content/zh/docs/_custom/clusterManagement/projects/projects-desc-editQuotas.adoc b/content/zh/docs/_custom/clusterManagement/projects/projects-desc-editQuotas.adoc new file mode 100644 index 000000000..e72ed9a92 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/projects/projects-desc-editQuotas.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: c47c51f776564c1bba3cf7decf79a67d +本节介绍如何编辑项目配额。 + +项目配额包括以下设置： + +* 资源预留：容器的资源预留是系统为单个容器预留的资源，项目资源预留是项目中所有容器资源预留总和的最大值。{ks_product_right}平台目前支持为项目设置 CPU 预留和内存预留。 + +* 资源上限：容器的资源上限是单个容器可使用资源的上限，项目资源上限是项目中所有容器资源上限总和的最大值。{ks_product_right}平台目前支持为项目设置 CPU 上限、内存上限和 GPU 上限。 + +* 存储资源配额：可以对命名空间下的存储资源总量进行限制，包括存储资源总量和存储类关联资源。 + +* 应用资源配额：项目中可创建的容器组、部署、有状态副本集、守护进程集、任务、定时任务、持久卷声明、服务、应用路由、保密字典、配置字典的数量上限。 diff --git a/content/zh/docs/_custom/clusterManagement/projects/projects-note-editInformation.adoc b/content/zh/docs/_custom/clusterManagement/projects/projects-note-editInformation.adoc new file mode 100644 index 000000000..92e853654 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/projects/projects-note-editInformation.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: be828c992784487d9adf58c381e48b5a +您可以编辑项目的别名和描述。{ks_product_right}不支持编辑已创建项目的名称。 diff --git a/content/zh/docs/_custom/clusterManagement/projects/projects-oper-deleteASingleProject.adoc b/content/zh/docs/_custom/clusterManagement/projects/projects-oper-deleteASingleProject.adoc new file mode 100644 index 000000000..36d633e27 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/projects/projects-oper-deleteASingleProject.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 6f57a346768f432a9a776a26c0ab55b4 +. 在需要删除的项目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除项目**对话框，输入项目的名称，然后点击**确定**。 diff --git a/content/zh/docs/_custom/clusterManagement/projects/projects-oper-deleteMultipleProjects.adoc b/content/zh/docs/_custom/clusterManagement/projects/projects-oper-deleteMultipleProjects.adoc new file mode 100644 index 000000000..bad2f8b12 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/projects/projects-oper-deleteMultipleProjects.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: c31e22ed93ad4f3fa0500c5bb67c80e3 +. 选择需要删除的项目左侧的复选框，然后在项目列表上方点击**删除**。 + +. 在**批量删除项目**对话框，输入项目的名称，然后点击**确定**。 ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/projects/projects-oper-editDefaultContainerQuotas.adoc b/content/zh/docs/_custom/clusterManagement/projects/projects-oper-editDefaultContainerQuotas.adoc new file mode 100644 index 000000000..84ba94dae --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/projects/projects-oper-editDefaultContainerQuotas.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: eae1dea548f94792b303903d436d1b25 +. 在**编辑默认容器配额**对话框，设置容器的默认资源预留和资源上限，然后点击**确定**。 ++ +-- +[options="header",cols="1a,4a"] +|=== +|参数 |描述 + +include::projects-para-containerQuotas.adoc[] +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/projects/projects-oper-editInformation.adoc b/content/zh/docs/_custom/clusterManagement/projects/projects-oper-editInformation.adoc new file mode 100644 index 000000000..28de5d112 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/projects/projects-oper-editInformation.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: a1b9b1a5e4b74f6083a9dbf399919ea3 +. 在需要操作的项目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置项目的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|项目的别名。不同项目的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|项目的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|=== +-- \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/projects/projects-oper-editProjectQuotas-for-kubefed.adoc b/content/zh/docs/_custom/clusterManagement/projects/projects-oper-editProjectQuotas-for-kubefed.adoc new file mode 100644 index 000000000..461eb64a2 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/projects/projects-oper-editProjectQuotas.adoc b/content/zh/docs/_custom/clusterManagement/projects/projects-oper-editProjectQuotas.adoc new file mode 100644 index 000000000..95db93d73 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/projects/projects-oper-editProjectQuotas.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/zh/docs/_custom/clusterManagement/projects/projects-oper-openDetailsPage.adoc b/content/zh/docs/_custom/clusterManagement/projects/projects-oper-openDetailsPage.adoc new file mode 100644 index 000000000..5d0c13e8c --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/projects/projects-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9758f6b782ed465d85796e1e69cd0d24 +. 在项目列表中点击一个项目的名称打开其详情页面。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/projects/projects-oper-openListPage.adoc b/content/zh/docs/_custom/clusterManagement/projects/projects-oper-openListPage.adoc new file mode 100644 index 000000000..10f1b2a02 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/projects/projects-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9bb9485dfa1c46809ddf90db983f76a1 +. 在**项目**页面，点击**用户项目**或**系统项目**打开用户项目列表或系统项目列表。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/projects/projects-para-aliasDescription.adoc b/content/zh/docs/_custom/clusterManagement/projects/projects-para-aliasDescription.adoc new file mode 100644 index 000000000..9af01e659 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/projects/projects-para-aliasDescription.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 33f27ee37c1e4b36a0fb2c4e22a65e3f +|别名 +|项目的别名。不同项目的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|项目的描述信息。描述可包含任意字符，最长 256 个字符。 diff --git a/content/zh/docs/_custom/clusterManagement/projects/projects-para-containerQuotas.adoc b/content/zh/docs/_custom/clusterManagement/projects/projects-para-containerQuotas.adoc new file mode 100644 index 000000000..52d249e4a --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/projects/projects-para-containerQuotas.adoc @@ -0,0 +1,18 @@ +// :ks_include_id: ed53650f20d543ee95f0aa14ff7b5f1e +|CPU 预留 +|为容器预留的 CPU 资源，单位为核。 + +|CPU 上限 +|允许容器使用的 CPU 资源上限，单位为核。 + +|内存预留 +|为容器预留的内存资源，单位为 MiB。 + +|内存上限 +|允许容器使用的内存资源上限，单位为 MiB。 + +|GPU 类型 +|对容器上限使用量的 GPU 类型。目前仅支持设置 NVDIA GPU。 + +|GPU 上限 +|允许容器使用的 GPU 数量上限，单位为 GPU。 diff --git a/content/zh/docs/_custom/clusterManagement/projects/projects-para-defaultContainerQuotas.adoc b/content/zh/docs/_custom/clusterManagement/projects/projects-para-defaultContainerQuotas.adoc new file mode 100644 index 000000000..08e55eba6 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/projects/projects-para-defaultContainerQuotas.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 405d1688f4c345f49660198dbd4b2728 +|默认容器配额 +|项目中容器的默认 CPU 预留、CPU 上限、内存预留、内存上限、GPU 类型和 GPU 上限。如果没有特别设置，项目中新创建的容器将使用项目的默认容器配额。 diff --git a/content/zh/docs/_custom/clusterManagement/projects/projects-para-name.adoc b/content/zh/docs/_custom/clusterManagement/projects/projects-para-name.adoc new file mode 100644 index 000000000..69247f459 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/projects/projects-para-name.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 2e7858bd5eb64ceab90c370e0337800c +|名称 +|项目的名称。同一集群中的项目名称不能重复。名称只能包含小写字母、数字和连字符（-），必须以小写字母开头并以小写字母或数字结尾，最长 63 个字符。 diff --git a/content/zh/docs/_custom/clusterManagement/projects/projects-para-projectQuotas.adoc b/content/zh/docs/_custom/clusterManagement/projects/projects-para-projectQuotas.adoc new file mode 100644 index 000000000..7b7ff8931 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/projects/projects-para-projectQuotas.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: 73b804640f4d4157bd471a68e571e284 +|项目配额 +|项目中可用资源的数量和实际使用量，包括： + +* 项目中所有容器的 CPU 预留、CPU 上限、内存预留、内存上限、GPU 类型和 GPU 上限。 + +* 项目中允许创建的部署、有状态副本集、守护进程集、任务、定时任务、卷、服务、应用路由、保密字典和配置字典的最大数量。 diff --git a/content/zh/docs/_custom/clusterManagement/projects/projects-para-status.adoc b/content/zh/docs/_custom/clusterManagement/projects/projects-para-status.adoc new file mode 100644 index 000000000..b16fef5a1 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/projects/projects-para-status.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 278f7336e01e4f89b34d41a866b7acd0 +项目当前所处的状态。 + +* **活跃**：项目状态正常。 + +* **删除中**：项目正在删除中。 diff --git a/content/zh/docs/_custom/clusterManagement/routes/routes-desc-accessABackendServiceOfARoute.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-desc-accessABackendServiceOfARoute.adoc new file mode 100644 index 000000000..699c267f7 --- /dev/null +++ b/content/zh/docs/_custom/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_left} Web 控制台测试应用路由是否设置正确。 diff --git a/content/zh/docs/_custom/clusterManagement/routes/routes-desc-createARoute.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-desc-createARoute.adoc new file mode 100644 index 000000000..1c1ac0ecf --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/routes/routes-desc-createARoute.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 797c5d8830fe45bfb4452dd98086d8ed +本节介绍如何创建应用路由。 diff --git a/content/zh/docs/_custom/clusterManagement/routes/routes-desc-deleteMultipleRoutes.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-desc-deleteMultipleRoutes.adoc new file mode 100644 index 000000000..e1cc5572f --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/routes/routes-desc-deleteMultipleRoutes.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 4f3a812c48b342fdb0cec7f38b00ce81 +本节介绍如何删除应用路由。 + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +删除应用路由后将无法通过应用路由访问其后端的服务，请谨慎执行此操作。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/routes/routes-desc-editRouteAnnotations.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-desc-editRouteAnnotations.adoc new file mode 100644 index 000000000..4624887ba --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/routes/routes-desc-editRouteAnnotations.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9a1f0d5fdb294c79a6051a90fe1a17be +本节介绍如何编辑应用路由注解。 diff --git a/content/zh/docs/_custom/clusterManagement/routes/routes-desc-editRouteInformation.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-desc-editRouteInformation.adoc new file mode 100644 index 000000000..2b6f974d3 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/routes/routes-desc-editRouteInformation.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: ab9cb5143fe449bb900ce47e7fb62049 +本节介绍如何编辑应用路由信息。 + +您可以编辑应用路由的别名和描述。{ks_product_right}不支持编辑已创建应用路由的名称。 diff --git a/content/zh/docs/_custom/clusterManagement/routes/routes-desc-editingRutingRules.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-desc-editingRutingRules.adoc new file mode 100644 index 000000000..e3aa5e477 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/routes/routes-desc-editingRutingRules.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: b4c404ff621146f799e720597d3aac84 +本节介绍如何编辑路由规则。 diff --git a/content/zh/docs/_custom/clusterManagement/routes/routes-desc-routes.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-desc-routes.adoc new file mode 100644 index 000000000..7a1918009 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/routes/routes-desc-routes.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: c69900173bca4b109a4b8a178ce15e64 +本节介绍如何管理应用路由。 + +应用路由用于对服务进行聚合并提供给集群外部访问。每个应用路由包含域名及其子路径到不同服务的映射规则。来自客户端的业务流量先发送给集群网关或项目网关，集群网关或项目网关根据应用路由中定义的规则将业务流量转发给不同的服务，从而实现对多个服务的反向代理。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/routes/routes-desc-viewARouteList.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-desc-viewARouteList.adoc new file mode 100644 index 000000000..c90792cf4 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/routes/routes-desc-viewARouteList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 74e87c7e7c4a42b59f6c9013b617a2f7 +本节介绍如何查看应用路由列表。 diff --git a/content/zh/docs/_custom/clusterManagement/routes/routes-desc-viewRouteDetails.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-desc-viewRouteDetails.adoc new file mode 100644 index 000000000..973006db1 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/routes/routes-desc-viewRouteDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c74f0c52dbf440a98ed71f677036f155 +本节介绍如何查看应用路由详情。 diff --git a/content/zh/docs/_custom/clusterManagement/routes/routes-note-annotations.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-note-annotations.adoc new file mode 100644 index 000000000..5effac052 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/routes/routes-note-annotations.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: b5b7ecc42a4f49a583613c4e211cd53f +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +{ks_product_right}的集群网关和项目网关底层基于 Nginx Ingress Controller 实现。您可以在应用路由上设置注解控制网关的行为。有关更多信息，请参阅 link:https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/[Nginx Ingress Controller 官方文档]。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/routes/routes-oper-accessABackendServiceOfARoute.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-oper-accessABackendServiceOfARoute.adoc new file mode 100644 index 000000000..12d49c42b --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/routes/routes-oper-accessABackendServiceOfARoute.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: f51f45c2029a4242ad04da5a1fe817c7 +. 在**资源状态**页签，在需要访问的路由规则右侧点击**访问服务**。 ++ +-- +如果应用路由设置正确，浏览器将显示后端服务的响应信息。 +-- diff --git a/content/zh/docs/_custom/clusterManagement/routes/routes-oper-createARoute.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-oper-createARoute.adoc new file mode 100644 index 000000000..e76b41733 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/routes/routes-oper-createARoute_v4.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-oper-createARoute_v4.adoc new file mode 100644 index 000000000..abfa74d5e --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/routes/routes-oper-deleteASingleRoute.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-oper-deleteASingleRoute.adoc new file mode 100644 index 000000000..09b73480f --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/routes/routes-oper-deleteRoutes.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-oper-deleteRoutes.adoc new file mode 100644 index 000000000..536468c05 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/routes/routes-oper-deleteRoutes.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 6ec380c8bcbe4e1589334e0b050b0b6c +. 选择需要删除的应用路由左侧的复选框，然后在应用路由列表上方点击**删除**。 + +. 在**批量删除应用路由**对话框，输入应用路由的名称，然后点击**确定**。 ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/routes/routes-oper-editRouteAnnotations.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-oper-editRouteAnnotations.adoc new file mode 100644 index 000000000..bb9c9bf62 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/routes/routes-oper-editRouteInformation.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-oper-editRouteInformation.adoc new file mode 100644 index 000000000..63873270a --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/routes/routes-oper-editRoutingRules.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-oper-editRoutingRules.adoc new file mode 100644 index 000000000..5eb07ec8d --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/routes/routes-oper-openDetailsPage.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-oper-openDetailsPage.adoc new file mode 100644 index 000000000..0e7bcfcb7 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/routes/routes-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 01c521d890b44fab91dfa6803d6a6bb5 +. 在应用路由列表中点击一个应用路由的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/clusterManagement/routes/routes-oper-searchForRoutes.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-oper-searchForRoutes.adoc new file mode 100644 index 000000000..1b3de39de --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/routes/routes-oper-searchForRoutes.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: a3a4d6c4c46d4b8dbf054da9c20cd804 +* 在列表上方点击搜索框并设置搜索条件，可按名称搜索应用路由。 diff --git a/content/zh/docs/_custom/clusterManagement/routes/routes-oper-viewRouteDetails-for-kubefed.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-oper-viewRouteDetails-for-kubefed.adoc new file mode 100644 index 000000000..2b9693b76 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/routes/routes-oper-viewRouteDetails.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-oper-viewRouteDetails.adoc new file mode 100644 index 000000000..b9719abb1 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/routes/routes-para-routeList.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-para-routeList.adoc new file mode 100644 index 000000000..f8b10f72a --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/routes/routes-para-routingRules.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-para-routingRules.adoc new file mode 100644 index 000000000..4f97c8493 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/routes/routes-prer-accessABackendServiceOfARoute.adoc b/content/zh/docs/_custom/clusterManagement/routes/routes-prer-accessABackendServiceOfARoute.adoc new file mode 100644 index 000000000..e7b5f61ac --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/routes/routes-prer-accessABackendServiceOfARoute.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: d8a06afae96b4c0bbb29c390f1fe18f5 +* 客户端必须通过本地 **hosts** 文件或 DNS 服务将域名解析为网关 IP 地址。 + +* 客户端必须与网关 IP 地址网络连通。有关更多信息，请联系您的网络环境管理员。 diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-alertingPolicies.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-alertingPolicies.adoc new file mode 100644 index 000000000..65ae5caa6 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-alertingPolicies.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 1cfd19f4d02645328faf321e1d5af473 +本节介绍如何创建、编辑、启用、禁用和查看告警规则组。 + +{ks_product_right}提供了内置的规则组，同时也支持自定义规则组。通过规则组，系统可在特定监控指标满足预设条件和持续时间时生成告警。 diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-createAnAlertingPolicy.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-createAnAlertingPolicy.adoc new file mode 100644 index 000000000..6c58383c3 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-createAnAlertingPolicy.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: e19cfac61c85491d9f631ba61f012c62 +本节介绍如何创建告警规则组。 + +{ks_product_right}的监控告警功能底层基于 Promtheus 实现，每个规则组可包含多条告警规则。您可以使用系统提供的规则模板创建告警规则，也可手动输入 PromQL 表达式创建告警规则。有关更多信息，请参阅 link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus 官方文档]。 diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-deleteAlertingPolicies.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-deleteAlertingPolicies.adoc new file mode 100644 index 000000000..d535ae8e1 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-deleteAlertingPolicies.adoc @@ -0,0 +1,16 @@ +// :ks_include_id: afa42dbe50664f968d66928b7d9b75d6 +本节介绍如何删除告警规则组。 + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +{ks_product_right}仅支持删除自定义规则组，不支持删除内置规则组。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +规则组删除后不能恢复，请谨慎执行此操作。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-disableAndEnablerRuleGroups.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-disableAndEnablerRuleGroups.adoc new file mode 100644 index 000000000..4969e4533 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-disableAndEnablerRuleGroups.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 43829ece490644d8ba2c2e823ad90719 +本节介绍如何启用和禁用告警规则组。规则组禁用后，系统将不再根据规则组生成告警。 diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-editAnAlertingPolicy.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-editAnAlertingPolicy.adoc new file mode 100644 index 000000000..05a4b1665 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-editAnAlertingPolicy.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 50920b439c7f4f4e996fecec215f24ed +本节介绍如何编辑规则组中的告警规则。 + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +{ks_product_right}仅支持编辑自定义规则组，不支持编辑内置规则组。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-editRuleGroupInformation.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-editRuleGroupInformation.adoc new file mode 100644 index 000000000..38c87a061 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-editRuleGroupInformation.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: d62dbb9307bf4f21a25a732737dbe531 +本节介绍如何编辑告警规则组信息。 + +您可以编辑告警规则组的别名、检查周期和描述。{ks_product_right}不支持编辑规则组的名称。 diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-viewAlertingPolicyDetails.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-viewAlertingPolicyDetails.adoc new file mode 100644 index 000000000..3e78ae8f8 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-viewAlertingPolicyDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 60f5fd04585b4a97bb5c99721f03edcb +本节介绍如何查看告警规则组详情。 diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-viewAnAlertingPolicyList.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-viewAnAlertingPolicyList.adoc new file mode 100644 index 000000000..ca6ae86b5 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-desc-viewAnAlertingPolicyList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 75e22548eee741e48e1bcf6c7499fc65 +本节介绍如何查看告警规则组列表。 diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-addAlertRule.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-addAlertRule.adoc new file mode 100644 index 000000000..a2a5defb7 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-addAlertRule.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: b8f6aaa1104a42b3a0856ce1f21e1cea +. 在**告警规则**页签，点击**添加告警规则**，根据需要选择**规则模板**或**自定义规则**设置告警规则。 diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-clickEditInformation.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-clickEditInformation.adoc new file mode 100644 index 000000000..d0c99e3b8 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-clickOK.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-clickOK.adoc new file mode 100644 index 000000000..e65b60517 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-deleteASingleAlertingPolicy.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-deleteASingleAlertingPolicy.adoc new file mode 100644 index 000000000..2e811a793 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-deleteMultipleAlertingPolicies.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-deleteMultipleAlertingPolicies.adoc new file mode 100644 index 000000000..1d9f80a10 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-deleteMultipleAlertingPolicies.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: c98f892c063d4948889dcb04d2bef599 +. 勾选需要删除的规则组左侧的复选框，然后在规则组列表上方点击**删除**。 + +. 在**批量删除规则组**对话框，输入规则组的名称，然后点击**确定**。 ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableASingleRuleGroup.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableASingleRuleGroup.adoc new file mode 100644 index 000000000..d402cee96 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableMultipleRuleGroups.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableMultipleRuleGroups.adoc new file mode 100644 index 000000000..622ae710d --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableMultipleRuleGroups.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 76fde78ac7ba4fef9a7a125fa849713d +. 勾选需要禁用的规则组左侧的复选框，然后在规则组列表上方点击**禁用**。 + +. 在**批量禁用规则组**对话框，输入规则组的名称，然后点击**确定**。 ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- + +. 勾选已禁用的规则组左侧的复选框，然后在规则组列表上方点击**启用**可批量启用规则组。 diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-editAlertRules.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-editAlertRules.adoc new file mode 100644 index 000000000..e304e1a08 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-editAnAlertingPolicy.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-editAnAlertingPolicy.adoc new file mode 100644 index 000000000..69e29e4ee --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-editRuleGroupInformation.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-editRuleGroupInformation.adoc new file mode 100644 index 000000000..ebf602eca --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-openDetailsPage.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-openDetailsPage.adoc new file mode 100644 index 000000000..f1cfe14de --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 8ada03e949d64141806728273792c325 +. 在**规则组**页面，点击**自定义规则组**或**内置规则组**，然后在列表中点击一个规则组的名称打开其详情页面。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc new file mode 100644 index 000000000..bb61ef20c --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 6b961b60bdf64acab9b19b9c28b5fb3e +. 在**规则组**页面，点击**自定义规则组**或**内置规则组**打开规则组列表。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-searchForAlertingPolicies.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-searchForAlertingPolicies.adoc new file mode 100644 index 000000000..d1037bf25 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-searchForAlertingPolicies.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d6ed4db86bde40cbaa6d3dbebecda452 +* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的规则组。 diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-setBasicInfo.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-setBasicInfo.adoc new file mode 100644 index 000000000..a4ae3a8e4 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-viewAlertingPolicyDetails.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-oper-viewAlertingPolicyDetails.adoc new file mode 100644 index 000000000..322229acf --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-activationTime.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-activationTime.adoc new file mode 100644 index 000000000..10e81afea --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-activationTime.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c3b29bad32424d7abc3be2e77357df17 +规则组由**未触发**状态变为**验证中**状态的时间。 diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-alertLevel.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-alertLevel.adoc new file mode 100644 index 000000000..7c6d57e33 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-alertLevel.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 63afbb864bc3418ca45d632bcda4ba1d +告警的级别，包括**提醒、警告、重要、紧急**。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList.adoc new file mode 100644 index 000000000..5062633df --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList_whizard.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList_whizard.adoc new file mode 100644 index 000000000..7518c9316 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-alertingStatusDisabled.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-alertingStatusDisabled.adoc new file mode 100644 index 000000000..b85f18905 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-alertingStatusDisabled.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: a88a0cc5a6db44ab923dd629c50bafd4 +* **已禁用**：告警规则已被禁用。 diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-alertingStatusInactive.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-alertingStatusInactive.adoc new file mode 100644 index 000000000..40fb5efa5 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-alertingStatusInactive.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 6bf2b0acd7e043fc8ef1328d3b45bec3 +* **未触发**：监控指标未满足预设的条件。此状态下系统不生成告警。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-aliasCheckIntervalDescription.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-aliasCheckIntervalDescription.adoc new file mode 100644 index 000000000..a84ebc29b --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-aliasCheckIntervalDescription.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: 154069b262b94648a55d983b0875f8c6 +|别名 +|规则组的别名。不同规则组的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|检查间隔 +|指标检查之间的时间间隔。默认值为 1 分钟。 + +|描述 +|规则组的描述信息。 + +描述可包含任意字符，最长 256 个字符。 diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-message.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-message.adoc new file mode 100644 index 000000000..95ffe2c8d --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-message.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 5f7a598e105f43558afe250665ee56d2 +告警消息的概要和详情。如果未设置消息的详情，**消息**列将显示告警规则组的概要。 diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-ruleGroupStatus.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-ruleGroupStatus.adoc new file mode 100644 index 000000000..e9a544e15 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-ruleGroupStatus.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: d4684807ee1d4a93ac734c072d1ce511 +|规则组状态 +|规则组当前是否已启用。 diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-timeSpent.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-timeSpent.adoc new file mode 100644 index 000000000..3019cc365 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-para-timeSpent.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 83be107bbcde41f7a4e73bae25c1e923 +|耗时 +|最近一次指标检查所花费的时间。 diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-prer-creationPrerequisites.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-prer-creationPrerequisites.adoc new file mode 100644 index 000000000..61042f605 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-prer-creationPrerequisites.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: e40e965d1a704b41a1d1e33374d37a60 +ifeval::["{file_output_type}" == "html"] + +* {ks_product_right}平台需要启用告警系统扩展组件。 + +endif::[] + +ifeval::["{file_output_type}" == "pdf"] + +* {ks_product_right}平台需要启用告警系统扩展组件。关于更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。 + +endif::[] diff --git a/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-prer-exposeMetrics.adoc b/content/zh/docs/_custom/clusterManagement/ruleGroups/ruleGroups-prer-exposeMetrics.adoc new file mode 100644 index 000000000..b94864134 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/secrets/secrets-desc-createASecret.adoc b/content/zh/docs/_custom/clusterManagement/secrets/secrets-desc-createASecret.adoc new file mode 100644 index 000000000..9b8509014 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/secrets/secrets-desc-createASecret.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 71d8939bb0c34d539622e5d839efa46f +本节介绍如何创建保密字典。 diff --git a/content/zh/docs/_custom/clusterManagement/secrets/secrets-desc-deleteSecrets.adoc b/content/zh/docs/_custom/clusterManagement/secrets/secrets-desc-deleteSecrets.adoc new file mode 100644 index 000000000..1da7700f0 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/secrets/secrets-desc-deleteSecrets.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: d9c8601d3a1f45e9857955c91e42c618 +本节介绍如何删除保密字典。 + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +保密字典删除后不能恢复，请谨慎执行此操作。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/secrets/secrets-desc-editSecretInformation.adoc b/content/zh/docs/_custom/clusterManagement/secrets/secrets-desc-editSecretInformation.adoc new file mode 100644 index 000000000..4c74ec3a1 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/secrets/secrets-desc-editSecretInformation.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: f8540b0bc54f45419444702eb08c3a6b +本节介绍如何编辑保密字典信息。 + +您可以编辑保密字典的别名和描述。{ks_product_right}不支持编辑保密字典的名称。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/secrets/secrets-desc-editSecretSettings.adoc b/content/zh/docs/_custom/clusterManagement/secrets/secrets-desc-editSecretSettings.adoc new file mode 100644 index 000000000..72d6f122d --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/secrets/secrets-desc-editSecretSettings.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: f7e3ff6a6c4d438995c3985f52dbf42d +本节介绍如何编辑保密字典的设置。 + +您可以编辑密码字典的数据。{ks_product_right}不支持编辑保密字典的类型。 diff --git a/content/zh/docs/_custom/clusterManagement/secrets/secrets-desc-secrets.adoc b/content/zh/docs/_custom/clusterManagement/secrets/secrets-desc-secrets.adoc new file mode 100644 index 000000000..9a257e853 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/secrets/secrets-desc-secrets.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 080455a800324a07a3042a4d85261101 +本节介绍如何管理保密字典。 + +保密字典（Secret）用于存储和管理密码、令牌和密钥等保密数据。保密字典可独立于使用保密字典的容器组而创建，减少了数据暴露的风险。 diff --git a/content/zh/docs/_custom/clusterManagement/secrets/secrets-desc-viewASecretList.adoc b/content/zh/docs/_custom/clusterManagement/secrets/secrets-desc-viewASecretList.adoc new file mode 100644 index 000000000..b469f3b90 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/secrets/secrets-desc-viewASecretList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c0f08b4b8a8b4ecb9361495af62b9e04 +本节介绍如何查看保密字典列表。 diff --git a/content/zh/docs/_custom/clusterManagement/secrets/secrets-desc-viewSecretDetails.adoc b/content/zh/docs/_custom/clusterManagement/secrets/secrets-desc-viewSecretDetails.adoc new file mode 100644 index 000000000..367dd7a43 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/secrets/secrets-desc-viewSecretDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 16ab2925bc4a4890949bea03ff0d3123 +本节介绍如何查看保密字典详情。 diff --git a/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-createASecret.adoc b/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-createASecret.adoc new file mode 100644 index 000000000..fe3a16964 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-createASecret.adoc @@ -0,0 +1,50 @@ +// :ks_include_id: 554d961566e24e45a4faba216b099e2c +. 在**基本信息**页签，设置保密字典的基本信息，然后点击**下一步**。 ++ +-- +[%header,cols="1,4"] +|=== +|参数 |描述 + +|名称 +|保密字典的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 + +|别名 +|保密字典的别名。不同保密字典的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|项目 +|保密字典所属的项目。 + +|描述 +|保密字典的描述信息。描述可包含任意字符，最长 256 个字符。 +|=== +-- + +. 在**数据设置**页签，在**类型**下拉列表中选择保密字典的数据类型。 ++ +-- +[%header,cols="1a,4a"] +|=== +|类型 |描述 + +|默认 +|用于存储用户自定义的数据。 + +|TLS 信息 +|用于存储 TLS 证书和私钥。 + +|镜像服务信息 +|用于存储镜像服务的地址、用户名、邮箱和密码。 + +|用户名和密码 +|用于存储用户名和密码。 +|=== +-- + +. 在**数据设置**页签，根据保密字典的类型设置保密字典的数据，然后点击**创建**。 ++ +==== +include::secrets-para-dataKeys.adoc[] + +保密字典创建完成后将显示在保密字典列表中。 +==== diff --git a/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-deleteASingleSecret.adoc b/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-deleteASingleSecret.adoc new file mode 100644 index 000000000..70f31c330 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-deleteASingleSecret.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: efa6eca3dcdc40ffb7fc1b3a06351564 +. 在需要删除的保密字典右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除保密字典**对话框，输入保密字典的名称，然后点击**确定**。 diff --git a/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-deleteMultipleSecrets.adoc b/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-deleteMultipleSecrets.adoc new file mode 100644 index 000000000..3028c7d5c --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-deleteMultipleSecrets.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 821fd61185284238be5f5ef2b967af30 +. 选择需要删除的保密字典左侧的复选框，然后在保密字典列表上方点击**删除**。 + +. 在**批量删除保密字典**对话框，输入保密字典的名称，然后点击**确定**。 ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-editSecretInformation.adoc b/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-editSecretInformation.adoc new file mode 100644 index 000000000..deb77bc78 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-editSecretInformation.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: 1936af45de46421dbe6053add93e1dfb +. 在需要操作的保密字典右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置保密字典的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|保密字典的别名。不同保密字典的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|保密字典的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-editSecretSettings.adoc b/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-editSecretSettings.adoc new file mode 100644 index 000000000..1d1920417 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-editSecretSettings.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: db7ae2d378f645d184b0930c64e21946 +. 在需要编辑的保密字典右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑设置**。 + +. 在**编辑设置**对话框，根据保密字典的类型设置保密字典的数据，然后点击**确定**。 ++ +==== +include::secrets-para-dataKeys.adoc[] +==== diff --git a/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-openSecretDetailsPage.adoc b/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-openSecretDetailsPage.adoc new file mode 100644 index 000000000..b62fa8e28 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-openSecretDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 66b6fbe3a020418f953eb21eeeeccd4b +. 在保密字典列表中点击一个保密字典的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-searchForSecrets.adoc b/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-searchForSecrets.adoc new file mode 100644 index 000000000..1e5c29c75 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-searchForSecrets.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d4c2e8700f704fc387d1e57b8ee00641 +* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的保密字典。 diff --git a/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-viewSecretDetails-for-kubefed.adoc b/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-viewSecretDetails-for-kubefed.adoc new file mode 100644 index 000000000..5a999d294 --- /dev/null +++ b/content/zh/docs/_custom/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/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/admonitions/admonEnd.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-viewSecretDetails.adoc b/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-viewSecretDetails.adoc new file mode 100644 index 000000000..8a06a0386 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/secrets/secrets-oper-viewSecretDetails.adoc @@ -0,0 +1,37 @@ +// :ks_include_id: a53d1d6e1dd4460e8fc6ff4476b08e2c +. 在保密字典详情页面左侧的**属性**区域查看保密字典的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群 +|保密字典所属的集群。 + +|项目 +|保密字典所属的项目。 + +|类型 +| +include::secrets-para-type.adoc[] + +|创建时间 +|保密字典的创建时间。 + +|创建者 +|创建保密字典的用户。 + +|=== +-- + +. 在保密字典右侧的**数据**页签查看保密字典存储的键值对数据。 ++ +-- +// Note +include::../../../../_ks_components/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/admonitions/admonEnd.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/secrets/secrets-para-data.adoc b/content/zh/docs/_custom/clusterManagement/secrets/secrets-para-data.adoc new file mode 100644 index 000000000..61321b85d --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/secrets/secrets-para-data.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: d6fa7773eca94740994a340c203a6f69 +* 点击**添加数据**可设置添加键值对数据。 + +* 将光标悬停在已创建的数据条目上，然后在右侧点击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]，可删除数据条目。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/secrets/secrets-para-dataKeys.adoc b/content/zh/docs/_custom/clusterManagement/secrets/secrets-para-dataKeys.adoc new file mode 100644 index 000000000..c51d23183 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/secrets/secrets-para-dataKeys.adoc @@ -0,0 +1,72 @@ +// :ks_include_id: ab9267c3315d4f28b1e85cc72fff87f0 +* 对于**默认**类型的保密字典，设置以下参数： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|数据 +|设置用户自定义的键值对数据。 + +include::secrets-para-data.adoc[] +|=== +-- + +* 对于**TLS 信息**类型的保密字典，设置以下参数： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|证书 +|TLS 证书。 + +|私钥 +|TLS 私钥。 +|=== +-- + +* 对于**镜像服务信息**类型的保密字典，设置以下参数： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|镜像服务地址 +|镜像服务的地址。点击下拉列表可选择 HTTP 或 HTTPS 协议。 + +|用户名 +|用于访问镜像服务的用户名。 + +|邮箱 +|用于访问镜像服务的用户的邮箱。 + +|密码 +|用于访问镜像服务的密码。 + +* 点击**验证**可检查密码是否正确。 + +* 点击image:/images/ks-qkcp/zh/icons/eye.svg[eye,18,18]/image:/images/ks-qkcp/zh/icons/eye-closed.svg[eye-closed,18,18]可显示/隐藏密码明文。 + +|数据 +|用于访问镜像服务的键值对数据。 +|=== +-- + +* 对于**用户名和密码**类型的保密字典，设置以下参数： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|用户名 +|用户自定义的用户名。 + +|密码 +|用户自定义的密码。点击image:/images/ks-qkcp/zh/icons/eye.svg[eye,18,18]/image:/images/ks-qkcp/zh/icons/eye-closed.svg[eye-closed,18,18]可显示/隐藏密码明文。 +|=== +-- \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/secrets/secrets-para-secretList.adoc b/content/zh/docs/_custom/clusterManagement/secrets/secrets-para-secretList.adoc new file mode 100644 index 000000000..dbb1ec015 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/secrets/secrets-para-secretList.adoc @@ -0,0 +1,32 @@ +// :ks_include_id: 3bb84bf9d5e64bba80d8816c9176ed82 +* 保密字典列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|保密字典的名称和描述。 + +ifdef::kubefed[] +|状态 +|保密字典当前的状态。 +endif::[] + +ifndef::kubefed[] +|项目 +|保密字典所属的项目。 +endif::[] + +|类型 +| +include::secrets-para-type.adoc[] + +|字段数量 +|保密字典中字段的数量。 + +|创建时间 +|保密字典的创建时间。 +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/secrets/secrets-para-type.adoc b/content/zh/docs/_custom/clusterManagement/secrets/secrets-para-type.adoc new file mode 100644 index 000000000..acf72adab --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/secrets/secrets-para-type.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 6e6d31a78576444f97059976c8f49b40 +保密字典的类型。 + +* **默认**：默认的保密字典类型，用于存储用户自定义的数据。 + +* **TLS 信息**：用于存储 TLS 证书和私钥。 + +* **镜像服务信息**：用于存储镜像服务访问信息。 + +* **用户名和密码**：用于存储用户名和密码。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-changeTheRoleOfAServiceAccount.adoc b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-changeTheRoleOfAServiceAccount.adoc new file mode 100644 index 000000000..aa689ff0c --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-changeTheRoleOfAServiceAccount.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: ba5fe4574cc24a7d9283273f06f7dd26 +本节介绍如何修改服务帐户角色。 + +您可以通过为服务帐户分配角色来控制服务帐户的权限，使服务帐户可以访问特定的资源和进行特定的操作。 diff --git a/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-createAServiceAccount.adoc b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-createAServiceAccount.adoc new file mode 100644 index 000000000..05ee69bb0 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-createAServiceAccount.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 3f60a878ee8940e9b3cbf10f3353b92f +本节介绍如何创建服务帐户。 diff --git a/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-deleteServiceAccounts.adoc b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-deleteServiceAccounts.adoc new file mode 100644 index 000000000..97d5ce8b9 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-deleteServiceAccounts.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: bae57f78f3d540a093423af565ca9662 +本节介绍如何删除服务帐户。 + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +服务帐户删除后，使用服务帐户的应用程序将不能访问{ks_product_both}集群，请谨慎执行此操作。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-editServiceAccountInformation.adoc b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-editServiceAccountInformation.adoc new file mode 100644 index 000000000..5dfbb8e19 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-editServiceAccountInformation.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: efea9d6ad99a4b8c95572d4576118696 +本节介绍如何编辑服务帐户的信息。 + +您可以编辑服务帐户的别名和描述。{ks_product_right}不支持编辑服务帐户的名称。 diff --git a/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-serviceAccounts.adoc b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-serviceAccounts.adoc new file mode 100644 index 000000000..ea44a218b --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-serviceAccounts.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: 70a468aff118486786c391c4db2f2080 +本节介绍如何管理服务帐户。 + +服务帐户是{ks_product_both}对应用程序提供的特殊帐户，集群内部或外部的应用程序可以使用服务帐户访问{ks_product_both}系统的 API 服务器。 + +服务帐户与用户帐户的区别在于： + +* 服务帐户不能使用用户名和密码进行认证，只能通过令牌对认证。 + +* 服务帐户不能通过浏览器登录{ks_product_left} Web 控制台。 + +您可以创建服务帐户，并通过为其分配项目角色来控制服务帐户的权限，使服务帐户可以访问特定的资源和执行特定的操作。系统自动在每个项目中创建一个名称为 **default** 的服务帐户。创建容器组时，如果没有指定服务帐户，容器组会被分配项目中的 **default** 服务帐户。 diff --git a/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-viewAServiceAccountList.adoc b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-viewAServiceAccountList.adoc new file mode 100644 index 000000000..b39819e73 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-viewAServiceAccountList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: db44d5dd1fb14ca493ad5092790712ab +本节介绍如何查看集群中服务帐户的列表。 diff --git a/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-viewServiceAccountDetails.adoc b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-viewServiceAccountDetails.adoc new file mode 100644 index 000000000..77282a69e --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-viewServiceAccountDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: adfcea0c202840f8b8a7a9070b6072b5 +本节介绍如何查看服务帐户详情。 diff --git a/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-changeTheRoleOfAServiceAccount.adoc b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-changeTheRoleOfAServiceAccount.adoc new file mode 100644 index 000000000..5aee0e69f --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-changeTheRoleOfAServiceAccount.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 32395ef55e91403f8791e1ac23036ee1 +. 在需要操作的服务帐户右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**修改角色**。 + +. 在**修改角色**对话框，从下拉列表中选择一个项目角色，然后点击**确定**。 diff --git a/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-createAServiceAccount.adoc b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-createAServiceAccount.adoc new file mode 100644 index 000000000..86d93c26d --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-createAServiceAccount.adoc @@ -0,0 +1,28 @@ +// :ks_include_id: 6e68b7990c884ed4bff37bc5f2891664 +. 在服务帐户列表页面，点击**创建**。 + +. 在**创建服务帐户**对话框，设置服务帐户的信息，然后点击**创建**。 ++ +-- +[%header,cols="1,3"] +|=== +|参数 |描述 + +|名称 +|服务帐户名称。同一项目中的服务帐户名称不能重复。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 + +|别名 +|用户自定义的服务帐户别名。不同服务帐户的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|项目 +|服务帐户所属的项目。 + +|描述 +|服务帐户的描述信息。描述可包含任意字符，最长 256 个字符。 + +|项目角色 +|服务帐户在项目中的角色。服务帐户的角色将决定服务帐户在项目中的权限。 +|=== + +服务帐户创建完成后将显示在服务帐户列表中。 +-- 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 new file mode 100644 index 000000000..86d93c26d --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-createAServiceAccount_new.adoc @@ -0,0 +1,28 @@ +// :ks_include_id: 6e68b7990c884ed4bff37bc5f2891664 +. 在服务帐户列表页面，点击**创建**。 + +. 在**创建服务帐户**对话框，设置服务帐户的信息，然后点击**创建**。 ++ +-- +[%header,cols="1,3"] +|=== +|参数 |描述 + +|名称 +|服务帐户名称。同一项目中的服务帐户名称不能重复。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 + +|别名 +|用户自定义的服务帐户别名。不同服务帐户的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|项目 +|服务帐户所属的项目。 + +|描述 +|服务帐户的描述信息。描述可包含任意字符，最长 256 个字符。 + +|项目角色 +|服务帐户在项目中的角色。服务帐户的角色将决定服务帐户在项目中的权限。 +|=== + +服务帐户创建完成后将显示在服务帐户列表中。 +-- diff --git a/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-deleteASingleServiceAccount.adoc b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-deleteASingleServiceAccount.adoc new file mode 100644 index 000000000..e0d55dfcb --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-deleteASingleServiceAccount.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: c89315ef4a4f4466b0e17cab3c84d42d +. 在需要删除的服务帐户右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除服务帐户**对话框，输入服务帐户的名称，然后点击**确定**。 diff --git a/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-deleteMultipleServiceAccounts.adoc b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-deleteMultipleServiceAccounts.adoc new file mode 100644 index 000000000..c310038bd --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-deleteMultipleServiceAccounts.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 6f5328039add4cdd843da743a785aaa7 +. 选择需要删除的服务帐户左侧的复选框，然后在服务帐户列表上方点击**删除**。 + +. 在**批量删除服务帐户**对话框，输入服务帐户的名称，然后点击**确定**。 ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-editServiceAccountInformation.adoc b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-editServiceAccountInformation.adoc new file mode 100644 index 000000000..829ce3580 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-editServiceAccountInformation.adoc @@ -0,0 +1,18 @@ +// :ks_include_id: 0c947100d2d64d5bac82ac928668cf08 +. 在需要操作的服务帐户右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，编辑服务帐户的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|服务帐户的别名。不同服务帐户的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|服务帐户的描述信息。描述可包含任意字符，最多包含 256 个字符。 + +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-openDetailsPage.adoc b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-openDetailsPage.adoc new file mode 100644 index 000000000..54829e6f5 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 0dd2fb366a564cfba068b299483485f0 +. 在服务帐户列表中点击一个服务帐户的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-searchForServiceAccounts.adoc b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-searchForServiceAccounts.adoc new file mode 100644 index 000000000..ec6e5742d --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-searchForServiceAccounts.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 31e6141a68d9431abf8e41e8ace22103 +* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的服务帐户。 diff --git a/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-viewServiceAccountDetails.adoc b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-viewServiceAccountDetails.adoc new file mode 100644 index 000000000..9a2215c2a --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-viewServiceAccountDetails.adoc @@ -0,0 +1,39 @@ +// :ks_include_id: e5b9851cb29d403d866fb8074f76b2e6 +. 在服务帐户详情页面左侧的**属性**区域查看服务帐户的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群 +|服务帐户所属的集群。 + +|项目 +|服务帐户所属的项目。 + +|角色 +|服务帐户在所属项目中的角色。 + +|创建时间 +|服务帐户的创建时间。 + +|创建者 +|创建服务帐户的用户。 +|=== +-- + +. 在服务帐户详情页面右侧的**数据**页签查看服务帐户的认证信息和对应的 kubeconfig 信息。 ++ +-- +* 在**数据设置**区域右上角点击image:/images/ks-qkcp/zh/icons/eye-closed.svg[show,18,18]/image:/images/ks-qkcp/zh/icons/eye.svg[hide,18,18]可显示/隐藏认证信息明文。 + +* 在**kubeconfig 设置**区域右上角点击image:/images/ks-qkcp/zh/icons/copy.svg[copy,18,18]可复制 kubeconfig 信息，点击image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download,18,18]可下载 **kubeconfig.yaml** 文件。 + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +kubeconfig 信息包含了服务帐户的认证信息。您需要在应用程序中配置 kubeconfig 信息使应用程序可以访问{ks_product_both}集群。有关更多信息，请参阅 link:https://kubernetes.io/zh/docs/concepts/configuration/organize-cluster-access-kubeconfig/[Kubernetes 官方文档]。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-para-serviceAccountList.adoc b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-para-serviceAccountList.adoc new file mode 100644 index 000000000..3bd1a94e7 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/serviceAccounts/serviceAccounts-para-serviceAccountList.adoc @@ -0,0 +1,24 @@ +// :ks_include_id: f22f03e60c6c4ef2846c1ca38ee84d80 +* 服务帐户列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|服务帐户的名称和描述。 + +|项目 +|服务帐户所属的项目。 + +|角色 +|服务帐户在所属项目中的角色。服务帐户的项目角色将决定服务帐户在项目中的权限。 + +|保密字典 +|服务帐户对应的保密字典的名称。该保密字典中存储用于认证的证书、项目名称和令牌。 + +|创建时间 +|服务帐户的创建时间。 +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/services/services-desc-createAService.adoc b/content/zh/docs/_custom/clusterManagement/services/services-desc-createAService.adoc new file mode 100644 index 000000000..d5c24406d --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-desc-createAService.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 778abc4b808a4ed796f46c0c8b12c68d +本节介绍如何创建服务。 diff --git a/content/zh/docs/_custom/clusterManagement/services/services-desc-deleteServices.adoc b/content/zh/docs/_custom/clusterManagement/services/services-desc-deleteServices.adoc new file mode 100644 index 000000000..b9ab431bf --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-desc-deleteServices.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 5e2c112952a04a0a852f249edae6a04d +本节介绍如何删除服务。 + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +删除服务后将无法通过服务访问其后端的容器组，请谨慎执行此操作。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/services/services-desc-editAMetricsExporter.adoc b/content/zh/docs/_custom/clusterManagement/services/services-desc-editAMetricsExporter.adoc new file mode 100644 index 000000000..2bb6b3aae --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-desc-editAMetricsExporter.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 6aade36eb695477ab6e8a0eda652c52e +本节介绍如何编辑监控导出器。 + +监控导出器用于对应用程序进行监控。{ks_product_right}平台的监控告警功能底层通过 Prometheus 实现。为监控应用程序的运行状况，您需要进行以下操作： diff --git a/content/zh/docs/_custom/clusterManagement/services/services-desc-editServiceExternalAccessSettings.adoc b/content/zh/docs/_custom/clusterManagement/services/services-desc-editServiceExternalAccessSettings.adoc new file mode 100644 index 000000000..7b09efd12 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-desc-editServiceExternalAccessSettings.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 6153ebc95ef847adb6e6294e7b521d88 +本节介绍如何编辑服务外部访问设置。 + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +此操作仅支持内部访问模式为 VirtualIP 的服务，不支持内部访问模式为 Headless 或 ExternalName 的服务。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/services/services-desc-editServiceInformation.adoc b/content/zh/docs/_custom/clusterManagement/services/services-desc-editServiceInformation.adoc new file mode 100644 index 000000000..04abe6924 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-desc-editServiceInformation.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 0be7fc7e00d24083ac5d17ec7c4dd81b +本节介绍如何编辑任务信息。 + +您可以编辑任务的别名和描述。{ks_product_right}不支持编辑已创建任务的名称。 diff --git a/content/zh/docs/_custom/clusterManagement/services/services-desc-editServiceSettings.adoc b/content/zh/docs/_custom/clusterManagement/services/services-desc-editServiceSettings.adoc new file mode 100644 index 000000000..d66419234 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-desc-editServiceSettings.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 0c171d40a4db48718db0c8fd91e031a8 +本节介绍如何编辑任务设置。 diff --git a/content/zh/docs/_custom/clusterManagement/services/services-desc-services.adoc b/content/zh/docs/_custom/clusterManagement/services/services-desc-services.adoc new file mode 100644 index 000000000..77bf2614a --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-desc-services.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 9d67f68a071549aa94a7433420ef1f66 +本节介绍如何管理服务。 + +服务用于暴露应用程序供集群内部或集群外部访问。 + +* 在{ks_product_both}平台上，应用程序运行在容器组中，同一个应用程序的多个容器组副本由工作负载或任务管理。虽然每个容器组都具有可在集群内部访问的虚拟 IP 地址，但容器组是非永久性的资源，可能会被删除或重新创建。当容器组被重新创建时，新容器组和旧容器组的虚拟 IP 地址一般不同，容器组原有的 IP 地址将失效。 + +* 服务提供了固定的地址（域名或 IP 地址）供客户端访问。服务将客户端的请求转发给某一个容器组，并为多个容器组副本提供负载均衡，从而解决了容器组被删除或重新创建时原有地址失效的问题。 + +* 除为工作负载提供固定的访问地址外，服务还可以通过 NodePort 或 LoadBalancer 方式将工作负载暴露到集群外部。 diff --git a/content/zh/docs/_custom/clusterManagement/services/services-desc-viewServiceDetails.adoc b/content/zh/docs/_custom/clusterManagement/services/services-desc-viewServiceDetails.adoc new file mode 100644 index 000000000..d2fed71c1 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-desc-viewServiceDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 312a369c91ea4bc58e98f2d1989311cd +本节介绍如何查看服务详情。 diff --git a/content/zh/docs/_custom/clusterManagement/services/services-desc-viewServiceList.adoc b/content/zh/docs/_custom/clusterManagement/services/services-desc-viewServiceList.adoc new file mode 100644 index 000000000..27554eb62 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-desc-viewServiceList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: ef7bee4f35a44bbd891d4d160abdda30 +本节介绍如何查看服务列表。 diff --git a/content/zh/docs/_custom/clusterManagement/services/services-oper-createAService.adoc b/content/zh/docs/_custom/clusterManagement/services/services-oper-createAService.adoc new file mode 100644 index 000000000..c128aeaba --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-oper-createAService.adoc @@ -0,0 +1,28 @@ +// :ks_include_id: 95f4759b32eb4061ae07cea32fd54ac8 +. 在**服务设置**页签，设置服务的内部访问模式、工作负载选择器和端口，然后点击**下一步**。 ++ +-- +include::services-para-serviceSettings.adoc[] +-- + +. 在**高级设置**页签，设置服务的外部访问模式、会话保持设置和元数据，然后点击**创建**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::services-para-externalAccess.adoc[] + +include::services-para-sessionPersistence.adoc[] + +|添加元数据 +|设置服务的标签。 + +* 点击**添加**可设置多条标签。 + +* 在已创建的标签右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除标签。 +|=== + +服务创建完成后将显示在服务列表中。 +-- diff --git a/content/zh/docs/_custom/clusterManagement/services/services-oper-deleteASingleService.adoc b/content/zh/docs/_custom/clusterManagement/services/services-oper-deleteASingleService.adoc new file mode 100644 index 000000000..7ac3c771c --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-oper-deleteASingleService.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 03191d86a7474f0aa61513f52a671795 +. 在需要删除的服务右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 diff --git a/content/zh/docs/_custom/clusterManagement/services/services-oper-deleteMultipleServices.adoc b/content/zh/docs/_custom/clusterManagement/services/services-oper-deleteMultipleServices.adoc new file mode 100644 index 000000000..df20b8641 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-oper-deleteMultipleServices.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 0497433d316e4c6e9a45cf29e12dbbd9 +. 选择需要删除的服务左侧的复选框，然后在服务列表上方点击**删除**。 + +. 在**批量删除服务**对话框，确认并选择要删除的相关资源，然后点击**确定**。 ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/services/services-oper-editAMetricsExporter.adoc b/content/zh/docs/_custom/clusterManagement/services/services-oper-editAMetricsExporter.adoc new file mode 100644 index 000000000..b85d99b07 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-oper-editAMetricsExporter.adoc @@ -0,0 +1,47 @@ +// :ks_include_id: f0e2bbaddcbd4d3db4ce4f3625f57ca1 +. 在服务详情页面左上角选择**更多操作 > 编辑监控导出器**。 + +. 在**编辑监控导出器**页面，设置监控指标的收集路径、收集间隔和超时时间，然后点击**确定**。 ++ +-- +{ks_product_right}的监控告警模块将根据此处设置的参数访问服务并收集应用程序的监控指标。 +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|协议 +|用于通信的协议，取值可以为 **HTTP** 或 **HTTPS**。 + +|端口 +|用于通信的服务端口。 + +|路径 +|暴露应用程序监控指标的路径。 + +|认证方式 +|收集应用程序监控指标过程的通信认证方式。 + +* **无需认证**：不采用任何认证手段。此方式可能存在信息安全隐患。 + +* **TLS**：收集应用程序监控指标的过程通过 TLS 协议进程认证。 + +* **Bear 令牌**：通过令牌进行认证。 + +* **基础认证**：通过用户名和密码认证。 + +除**无需认证**外，其他认证方式都需要在应用程序中配置对应的认证逻辑，并提前创建包含认证信息的保密字典。 + +|收集间隔 +|应用程序监控指标的收集间隔，单位为分钟。 + +|超时时间 +|每次收集应用程序监控指标的超时时间，单位为秒。 +|=== +-- + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +监控导出器创建完成后，您还需要在{ks_product_left} Web 控制台使用监控指标进一步创建规则组或自定义监控面板，以对应用程序的运行状态进行监控。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/services/services-oper-editServiceExternalAccessSettings.adoc b/content/zh/docs/_custom/clusterManagement/services/services-oper-editServiceExternalAccessSettings.adoc new file mode 100644 index 000000000..34732e5d8 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-oper-editServiceExternalAccessSettings.adoc @@ -0,0 +1,20 @@ +// :ks_include_id: f59275b4c21c49c9983d211ee4b12b66 +. 在**编辑外部访问**对话框，设置服务的外部访问模式，然后点击**确定**。 ++ +-- +服务的外部访问模式包括以下类型： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|无 +|无法从集群外部访问服务。 + +|NodePort +|系统将节点的端口映射到服务端口，可通过节点的 IP 地址和节点端口访问服务。 + +|LoadBalancer +|系统在 NodePort 服务的基础上为服务分配一个外部 IP 地址，并将外部 IP 地址与一个外部负载均衡器绑定。外部负载均衡器监听服务对应的节点端口，从而可以通过外部 IP 地址访问服务。为实现上述功能，LoadBalancer 类型的服务需要负载均衡器插件和基础设施环境提供支持，并且需要设置相关注解。有关更多信息，请联系您的基础设施环境提供商。 +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/services/services-oper-editServiceInformation.adoc b/content/zh/docs/_custom/clusterManagement/services/services-oper-editServiceInformation.adoc new file mode 100644 index 000000000..833e6db22 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-oper-editServiceInformation.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: 1137d62e09344a798e172ba55bf7a205 +. 在需要操作的服务右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置服务的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|服务的别名。不同服务的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|服务的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|=== +-- \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/services/services-oper-editServiceSettings-for-kubefed.adoc b/content/zh/docs/_custom/clusterManagement/services/services-oper-editServiceSettings-for-kubefed.adoc new file mode 100644 index 000000000..759cf775c --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/services/services-oper-editServiceSettings.adoc b/content/zh/docs/_custom/clusterManagement/services/services-oper-editServiceSettings.adoc new file mode 100644 index 000000000..93e6cbcfb --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-oper-editServiceSettings.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: f0f32c026c8a44b7ac18acbadf465ea5 +. 在需要操作的服务右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑服务**。 + +. 在**编辑服务**对话框修改服务的设置，然后点击**确定**。 + +* 对于内部访问模式为 ExternalName 的服务，您可以修改外部服务的地址。 + +* 对于其他服务，您可以修改服务的内部访问模式、工作负载选择器和端口。 ++ +-- +include::services-para-serviceSettings.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/services/services-oper-exposeMetrics.adoc b/content/zh/docs/_custom/clusterManagement/services/services-oper-exposeMetrics.adoc new file mode 100644 index 000000000..56dbd99a8 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-oper-exposeMetrics.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9014ea6811834538b9c5b7fe24097a91 +. 在{ks_product_left} Web 控制台，使用监控指标创建规则组或自定义监控面板，从而对应用程序的运行状况进行监控。 diff --git a/content/zh/docs/_custom/clusterManagement/services/services-oper-openDetailsPage.adoc b/content/zh/docs/_custom/clusterManagement/services/services-oper-openDetailsPage.adoc new file mode 100644 index 000000000..ef22cb405 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9572433de70c4e3485289ea683e39c12 +. 在服务列表中点击一个服务的名称打开其详情页面。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/services/services-oper-openServiceExternalAccessSettings.adoc b/content/zh/docs/_custom/clusterManagement/services/services-oper-openServiceExternalAccessSettings.adoc new file mode 100644 index 000000000..8fbcf2984 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/services/services-oper-searchForServices.adoc b/content/zh/docs/_custom/clusterManagement/services/services-oper-searchForServices.adoc new file mode 100644 index 000000000..fe082318a --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-oper-searchForServices.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d085604adc244a4cbb580fb88485f275 +* 在列表上方点击搜索框并设置搜索条件，可按名称搜索服务。 diff --git a/content/zh/docs/_custom/clusterManagement/services/services-oper-viewServiceDetails-for-kubefed.adoc b/content/zh/docs/_custom/clusterManagement/services/services-oper-viewServiceDetails-for-kubefed.adoc new file mode 100644 index 000000000..287f10dfb --- /dev/null +++ b/content/zh/docs/_custom/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_right}平台上定义了以下端口类型： + +* 容器端口：容器中的应用程序监听的端口，只能在容器组内部访问。 + +* 服务端口：服务虚拟 IP 地址的端口，只能在集群内部访问，发送到服务端口的请求将被转发给容器端口。 + +* 节点端口：节点主机上的端口，可以从集群外部访问，发送到节点端口的请求将被转发给服务端口。NodePort 或 LoadBalancer 类型的服务具有节点端口。 + +// |工作负载 +// |显示管理容器组的工作负载的名称、更新时间、类型、状态和当前修改记录。 + +// |容器组 +// | +// include::../nodes/nodes-para-podList.adoc[] +|=== +-- + +. 在服务详情页面右侧点击**元数据**页签查看服务的标签和注解。 + +. 在服务详情页面右侧点击**事件**页签查看服务相关的事件。 ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/services/services-oper-viewServiceDetails.adoc b/content/zh/docs/_custom/clusterManagement/services/services-oper-viewServiceDetails.adoc new file mode 100644 index 000000000..20a628c74 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-oper-viewServiceDetails.adoc @@ -0,0 +1,91 @@ +// :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"] +|=== +|参数 |描述 + +|端口 +|为使容器能够被正常访问，{ks_product_right}平台上定义了以下端口类型： + +* 容器端口：容器中的应用程序监听的端口，只能在容器组内部访问。 + +* 服务端口：服务虚拟 IP 地址的端口，只能在集群内部访问，发送到服务端口的请求将被转发给容器端口。 + +* 节点端口：节点主机上的端口，可以从集群外部访问，发送到节点端口的请求将被转发给服务端口。NodePort 或 LoadBalancer 类型的服务具有节点端口。 + +|工作负载 +|显示管理容器组的工作负载的名称、更新时间、类型、状态和当前修改记录。 + +|容器组 +| +include::../nodes/nodes-para-podList.adoc[] +|=== +-- + +. 在服务详情页面右侧点击**元数据**页签查看服务的标签和注解。 + +. 在服务详情页面右侧点击**事件**页签查看服务相关的事件。 ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/services/services-para-creationTime.adoc b/content/zh/docs/_custom/clusterManagement/services/services-para-creationTime.adoc new file mode 100644 index 000000000..af2e0c208 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-para-creationTime.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: f7bc10d6a0ae4ebfb0956bf2cd8624dd +|创建时间 +|服务的创建时间。 diff --git a/content/zh/docs/_custom/clusterManagement/services/services-para-externalAccess.adoc b/content/zh/docs/_custom/clusterManagement/services/services-para-externalAccess.adoc new file mode 100644 index 000000000..03afcc181 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-para-externalAccess.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 9ed594d85e2d49d189b604ba75506964 +|外部访问 +|服务的外部访问模式。 + +// tag::bullets[] +* **NodePort**：系统将节点的端口映射到服务端口，可通过节点的 IP 地址和节点端口访问服务。 + +* **LoadBalancer**：系统在 NodePort 服务的基础上为服务分配一个外部 IP 地址，并将外部 IP 地址与一个外部负载均衡器绑定。外部负载均衡器监听服务对应的节点端口，从而可以通过外部 IP 地址访问服务。为实现上述功能，LoadBalancer 类型的服务需要负载均衡器插件和基础设施环境提供支持，并且需要设置相关注解。有关更多信息，请联系您的基础设施环境提供商。 +// end::bullets[] diff --git a/content/zh/docs/_custom/clusterManagement/services/services-para-externalName.adoc b/content/zh/docs/_custom/clusterManagement/services/services-para-externalName.adoc new file mode 100644 index 000000000..ed666f23c --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-para-externalName.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: ae3aeeab99d2436aaf471a053199ed31 +* **ExternalName**：服务将业务流量转发给集群外部的其他服务。系统不为服务分配虚拟 IP 地址，可通过 `..svc.cluster.local` 格式的域名从集群内部访问。 diff --git a/content/zh/docs/_custom/clusterManagement/services/services-para-internalAccess.adoc b/content/zh/docs/_custom/clusterManagement/services/services-para-internalAccess.adoc new file mode 100644 index 000000000..0dc190841 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-para-internalAccess.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d2f7e4ed2c324015a246ad69584a8562 +服务的内部访问模式。 diff --git a/content/zh/docs/_custom/clusterManagement/services/services-para-name.adoc b/content/zh/docs/_custom/clusterManagement/services/services-para-name.adoc new file mode 100644 index 000000000..623e10768 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-para-name.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: fc0d8d22d3934c7c8a894c53da744ea6 +|名称 +|服务的名称和描述信息。 diff --git a/content/zh/docs/_custom/clusterManagement/services/services-para-serviceAlias.adoc b/content/zh/docs/_custom/clusterManagement/services/services-para-serviceAlias.adoc new file mode 100644 index 000000000..324d57106 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-para-serviceAlias.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: f7106eed4381415e895021d16070780d +|别名 +|服务的别名。不同服务的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 diff --git a/content/zh/docs/_custom/clusterManagement/services/services-para-serviceDescription.adoc b/content/zh/docs/_custom/clusterManagement/services/services-para-serviceDescription.adoc new file mode 100644 index 000000000..26b64c535 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-para-serviceDescription.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 84acacc3966a4dea95858ffeabf4a6b7 +|描述 +|服务的描述信息。描述可包含任意字符，最长 256 个字符。 diff --git a/content/zh/docs/_custom/clusterManagement/services/services-para-serviceName.adoc b/content/zh/docs/_custom/clusterManagement/services/services-para-serviceName.adoc new file mode 100644 index 000000000..0023e1840 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-para-serviceName.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 89c9a4c83d7a46889b95133fc816d28d +|名称 +|服务的名称。同一项目中的服务名称不能重复。名称只能包含小写字母、数字和连字符（-），必须以小写字母开头并以小写字母或数字结尾，最长 63 个字符。 diff --git a/content/zh/docs/_custom/clusterManagement/services/services-para-serviceSettings.adoc b/content/zh/docs/_custom/clusterManagement/services/services-para-serviceSettings.adoc new file mode 100644 index 000000000..6f37a59cf --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-para-serviceSettings.adoc @@ -0,0 +1,34 @@ +// :ks_include_id: 797c8dc7400f4f17940a76eb88ae5149 +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|内部访问模式 +|从集群内部访问服务的方式。 + +* **内部域名**：系统不为服务分配虚拟 IP 地址，可通过 `..svc.cluster.local` 或 `.` 格式的域名从集群内部访问。 + +* **虚拟 IP 地址**：系统为服务分配一个虚拟 IP 地址供集群内部访问，同时也支持通过 `..svc.cluster.local` 或 `.` 格式的域名从集群内部访问。 + +|工作负载选择器 +|指定服务将业务流量转发给具有特定标签的工作负载管理的容器组。 + +* 输入标签的键和值可手动设置选择器。点击**添加**可设置多个标签。 + +* 点击**指定工作负载**可手动选择工作负载。 + +* 在已创建的标签右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除标签。 + +|端口 +|服务端口及其与目标容器端口的映射关系。 + +* **协议**：目标容器中的应用程序实际监听的协议。如需使用{ks_product_both}提供的应用治理功能，请确保此处选择的协议与目标容器中的应用程序实际监听的协议保持一致。 + +* **名称**：服务端口的名称。{ks_product_right}的应用治理功能要求服务端口名称以协议名称小写为前缀。如需使用{ks_product_both}提供的应用治理功能，请使用协议名称小写作为端口名称的前缀（例如 **http-**）。 + +* **容器端口**：目标容器中的应用程序实际监听的端口号。 + +* **服务端口**：服务的端口号。 + +点击**添加**可设置多个服务端口。在已创建的服务端口右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除服务端口。 +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/services/services-para-sessionPersistence.adoc b/content/zh/docs/_custom/clusterManagement/services/services-para-sessionPersistence.adoc new file mode 100644 index 000000000..655763a0d --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-para-sessionPersistence.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 9bd9803a7946434cb487882abcb428b8 +|会话保持 +|设置系统在指定的时间内将同一个会话中来自同一个客户端的请求全部转发给同一个容器组。最长会话保持时间默认值为 10800 秒，您也可以手动设置最长会话保持时间。 diff --git a/content/zh/docs/_custom/clusterManagement/services/services-para-statelessStatefulExternal.adoc b/content/zh/docs/_custom/clusterManagement/services/services-para-statelessStatefulExternal.adoc new file mode 100644 index 000000000..cc2c187c8 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-para-statelessStatefulExternal.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: ae5f26efadb740b1b3a09e681f1ef06e +* **有状态服务**：服务的内部访问模式为 Headless，后端工作负载为有状态副本集。 + +* **无状态服务**：服务的内部访问模式为 VirtualIP，后端工作负载为部署。 diff --git a/content/zh/docs/_custom/clusterManagement/services/services-para-virtualip-headless.adoc b/content/zh/docs/_custom/clusterManagement/services/services-para-virtualip-headless.adoc new file mode 100644 index 000000000..fb48a5f97 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/services/services-para-virtualip-headless.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: bed3eb4cd7fa441990451420cd9a8ed4 +* **Headless**：系统不为服务分配虚拟 IP 地址，可通过 `..svc.cluster.local` 或 `.` 格式的域名从集群内部访问。 + +* **VirtualIP**：系统为服务分配一个虚拟 IP 地址供集群内部访问，同时也支持通过 `..svc.cluster.local` 或 `.` 格式的域名从集群内部访问。 diff --git a/content/zh/docs/_custom/clusterManagement/services/services-prer-exposeMetrics.adoc b/content/zh/docs/_custom/clusterManagement/services/services-prer-exposeMetrics.adoc new file mode 100644 index 000000000..a81a73d5d --- /dev/null +++ b/content/zh/docs/_custom/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_both}平台提前创建包含认证信息的保密字典。 diff --git a/content/zh/docs/_custom/clusterManagement/storageClasses/systemClasses-oper-openDetailsPage.adoc b/content/zh/docs/_custom/clusterManagement/storageClasses/systemClasses-oper-openDetailsPage.adoc new file mode 100644 index 000000000..b2e1a6d86 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/storageClasses/systemClasses-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: ddde1ce7630144f8bc7460c30577b036 +. 在存储类列表中点击一个存储类的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/clusterManagement/storageClasses/systemClasses-para-allowVolumeCloning.adoc b/content/zh/docs/_custom/clusterManagement/storageClasses/systemClasses-para-allowVolumeCloning.adoc new file mode 100644 index 000000000..4ce701d9e --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/storageClasses/systemClasses-para-allowVolumeCloning.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d8e84290faee432e8c4e286dd1fa707d +是否允许用户在{ks_product_left} Web 控制台对持久卷进行克隆。 diff --git a/content/zh/docs/_custom/clusterManagement/storageClasses/systemClasses-para-allowVolumeExpansion.adoc b/content/zh/docs/_custom/clusterManagement/storageClasses/systemClasses-para-allowVolumeExpansion.adoc new file mode 100644 index 000000000..92f76e740 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/storageClasses/systemClasses-para-allowVolumeExpansion.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 57acc3d45ab443bdad3eee12eb83b5ca +是否允许用户在{ks_product_left} Web 控制台扩展持久卷容量。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/storageClasses/systemClasses-para-allowVolumeSnapshot.adoc b/content/zh/docs/_custom/clusterManagement/storageClasses/systemClasses-para-allowVolumeSnapshot.adoc new file mode 100644 index 000000000..d0a362e94 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/storageClasses/systemClasses-para-allowVolumeSnapshot.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 48f291ba67994c06a8a69b9222de92ab +是否允许用户在{ks_product_left} Web 控制台为持久卷创建快照。 diff --git a/content/zh/docs/_custom/clusterManagement/storageClasses/systemClasses-para-defaultStorageClass.adoc b/content/zh/docs/_custom/clusterManagement/storageClasses/systemClasses-para-defaultStorageClass.adoc new file mode 100644 index 000000000..36327ae5c --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/storageClasses/systemClasses-para-defaultStorageClass.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 74c2d701d7a54e788036567ac9748872 +存储类是否为默认存储类。设置默认存储类后，如果没有特殊指定，系统将使用默认存储类创建持久卷声明。每个{ks_product_both}集群中仅允许设置一个默认存储类。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/systemComponents/systemComponents-para-replica-count.adoc b/content/zh/docs/_custom/clusterManagement/systemComponents/systemComponents-para-replica-count.adoc new file mode 100644 index 000000000..04dda6194 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/systemComponents/systemComponents-para-status.adoc b/content/zh/docs/_custom/clusterManagement/systemComponents/systemComponents-para-status.adoc new file mode 100644 index 000000000..82d22db18 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/systemComponents/systemComponents-para-status.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: d8bdf481c53743aca14f167808430d23 +系统组件的运行状态。 + +* **健康**：系统组件运行正常。 + +* **已停止**：系统组件的工作负载已停止运行。 + +* **告警**：系统组件实际运行的容器组副本数小于期望的容器组副本数。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-oper-openListPage.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-oper-openListPage.adoc new file mode 100644 index 000000000..24a82da18 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 8780fa783a634e2ea7e02b71327c3608 +. 在**卷快照**页面点击**卷快照内容**打开卷快照内容列表。 diff --git a/content/zh/docs/_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-capacity.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-capacity.adoc new file mode 100644 index 000000000..fd31f5569 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-capacity.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: a2112616394340108e2af64c91d2c33d +卷快照内容对应的持久卷的容量。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc new file mode 100644 index 000000000..39d02a6fa --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-status.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-status.adoc new file mode 100644 index 000000000..8b75250f8 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-status.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 6967c031afb24424b3fdd01250460660 +卷快照内容的状态。 + +* **就绪**：卷快照内容已创建成功，并且快照数据已保存到后端存储系统。 + +* **未就绪**：卷快照内容正在创建或正在删除中。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-volumeSnapshotClass.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-volumeSnapshotClass.adoc new file mode 100644 index 000000000..f46bdfc02 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-volumeSnapshotClass.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: fc3e0f0606144b55b1662409e2c4b5cb +创建卷快照所使用的卷快照类。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-createAPersistentVolumeFromAVolumeSnapshot.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-createAPersistentVolumeFromAVolumeSnapshot.adoc new file mode 100644 index 000000000..a07846abb --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-createAPersistentVolumeFromAVolumeSnapshot.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: e8fdffd5e61b45e99c5afd2ae8efb5ec +本节介绍如何使用卷快照创建持久卷。 + +卷快照创建后，您可以使用卷快照创建持久卷声明和持久卷。 diff --git a/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-deleteVolumeSnapshots.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-deleteVolumeSnapshots.adoc new file mode 100644 index 000000000..255c8f92a --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-deleteVolumeSnapshots.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 3603af7c772d428bb6e514c29c8eb747 +本节介绍如何删除卷快照。 + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +卷快照删除后不能恢复，请谨慎执行此操作以免数据丢失。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewAVolumeSnapshotList.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewAVolumeSnapshotList.adoc new file mode 100644 index 000000000..11d54e289 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewAVolumeSnapshotList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: a1f60dfd532d4f18b2f626e9ce81ea4e +本节介绍如何查看卷快照列表。 diff --git a/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewVolumeSnapshotDetails.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewVolumeSnapshotDetails.adoc new file mode 100644 index 000000000..9d051b678 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewVolumeSnapshotDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 447a321161844ddba2a4dc1e7677dd14 +本节介绍如何查看卷快照的详情。 diff --git a/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-volumeSnapshots.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-volumeSnapshots.adoc new file mode 100644 index 000000000..eb2f9d13d --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-volumeSnapshots.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: fdb0d37ac974460092567e5ee221abcb +本节介绍如何管理卷快照和卷快照内容。 + +卷快照定义了保存快照数据所需要的存储资源。卷快照创建后，系统将在后端存储系统中保存快照数据，每个快照数据单元与{ks_product_both}平台上的一个卷快照内容对应。 diff --git a/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAPersistentVolumeFromAVolumeSnapshot.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAPersistentVolumeFromAVolumeSnapshot.adoc new file mode 100644 index 000000000..5581c471b --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAVolumeSnapshot.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAVolumeSnapshot.adoc new file mode 100644 index 000000000..5f0659034 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteASingleVolumeSnapshot.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteASingleVolumeSnapshot.adoc new file mode 100644 index 000000000..f73e7ec80 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteMultipleVolumeSnapshots.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteMultipleVolumeSnapshots.adoc new file mode 100644 index 000000000..976f9fb27 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteMultipleVolumeSnapshots.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 7a2c4eb010e0470095968312938c7699 +. 选择需要删除的卷快照左侧的复选框，然后在卷快照列表上方点击**删除**。 + +. 在**批量删除卷快照**对话框，输入卷快照的名称，然后点击**确定**。 ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-openDetailsPage.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-openDetailsPage.adoc new file mode 100644 index 000000000..a3dd0077f --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: abe8911b7ecb4c4dbafe2a4e32f9932a +. 在卷快照列表中点击一个卷快照的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-searchForVolumeSnapshots.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-searchForVolumeSnapshots.adoc new file mode 100644 index 000000000..1316bee7c --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-searchForVolumeSnapshots.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 8ad6ef7eeeae445a95cd3af6e31f267c +* 在列表上方点击搜索框并设置搜索条件，可按名称或状态搜索卷快照。 diff --git a/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-viewVolumeSnapshotDetails.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-viewVolumeSnapshotDetails.adoc new file mode 100644 index 000000000..2f41f368e --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-viewVolumeSnapshotDetails_v4.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-viewVolumeSnapshotDetails_v4.adoc new file mode 100644 index 000000000..c179acfb1 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-para-capacity.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-para-capacity.adoc new file mode 100644 index 000000000..2efec63c4 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-para-capacity.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: eeeb5fef69924224aac5599d6e8e999b +卷快照对应持久卷的容量。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotList.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotList.adoc new file mode 100644 index 000000000..d65716969 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotList_v4.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotList_v4.adoc new file mode 100644 index 000000000..a33124d11 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotStatus.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotStatus.adoc new file mode 100644 index 000000000..17c27b8fc --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotStatus.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: d7d51560e0e64d3a927f19e81658358b +卷快照当前的状态。 + +* **创建中**：卷快照和对应的卷快照内容正在创建中。 + +* **创建成功**：卷快照和对应的卷快照内容创建成功。 + +* **创建失败**：系统存在错误，卷快照或对应的卷快照内容创建失败。 + +* **删除中**：卷快照正在删除中。取决于卷快照的删除策略，系统可能会在卷快照删除后保留或自动删除卷快照内容。 diff --git a/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotStatus_v4.adoc b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotStatus_v4.adoc new file mode 100644 index 000000000..43675b353 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotStatus_v4.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: d7d51560e0e64d3a927f19e81658358b +卷快照当前的状态。 + +* **就绪**：卷快照和对应的卷快照内容创建成功。 + +* **未就绪**：卷快照和对应的卷快照内容正在创建、创建失败或卷快照正在删除中。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-desc-enableLogCollectionCluster.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-desc-enableLogCollectionCluster.adoc new file mode 100644 index 000000000..3a61a4eb7 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-desc-enableLogCollectionCluster.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 01792eb26cce4187b5a1f964404e6037 +ifeval::["{file_output_type}" == "pdf"] + +有关如何在项目中启用**收集卷上的日志**，请参阅《{ks_product_full_right}项目管理指南》的“日志收集”章节。 + +endif::[] diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc new file mode 100644 index 000000000..0376fb64b --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 4521ce6a20e1414e9ee4a6025bfae0f4 +为容器挂载卷、配置字典或保密字典。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc new file mode 100644 index 000000000..e79c100f1 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 847da7da89ca4546b3e0d53d8edb7441 +设置容器的镜像、名称、类型和资源。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-desc-setWorkloadMetadata.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-desc-setWorkloadMetadata.adoc new file mode 100644 index 000000000..58ecb735c --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-desc-setWorkloadMetadata.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c366a748b75848288944f6526bbf6aa7 +设置工作负载的标签和注解。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-desc-viewContainerLogsOnVolume.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-desc-viewContainerLogsOnVolume.adoc new file mode 100644 index 000000000..33f54dae9 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-desc-viewContainerLogsOnVolume.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 4d9963c5048842079eda1ead3073722d +日志收集完成后将打印到容器的标准输出，您可以在容器详情页面的**日志**页签查看日志内容。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-multi-project-para-workloadList.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-multi-project-para-workloadList.adoc new file mode 100644 index 000000000..d1c2f74af --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume.adoc new file mode 100644 index 000000000..a88adafe5 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: a03937e2a0cc45ffac2b60c8f2321638 +* 将光标悬停在已添加的卷或持久卷声明模板上，然后在右侧点击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]可删除卷或持久卷声明模板。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume_new.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume_new.adoc new file mode 100644 index 000000000..bb61372bf --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume_new.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: a03937e2a0cc45ffac2b60c8f2321638 +* 将光标悬停在已添加的卷上，然后在右侧点击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]可删除卷。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc new file mode 100644 index 000000000..3adf19925 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 6d818141bdf246f49b4c4825976cc804 +* 点击**添加**可设置多条标签或注解。 + +* 在已创建的标签或注解右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除标签或注解。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc new file mode 100644 index 000000000..7a375ad59 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 7e4e28a3e5ce47da9d146777b262caf4 + +设置容器终止前等待的时间，超时后容器将强制终止。默认取值为 30s。 + diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-PodMetadata.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-PodMetadata.adoc new file mode 100644 index 000000000..5bcf73f8d --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-PodMetadata.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 91f17518b6d34f729b683653e6fa81e3 +设置容器组的元数据。目前仅支持设置容器组的注解，不支持设置容器组的标签。 + +* 点击添加可设置多条注解。 + +* 在已创建的注解右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除注解。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc new file mode 100644 index 000000000..4607ea09b --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc @@ -0,0 +1,16 @@ +// :ks_include_id: addcd8f38f374f16a793b840c8f4524b +设置容器的端口。点击**使用默认镜像端口**可将容器端口设置为镜像的默认端口。点击**添加端口**可为容器设置多个端口。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|协议 +|容器中的应用程序实际监听的协议。如需使用{ks_product_both}提供的应用治理功能，请确保此处选择的协议与容器中的应用程序实际监听的协议保持一致。 + +|名称 +|端口的名称。如需使用{ks_product_both}提供的应用治理功能，请使用协议名称小写作为端口名称的前缀（例如 **http-**）。 + +|容器端口 +|容器中的应用程序实际监听的端口号。 +|=== diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc new file mode 100644 index 000000000..87f1c8216 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc @@ -0,0 +1,22 @@ +// :ks_include_id: 90da833da58d47cbad5d77d94fe4d826 +创建容器启动后动作或终止前动作。 + +* 点击**添加动作**可创建动作。 + +* 将光标悬停在已创建的动作上，然后在右侧点击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 请求的协议（HTTP 或 HTTPS）、请求目标相对于容器组虚拟 IP 地址的路径以及请求的端口号。仅在动作执行方式为 **HTTP 请求**时可用。 + +|命令 +|将要在容器中运行的命令。您可以使用半角逗号（,）分隔命令及其参数。仅在动作执行方式为**命令**时可用。 + +|端口 +|用于 TCP 检查的容器端口号。仅在动作执行方式为 **TCP 端口**时可用。 +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc new file mode 100644 index 000000000..c94e0ec7a --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 26629381ce2c4637b491e4fe2386923e +创建容器组中运行的容器。您可以在容器组中创建多个容器。 + +* 点击**添加容器**可创建容器。 + +* 将光标悬停在已创建的容器上，然后在右侧点击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]可删除容器。 \ No newline at end of file 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 new file mode 100644 index 000000000..61978797f --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 87861bb084774716a738a763e7cb8d5a +|添加持久卷声明模板 +|为有状态副本集添加持久卷声明模板。系统将为每个容器组副本单独创建持久卷声明和持久卷，并将持久卷分别挂载到每个容器组副本中的指定容器。仅对有状态副本集可用。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc new file mode 100644 index 000000000..1676e8e9a --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc @@ -0,0 +1,37 @@ +// :ks_include_id: 55d0e202da594ec3bf0eec8a473d3557 +创建探针对容器进行存活检查、就绪检查或启动检查。 + +* 点击**添加探针**可创建探针。 + +* 将光标悬停在已创建的探针上，然后在右侧点击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 请求的协议（HTTP 或 HTTPS）、请求目标相对于容器组虚拟 IP 地址的路径以及请求的端口号。仅在健康检查方式为 **HTTP 请求**时可用。 + +|命令 +|将要在容器中运行的命令。您可以使用半角逗号（,）分隔命令及其参数。仅在健康检查方式为**命令**时可用。 + +|端口 +|用于 TCP 检查的容器端口号。仅在健康检查方式为 **TCP 端口**时可用。 + +|初始延迟 +|容器启动后探针启动前的延迟时间，单位为秒。 + +|超时时间 +|探针超时时间，单位为秒。探针超时后，检查将被视为失败。取值必须为整数，最小值为 **0**。 + +|检查间隔 +|执行检查的时间间隔，单位为秒。取值必须为整数，最小值为 **1**。 + +|成功阈值 +|检查失败后再次被视为成功所需的最小连续成功次数，最小值为 **1**。对于存活探针和启动探针，此参数值必须为 **1**。 + +|失败阈值 +|检查成功后再次被视为失败所需的最小连续失败次数，最小值为 **1**。 +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-basicInformation.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-basicInformation.adoc new file mode 100644 index 000000000..9063a6872 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-basicInformation.adoc @@ -0,0 +1,25 @@ +// :ks_include_id: aaa01b3ba5d6460b9ee0d50de5a5def9 +* 基本信息 ++ +-- +设置工作负载的基本信息。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|工作负载的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 253 个字符。 + +|别名 +|工作负载的别名。不同工作负载的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +ifndef::kubefed[] +|项目 +|将要创建资源的项目。 +endif::[] + +|描述 +|工作负载的描述信息。描述可包含任意字符，最长 256 个字符。 +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc new file mode 100644 index 000000000..8287db436 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: e37f1e1a226842e7b71cfc533a74d392 +|收集卷上日志 +| +允许系统收集保存在卷上的容器日志。如需使用此功能，您需要进行以下操作： + +* 在容器所在的项目中启用**收集卷上日志**功能。 + +* 在**存储设置**页签启用**收集卷上日志**功能，为容器挂载读写模式的持久卷或临时卷，并设置**容器日志路径**。 + +* 设置容器中的应用程序将日志导出到卷挂载目录下的**容器日志路径**。 + +include::workloads-desc-viewContainerLogsOnVolume.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc new file mode 100644 index 000000000..b0d8167b9 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 0c5011c424e145ec95155aed67c9fccb +|镜像 +| +创建容器所需的镜像。 + +* 输入镜像的名称（例如 **nginx:latest**）或路径（例如 **docker.io/nginx:latest**），然后按 **Enter** 键可搜索镜像。 + +* 如果您只输入镜像的名称，默认情况下将从 Docker Hub 拉取镜像。如需使用私有镜像服务，您需要创建包含私有镜像服务信息的保密字典，然后在**镜像**文本框左侧选择私有镜像服务。 + +* 点击image:/images/ks-qkcp/zh/icons/templet.svg[template,18,18]可浏览当前镜像服务中的镜像。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-containerLogPath.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-containerLogPath.adoc new file mode 100644 index 000000000..32a54a753 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc new file mode 100644 index 000000000..bc8dc3321 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 3e5d0001b8ce42a688e457086df147d3 +|容器名称 +|容器的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc new file mode 100644 index 000000000..a7f2d830b --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc @@ -0,0 +1,27 @@ +// :ks_include_id: 03ba4803bc5e4930b178cd6397356d2c +设置容器进程在 Linux 系统中的权限。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|访问控制 +| +容器进程的访问权限。 + +* **特权模式**：以主机上的 **root** 用户运行容器进程。 + +* **允许特权提升**：允许容器进程获取比父进程更多的特权。当**特权模式**启用时，此选项默认启用。 + +* **根目录只读**：将容器文件系统的根目录设置为只读。 + +include::workloads-para-uidGidSelinux.adoc[] + +|权能 +| +在 Linux 系统中对容器进程额外添加或移除的权限。请参阅 link:https://man7.org/linux/man-pages/man7/capabilities.7.html[Linux 官方文档]获取 Linux 进程的权能列表。 + +* 为容器进程添加或移除权能时，您需要去掉权能名称中的 **CAP_** 前缀。例如，在**移除**文本框中输入 **SYS_TIME** 可移除容器进程的 **CAP_SYS_TIME** 权能。 + +* 点击**添加**可设置多条权能添加或移除指令。 +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc new file mode 100644 index 000000000..b4ead1401 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 44485d9a2c89473b896d0aa6c172b2c2 +|容器类型 +| +容器的类型。 + +* **初始化容器**：为工作容器进行初始化工作的容器。工作容器只有在所有初始化容器成功完成之后才会启动。如果初始化容器运行失败，系统会把容器组的状态设置为失败。 + +* **工作容器**：运行应用程序的容器。通常建议每个容器组中只运行一个工作容器。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc new file mode 100644 index 000000000..31d0b597a --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc @@ -0,0 +1,30 @@ +// :ks_include_id: 3bea77d96c69484c89893f226380c3c4 +设置自定义的容器组调度规则。 + +* 点击**添加**可以设置多条规则。 + +* 在已创建的规则右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除规则。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|类型 +| +规则的类型。 + +* **与目标调度到一起**：容器组副本将与当前项目中具特定标签的容器组调度到同一个节点。 + +* **远离目标**：容器组副本将与当前项目中具特定标签的容器组调度到不同节点。 + +|策略 +| +规则实施的策略。 + +* **尽可能匹配**：尽可能满足规则要求。如果规则要求无法得到满足，容器组副本将被调度到不满足规则要求节点上。 + +* **必须匹配**：必须满足规则要求。如果规则要求无法得到满足，容器组副本将不能调度到任何节点上。 + +|目标 +|规则的目标。容器组副本将与具有 **app=** 标签（ 为此处选择的值）的容器组调度到同一个节点或不同节点，取决于规则的类型和策略。 +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc new file mode 100644 index 000000000..caf1f0d62 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc @@ -0,0 +1,25 @@ +// :ks_include_id: 5f8f7ff05ece4c439f6806ad715b9c8c +设置容器的环境变量。 + +* 点击**添加环境变量**可设置多个环境变量。 + +* 点击**批量引用**可使用配置字典或保密字典中的数据创建环境变量。配置字典或密保字典必须与容器属于同一个项目才能被容器引用。容器创建后环境变量的值不会随配置字典或保密字典设置的变更而动态变化。 + +* 在已创建的环境变量右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除环境变量。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|键 +|环境变量的名称。 + +|值 +|环境变量的值。 + +|资源 +|配置字典或保密字典的名称。仅在引用配置字典或保密字典时可用。 + +|资源中的键 +|配置字典或保密字典中的键。与该键对应的值将被用作环境变量的值。仅在引用配置字典或保密字典时可用。 +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc new file mode 100644 index 000000000..f2f1bcaa1 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc @@ -0,0 +1,34 @@ +// :ks_include_id: ddb539fa66e840c9875e39645fc55d2a +检查容器的健康状态。使用此功能前，您需要在容器的应用程序中进行设置，使应用程序可以返回健康检查的结果。 + +{ks_product_right}支持以下健康检查类型： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|存活检查 +|检查容器是否存话。如果存活检查失败，系统将尝试重启容器。 + +|就绪检查 +|检查容器是否已就绪。如果就绪检查失败，系统将禁止通过服务访问容器所在的容器组。 + +|启动检查 +|检查容器是否已启动。如果启动检查失败，系统将禁用容器的其他探针，并尝试重启容器。 +|=== + +{ks_product_right}支持以下检查方式： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|HTTP 请求 +|向容器组的虚拟 IP 地址发送 HTTP GET 请求，如果响应状态码为 2XX 或 3XX 则表明检查成功。 + +|命令 +|在容器中运行命令，如果命令的退出码为 0 则表明检查成功。 + +|TCP 端口 +|尝试与指定的容器端口建立 TCP 连接，如果连接建立成功则表明检查成功。 +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc new file mode 100644 index 000000000..3c66af49e --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc @@ -0,0 +1,19 @@ +// :ks_include_id: 9cc1c0abc4d6458bb0cfc67f88dc1f32 +将容器组所在的节点上的文件或目录挂载到容器上。 + +* 不同节点上相同路径的文件或文件夹可能不同，因此不同节点上的容器组副本可能会从 HostPath 卷中读取到不同的数据。 + +* 您需要确保被挂载的路径在容器组所在的节点上存在，并且容器组进程具有所需的权限，否则容器组进程将无法从 HostPath 卷上读取数据或向其中写入数据。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|卷名称 +|HsotPath 卷的名称。 + +|主机路径 +|节点上需要挂载的文件或文件夹的路径。 + +include::workloads-para-volumeMountModePath.adoc[] +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc new file mode 100644 index 000000000..915ba3845 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc @@ -0,0 +1,16 @@ +// :ks_include_id: d8d9b2087a9849b68d0e028a81a20303 +设置容器组创建或更新时是否从镜像服务拉取镜像。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|优先使用本地镜像 +|容器组创建或更新时，优先使用容器运行时存储在节点的镜像文件。 + +|每次都拉取镜像 +|容器组创建或更新时，每次都尝试从镜像服务拉取镜像。 + +|仅使用本地镜像 +|容器组创建或更新时，仅使用容器运行时存储在节点的镜像。如果本地不存在所需的镜像，容器创建将出现异常。 +|=== diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc new file mode 100644 index 000000000..3beca3de4 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc @@ -0,0 +1,36 @@ +// :ks_include_id: 2c06de3e1ab94af48b7328587c8256b5 +设置容器启动后或终止前需要执行的动作，以进行环境检查或体面终止。使用此功能前，您需要在容器的应用程序中进行配置，使应用程序可以返回动作的执行结果。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|启动后动作 +|容器启动后需要执行的动作。如果该动作执行失败，系统将尝试重启容器。 + +|终止前动作 +| +容器终止前需要执行的动作。该动作遵循以下规则： + +* 如果终止前动作执行失败，系统将立即终止容器。 + +* 容器的体面终止期限默认值为 30s，如果达到体面终止期限时终止前动作仍在执行，系统将提供一次性宽限期 2s。 + +* 宽限期结束后，无论终止前动作是否已执行结束，系统都将终止容器。 +|=== + +{ks_product_right}支持以下启动后动作和终止前动作的执行方式： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|HTTP 请求 +|向容器组的虚拟 IP 地址发送 HTTP GET 请求，如果响应状态码为 2XX 或 3XX 则表明动作执行成功。 + +|命令 +|在容器中运行命令，如果命令的退出码为 0 则表明动作执行成功。 + +|TCP 端口 +|尝试与指定的容器端口建立 TCP 连接，如果连接建立成功则表明动作执行成功。 +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc new file mode 100644 index 000000000..532f3a0c7 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc @@ -0,0 +1,27 @@ +// :ks_include_id: 797ea47d2afa4ac7bf41bd1f29f2097a +将配置字典或保密字典中的数据作为卷挂载到容器。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|选择配置字典/选择保密字典 +|选择当前项目中的配置字典或保密字典。 + +|挂载方式 +|设置配置字典或保密字典中的数据在容器上的挂载方式。配置字典和保密字典只支持以**只读**方式挂载或**不挂载**。 + +|挂载路径 +|设置配置字典或保密字典中的数据挂载到容器上的路径。 + +* 系统将根据配置字典或保密字典中的数据生成一个文件夹，并将其中的每个键值对映射为一个文件，每个文件以键为文件名，值为文件的内容。 + +* 点击image:/images/ks-qkcp/zh/icons/textfield.svg[textfield,18,18]可指定配置字典或保密字典中的键值对作为文件挂载，如不设置子路径则默认挂载整个配置字典或保密字典。如果使用子路径，挂载到容器中的文件不会随配置字典或保密字典动态更新。 + +|选择特定键 +|将配置字典或保密字典中的键值对作为文件挂载到容器中，挂载到容器中的文件会随配置字典或保密字典动态更新。点击**添加**可挂载多个键值对。 + +* **键**：配置字典或保密字典中的需要挂载的键值对的键名称。 + +* **路径**：容器中相对于**挂载路径**的路径。配置字典或保密字典中的指定键值对将挂载到该路径下，**挂载路径**中原有的文件将被覆盖。 +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc new file mode 100644 index 000000000..bcc75fddc --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: a57200e8b62d4d6d901d0981c1ee5639 +|挂载配置字典或保密字典 +|将配置字典或保密字典中的数据作为卷挂载到容器。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc new file mode 100644 index 000000000..35a7a87fd --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 2f14bbf086794d0294530c5059da2be3 +|挂载卷 +|为容器挂载持久卷、临时卷或 HostPath 卷。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc new file mode 100644 index 000000000..80f270290 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc @@ -0,0 +1,14 @@ +// :ks_include_id: 1cf098581c104c40a442ab4ebc7be6ce +为容器挂载持久卷。用于创建持久卷的持久卷声明必须属于容器所在的项目。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|选择持久卷声明 +|选择用于创建持久卷的持久卷声明。该持久卷声明必须属于容器所在项目。如果容器所在的项目中没有可用的持久卷声明，您需要提前创建一个持久卷声明。 + +include::workloads-para-volumeMountModePath.adoc[] + +// include::workloads-para-containerLogPath.adoc[] +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-podIpPool.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-podIpPool.adoc new file mode 100644 index 000000000..3996b7fd3 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-podIpPool.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 6ba8bee2592a4a259898c42507fefa4b +|容器组 IP 池 +|选择用于为容器组副本分配虚拟 IP 地址的 IP 池。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-podReplicas.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-podReplicas.adoc new file mode 100644 index 000000000..c66dc9a01 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-podReplicas.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: b523f301f41c402bb4b78d252ab3ffa2 +* 容器组设置 > 容器组副本数量 ++ +-- +点击image:/images/ks-qkcp/zh/icons/add-light.svg[add,18,18]/image:/images/ks-qkcp/zh/icons/substract-light.svg[subtract,18,18]增加/减少容器组副本的数量，最小值为 **1**。 +-- diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc new file mode 100644 index 000000000..9cb31d3e3 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc @@ -0,0 +1,19 @@ +// :ks_include_id: 5c07b382dc7041a6b8d89f45dadfad06 +设置容器组副本调度到节点的规则。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|默认规则 +|不特别指定规则，由系统决定将容器组副本调度到哪个节点上。 + +|分散调度 +|尽可能将容器组副本调度到不同的节点上。 + +|集中调度 +|尽可能将容器组副本调度到同一个节点上。 + +|自定义规则 +|按照用户自定义的规则将容器组副本调度到节点。如果选择此选项，您需要进一步自定义调度规则。 +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-podSecurityContext.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-podSecurityContext.adoc new file mode 100644 index 000000000..33db9d3dd --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-podSecurityContext.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 3156e518c97e495ebdd0028761edc427 +设置容器组中所有容器进程在 Linux 系统中的权限。如果容器组安全上下文和容器安全上下文中都设置了用户、用户组和 SELinux 上下文，容器安全上下文中的设置将覆盖容器组安全上下文中的设置。 + +[options="header",cols="1a,4a"] +|=== +|参数 |描述 + +include::workloads-para-uidGidSelinux.adoc[] +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc new file mode 100644 index 000000000..911d17697 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc @@ -0,0 +1,13 @@ +// :ks_include_id: 0ae400ef2e644b79a0442a3a094b55b7 +设置滚动更新策略的相关参数。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|最大不可用容器组数量 +|更新过程中允许的不可用容器组副本的最大数量或百分比。 + +|最大多余容器组数量 +|更新过程中允许的多余容器组副本的最大数量或百分比。 +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc new file mode 100644 index 000000000..a30d7ae38 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 0314f28e62bf4e7fb08d1c779601d170 +|选择节点 +| +将容器组副本调度到具有指定标签的节点上。 + +* 您可以手动输入目标节点的标签键值对，也可以点击**指定节点**选择一个节点。 + +* 点击**添加节点选择器**可设置多个标签，容器组副本将被调度到具有所有指定标签的节点上。 + +* 在已创建的标签右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除标签。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc new file mode 100644 index 000000000..2fbc71c32 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc @@ -0,0 +1,13 @@ +// :ks_include_id: 64d2897f5b044d81b1a2e5772897e884 +设置容器启动时在容器内部执行的命令。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|命令 +|需要执行的命令的名称。 + +|参数 +|需要执行的命令的参数。您可以使用半角逗号（,）分隔多个参数。 +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc new file mode 100644 index 000000000..1af57a981 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 4c4df684b9b74e1a9e5cf5aab6f90439 +勾选**同步主机时区**左侧的复选框将使容器和主机的时区同步。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume.adoc new file mode 100644 index 000000000..aa41cab8c --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume_new.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume_new.adoc new file mode 100644 index 000000000..ae58f3a4c --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume_new.adoc @@ -0,0 +1,19 @@ +// :ks_include_id: cc570a193fc8465392e3f53790581f56 +为容器挂载临时卷。临时卷具有以下特点： + +* 由系统自动在容器组所在的节点的存储系统中创建。 + +* 由系统自动管理，容量上限为节点的存储容量。 + +* 无法保存持久化数据，容器组创建时由系统自动创建临时卷，容器组删除时由系统自动删除临时卷。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|卷名称 +|临时卷的名称。 + +include::workloads-para-volumeMountModePath.adoc[] + +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-uidGidSelinux.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-uidGidSelinux.adoc new file mode 100644 index 000000000..7a9f28dba --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-uidGidSelinux.adoc @@ -0,0 +1,13 @@ +// :ks_include_id: 2fc5442d4a274f9dbf5b17caa5a4926a +|用户和用户组 +| +运行容器进程入口点的用户和用户组。 + +* **仅允许非 root 用户运行**：启动容器之前检查容器是否将以 **root** 用户运行。如果容器将以 **root** 用户运行则不启动容器。启用此功能时系统将忽略**特权模式**设置。 + +* **用户**：执行容器进程入口点的 UID。默认为镜像元数据中指定的 UID。 + +* **用户组**：执行容器进程入口点的 GID。默认为容器运行时的默认 GID。 + +|SELinux 上下文 +|容器进程的 SELinux 标签，包括**等级**、**角色**、**类型**和**用户**。有关更多信息，请参阅 link:https://www.selinuxproject.org/page/Main_Page[SELinux 官方文档]。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc new file mode 100644 index 000000000..2f256b969 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc @@ -0,0 +1,13 @@ +// :ks_include_id: 6d48b5a3f3c74e7f958661364e5294d0 +设置容器组更新时采取的策略。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|滚动更新（推荐） +|用新容器组副本逐步替换旧容器组副本。升级过程中业务流量会负载均衡到新旧容器组副本上，业务不会中断。如果您选择此策略，您需要进一步设置**最大不可用容器组数量**和**最大多余容器组数量**。 + +|同时更新 +|删除全部旧容器组副本再创建新容器组副本。升级过程中业务会中断。 +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-volumeMountModePath.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-volumeMountModePath.adoc new file mode 100644 index 000000000..4b19e5a24 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-volumeMountModePath.adoc @@ -0,0 +1,13 @@ +// :ks_include_id: 4401458e342646d99223518791c4a0b6 +|挂载方式 +| +卷在容器上的挂载方式。 + +* **读写**：允许容器读取卷中的数据并向其中写入数据。 + +* **只读**：只允许容器读取卷中的数据。 + +* **不挂载**：卷不挂载到容器上。 + +|挂载路径 +|卷挂载到容器上的路径。点击image:/images/ks-qkcp/zh/icons/textfield.svg[textfield,18,18]可设置需要挂载的卷子路径。如果不设置子路径则默认挂载整个卷。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc new file mode 100644 index 000000000..36b74676a --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc @@ -0,0 +1,24 @@ +// :ks_include_id: ae4fedba880e403d9c8c4888b5134d9c +通过持久卷声明模板为每个容器组副本单独创建持久卷声明和持久卷，并将持久卷挂载到容器。仅对有状态副本集可用。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|PVC 名称前缀 +|通过持久卷声明模板创建的持久卷声明的名称前缀。系统将按 <名称前缀>**-**<工作负载名称>**-**<序列号> 的格式自动命名持久卷声明。同一个有状态副本集不同容器组副本的持久卷声明通过 <序列号> 区分。 + +|存储类 +|用于创建持久卷声明的存储类。 + +|访问模式 +| +include::../../persistentVolumeClaims/persistentVolumeClaims-para-accessMode.adoc[] + +|卷容量 +|通过持久卷声明模板创建的每个持久卷的容量。 + +include::workloads-para-volumeMountModePath.adoc[] + +// include::workloads-para-containerLogPath.adoc[] +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-adjustTheNumberOfPodReplicas.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-adjustTheNumberOfPodReplicas.adoc new file mode 100644 index 000000000..5dc043fe2 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-adjustTheNumberOfPodReplicas.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 04ecee90589140c28c84ab59ddd6aeb7 +本节介绍如何调整工作负载的容器组副本数量。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-createAWorkload.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-createAWorkload.adoc new file mode 100644 index 000000000..113849f3f --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-createAWorkload.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 651c070ef5524b1abe5f616f9bb1cbc1 +本节介绍如何创建工作负载。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-deleteWorkloads.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-deleteWorkloads.adoc new file mode 100644 index 000000000..85cae1052 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-deleteWorkloads.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 0b50b8cf874242deb4bc9fbabcd2bdb7 +本节介绍如何删除工作负载。 + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +此操作将删除工作负载及其管理的所有容器组，工作负载中运行的业务将中断，请谨慎执行此操作。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-editAutoScaling.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-editAutoScaling.adoc new file mode 100644 index 000000000..bef2f751e --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-editAutoScaling.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 23d4ffc14a2f4f8a90a5a1b4d918d0e4 +本节介绍如何编辑工作负载的自动扩缩设置。自动扩缩功能允许系统根据工作负载中所有容器组副本的目标 CPU 和内存用量自动调整容器组副本数量。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-editWorkloadInformation.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-editWorkloadInformation.adoc new file mode 100644 index 000000000..f1c4e36b4 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-editWorkloadInformation.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 8c633944651a4fc5ab95bedaaaa6eccf +本节介绍如何编辑工作负载信息。 + +您可以编辑工作负载的别名和描述。{ks_product_right}不支持编辑已创建工作负载的名称。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-editWorkloadSettings.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-editWorkloadSettings.adoc new file mode 100644 index 000000000..69caade92 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-editWorkloadSettings.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: c3706078af3f41c487c1a5fc573ef5bb +本节介绍如何编辑已创建的工作负载的设置。 + +工作负载创建完成后，您可以编辑工作负载的更新策略、容器、存储和容器组调度规则。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-recreateAWorkload.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-recreateAWorkload.adoc new file mode 100644 index 000000000..836903626 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-recreateAWorkload.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: 373ea79d7dc9465b90f0d8a7d6ae5062 +本节介绍如何重新创建工作负载。 + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +此操作将删除并重新创建工作负载中的所有容器组。新容器组创建完成前，工作负载中的业务将中断。请谨慎执行此操作。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-rollBackWorkloadSettings.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-rollBackWorkloadSettings.adoc new file mode 100644 index 000000000..b3876f2bb --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-rollBackWorkloadSettings.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: 963da033862c424c9fc9f2cc246602fb +本节介绍如何回退工作负载设置。 + +系统在工作负载创建或修改后将生成修改记录，可用于回退工作负载设置。最多可保留 10 条修改记录。 + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +此操作将根据用户选择的修改记录重新创建工作负载，工作负载中运行的业务将中断，请谨慎执行此操作。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-stopWorkloads.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-stopWorkloads.adoc new file mode 100644 index 000000000..5be53f25a --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-stopWorkloads.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: e824d7c6552945beaedf6ace7863defa +本节介绍如何停止工作负载。 + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +此操作将把工作负载中运行的容器组副本数量调整到 0，工作负载中运行的业务将中断。请谨慎执以操作。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-viewAWorkloadList.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-viewAWorkloadList.adoc new file mode 100644 index 000000000..7b17c137e --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-viewAWorkloadList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 50f92d72149e46929bf7119f2fe1242a +本节介绍如何查看工作负载列表。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-viewWorkloadDetails.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-viewWorkloadDetails.adoc new file mode 100644 index 000000000..5c7835823 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-viewWorkloadDetails.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 28b4a5dc9202450094b2d3bff92d4f7a +本节介绍如何查看工作负载详情。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-workloads.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-workloads.adoc new file mode 100644 index 000000000..9783d87f4 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-desc-workloads.adoc @@ -0,0 +1,18 @@ +// :ks_include_id: d035ff78f85d42acb9f1d0b5715617e3 +本节介绍如何管理工作负载。 + +在{ks_product_both}平台，应用程序运行在容器组中。为确保单个容器组出现故障时业务不会中断，通常需要为一个应用程序创建多个容器组副本。工作负载是用于管理容器组副本的资源，负责对一个应用程序的多个容器组副本进行管理，主要提供以下功能： + +* 根据用户设定的条件自动扩缩容器组副本数量。 + +* 根据用户指定的更新策略自动更新容器组。 + +* 将容器组回滚到以前的版本。 + +{ks_product_right}平台支持以下工作负载类型： + +* 部署：用于管理无状态应用。部署管理的多个容器组副本共用一个卷。当容器组副本重新创建时，新容器组副本和旧容器组副本的名称不同。 + +* 有状态副本集：用于管理有状态应用。有状态副本集管理的多个容器副本可以分别使用独立的卷。每个容器组副本的名称具有固定的序号，当容器组副本重新创建时，新容器组副本和旧容器组副本名称相同。 + +* 守护进程集：用于管理守护进程。守护进程集确保所有或特定的节点都运行一个容器组副本。当新节点添加到集群时，如果新节点符合容器组调度规则，守护进程集会自动在新节点上创建一个容器组副本。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-multi-project-oper-createAWorkload-ClusterDiff.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-multi-project-oper-createAWorkload-ClusterDiff.adoc new file mode 100644 index 000000000..b38edbaa0 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc new file mode 100644 index 000000000..43a0cd5ae --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/clusterManagement/workloads/workloads-multi-project-oper-searchForWorkloads.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-multi-project-oper-searchForWorkloads.adoc new file mode 100644 index 000000000..a336a271a --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-multi-project-oper-searchForWorkloads.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 2f8f4e8c4cba43e0b81959fc339f9ca5 +* 在列表上方点击搜索框并设置搜索条件，可按名称搜索工作负载。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-adjustTheNumberOfPodReplicas.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-adjustTheNumberOfPodReplicas.adoc new file mode 100644 index 000000000..717922e66 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-adjustTheNumberOfPodReplicas.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: d02b5f4b6a354bdfbba1d532b30bda69 +. 在工作负载详情页面的**资源状态**页签，点击image:/images/ks-qkcp/zh/icons/add-dark.svg[add-dark,18,18]或image:/images/ks-qkcp/zh/icons/substract-dark.svg[subtrack-dark,18,18]调整容器组副本的数量，然后在右上角的**调整副本数量**对话框点击**确定**。 ++ +-- +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +如果您将容器组副本数量调整到 0，工作负载管理的所有容器组副本将被删除，工作负载中运行的业务将中断。请谨慎执行此操作。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-createAWorkload.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-createAWorkload.adoc new file mode 100644 index 000000000..b087b5c53 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-createAWorkload.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 7187f68c21894926871b0e1276d5aa7e +. 在**基本信息**页签，设置工作负载的基本信息，然后点击**下一步**。 + +. 在**容器组设置**页签，为工作负载管理的容器组设置副本数量、容器、更新策略、安全上下文、调度规则和元数据，然后点击**下一步**。 + +. 在**存储设置**页签，为工作负载管理的容器挂载卷，然后点击**下一步**。 + +. 在**高级设置**页签，为工作负载管理的容器组指定节点，并设置工作负载的元数据，然后点击**创建**。工作负载创建完成后将显示在工作负载列表中。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-deleteASingleWorkload.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-deleteASingleWorkload.adoc new file mode 100644 index 000000000..aebb61eb7 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-deleteASingleWorkload.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 25d819a958bf49fba9f643a2551ac347 +. 在需要删除的工作负载右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-deleteMultipleWorkloads.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-deleteMultipleWorkloads.adoc new file mode 100644 index 000000000..4cbcca741 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-deleteMultipleWorkloads.adoc @@ -0,0 +1,5 @@ +// :ks_include_id: 87be09b63bf240abaec1c953680d92e6 +. 选择需要删除的工作负载左侧的复选框，然后在工作负载列表上方点击**删除**。 + +. 在**批量删除工作负载**对话框，确认并选择要删除的相关资源，然后点击**确定**。 + diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-editAutoScalingSettings.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-editAutoScalingSettings.adoc new file mode 100644 index 000000000..c1f87565b --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-editAutoScalingSettings.adoc @@ -0,0 +1,23 @@ +// :ks_include_id: d77f09013e3f495b8bea4d8b7300d5e0 +. 在工作负载详情页面左上角选择**更多操作 > 编辑自动扩缩**。 + +. 在**自动扩缩**对话框，设置工作负载的自动扩缩参数，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|目标 CPU 用量 +|工作负载中所有容器组副本的目标 CPU 用量，单位为百分比。当实际 CPU 用量大于/小于目标值时，系统自动减少/增加容器组副本数量。 + +|目标内存用量 +|工作负载中所有容器组副本的目标内存用量，单位为 MiB。当实际 CPU 用量大于/小于目标值时，系统自动减少/增加容器组副本数量。 + +|最小副本数 +|允许的最小容器组副本数量，默认值为 **1**。 + +|最大副本数 +|允许的最大容器组副本数量，默认值为 **1**。 +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-editWorkloadInformation.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-editWorkloadInformation.adoc new file mode 100644 index 000000000..6723647d4 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-editWorkloadInformation.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: 4d2fb1de6b844f18938f0c8b6f08e279 +. 在需要操作的工作负载右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置工作负载的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|工作负载的别名。不同工作负载的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|工作负载的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-editWorkloadSettings.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-editWorkloadSettings.adoc new file mode 100644 index 000000000..e24d783c8 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-editWorkloadSettings.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c86d968a626a4554a7415088043f003c +. 在工作负载详情页面左上角选择**更多操作 > 编辑设置**。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-openDetailsPage.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-openDetailsPage.adoc new file mode 100644 index 000000000..8efac70c8 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9a57470c05844927b339f00b72bbb342 +. 在**工作负载**页面，点击**部署**、**有状态副本集**或**守护进程集**，然后在列表中点击一个工作负载的名称打开其详情页面。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-openListPage.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-openListPage.adoc new file mode 100644 index 000000000..e9a6151b0 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 7dd8d24939c3454f805540ee4215b74a +. 在**工作负载**页面，点击**部署**、**有状态副本集**或**守护进程集**打开工作负载列表。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-recreateAWorkload.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-recreateAWorkload.adoc new file mode 100644 index 000000000..53363e71d --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-recreateAWorkload.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 0578975ed65b41108f5ec9903fae44ca +. 在需要操作的工作负载右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**重新创建**。 + +. 在**重新创建**对话框点击**确定**。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-rollBackWorkloadSettings.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-rollBackWorkloadSettings.adoc new file mode 100644 index 000000000..72d2d5374 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-rollBackWorkloadSettings.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 87b86dd518334714ad747818ae534b07 +. 在工作负载详情页面左上角选择**更多操作 > 回退**。 + +. 在**回退**对话框，设置**目标修改记录**，然后点击**确定**。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-searchForWorkloads.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-searchForWorkloads.adoc new file mode 100644 index 000000000..eae7d4bb6 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-searchForWorkloads.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: cf8f148335ee4a91b16003d41eff0731 +* 在列表上方点击搜索框并设置搜索条件，可按名称或状态搜索工作负载。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-stopWorkloads.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-stopWorkloads.adoc new file mode 100644 index 000000000..8e781f10d --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-stopWorkloads.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 7e1535bd60ce4490bccd43efa8138a1e +. 选择需要操作的工作负载左侧的复选框，然后在工作负载列表上方点击**停止**。 + +. 在**停止工作负载**对话框，输入工作负载的名称，然后点击**确定**。 ++ +-- +include::../../note-separateNamesByComma.adoc[] +-- diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-viewWorkloadDetails.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-viewWorkloadDetails.adoc new file mode 100644 index 000000000..d5f3f3200 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-viewWorkloadDetails.adoc @@ -0,0 +1,78 @@ +// :ks_include_id: c4e995deeaff4c618dca0b53432cab70 +. 在工作负载详情页面左侧的**属性**区域查看工作负载的资源属性。 ++ +-- + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群 +|工作负载所属的集群。 + +|项目 +|工作负载所属的项目。 + + +|应用 +|工作负载所属的应用名称。您可以创建一个包含多个服务的应用，每个服务都对应一个工作负载。 + +|创建时间 +|工作负载的创建时间。 + +|更新时间 +|工作负载的更新时间。 + +|创建者 +|创建工作负载的用户。 +|=== +-- + +. 在工作负载详情页面右侧的**资源状态**页签查看工作负载的容器组副本数量、容器端口和容器组。 ++ +-- +include::../../para-replicasPortsPods.adoc[] +-- + +. 在工作负载详情页面右侧点击**修改记录**页签查看工作负载的修改记录。 ++ +-- +* 在下拉列表中选择一个修改记录可查看其序列号、创建时间和副本集配置文件。{ks_product_right}系统自动为每个修改记录创建一个序列号，最多可保留 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/oper-selectTimeRange.adoc[] +include::../../../../_ks_components/oper-Autorefresh.adoc[] +include::../../../../_ks_components/oper-refreshData.adoc[] +-- + +. 在工作负载详情页面右侧点击**环境变量**页签查看工作负载中的所有容器的环境变量。 + +. 在工作负载详情页面右侧点击**事件**页签查看工作负载相关的事件。 ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-viewWorkloadDetails_new.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-viewWorkloadDetails_new.adoc new file mode 100644 index 000000000..fa469b50b --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-oper-viewWorkloadDetails_new.adoc @@ -0,0 +1,52 @@ +// :ks_include_id: c4e995deeaff4c618dca0b53432cab70 +. 在工作负载详情页面左侧的**属性**区域查看工作负载的资源属性。 ++ +-- + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群 +|工作负载所属的集群。 + +|项目 +|工作负载所属的项目。 + +|应用 +|工作负载所属的应用名称。您可以创建一个包含多个服务的应用，每个服务都对应一个工作负载。 + +|创建时间 +|工作负载的创建时间。 + +|更新时间 +|工作负载的更新时间。 + +|创建者 +|创建工作负载的用户。 +|=== +-- + +. 在工作负载详情页面右侧的**资源状态**页签查看工作负载的容器组副本数量、容器端口和容器组。 ++ +-- +include::../../para-replicasPortsPods.adoc[] +-- + +. 在工作负载详情页面右侧点击**修改信息**页签查看工作负载的修改信息。 ++ +-- +* 在下拉列表中选择一个修改记录可查看其序列号、创建时间和配置文件。{ks_product_right}系统自动为每个修改记录创建一个序列号，最多可保留 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]可以横向显示配置文件的差异。 +-- + +. 在工作负载详情页面右侧点击**元数据**页签查看工作负载的标签和注解。 + +. 在工作负载详情页面右侧点击**环境变量**页签查看工作负载中的所有容器的环境变量。 + +. 在工作负载详情页面右侧点击**事件**页签查看工作负载相关的事件。 ++ +-- +include::../clusterManagement-para-eventsTab.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-para-containerStatus.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-para-containerStatus.adoc new file mode 100644 index 000000000..69c9a67b5 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-para-containerStatus.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 46a592624040499bbca6afbfbae8fe0d +* **等待中**：容器正在进行启动前操作，例于从镜像服务拉取镜像或从保密字典读取数据。 + +* **运行中**：容器正在正常运行。如果容器已配置了启动后动作且状态为**运行中**，那么容器的启动前动作已执行完毕。 + +* **已终止**：容器已成功结束，或由于某种原因运行失败而结束。 \ No newline at end of file diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-para-workloadList.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-para-workloadList.adoc new file mode 100644 index 000000000..3721eebef --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-para-workloadList.adoc @@ -0,0 +1,24 @@ +// :ks_include_id: db17210e20fc4aeb8e782acd2909f83c +* 工作负载列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|工作负载的名称和描述信息。 + +|状态 +| +工作负载的正常容器组副本数、期望容器组副本数和运行状态。工作负载状态包括以下类型： + +include::workloads-para-workloadStatus.adoc[] + +|项目 +|工作负载所属的项目。 + +|更新时间 +|工作负载的更新时间。 +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-para-workloadList_new.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-para-workloadList_new.adoc new file mode 100644 index 000000000..b089cdb09 --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-para-workloadList_new.adoc @@ -0,0 +1,27 @@ +// :ks_include_id: db17210e20fc4aeb8e782acd2909f83c +* 工作负载列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|工作负载的名称和描述信息。 + +|状态 +| +工作负载的正常容器组副本数、期望容器组副本数和运行状态。工作负载状态包括以下类型： + +include::workloads-para-workloadStatus.adoc[] + +// |项目 +// |工作负载所属的项目。 + +|应用 +|工作负载所属的应用。 + +|更新时间 +|工作负载的更新时间。 +|=== +-- diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-para-workloadStatus.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-para-workloadStatus.adoc new file mode 100644 index 000000000..60e9df37e --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-para-workloadStatus.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 61e727942543431594ef9dfaf58908c7 +* **运行中**：工作负载运行正常。 + +* **更新中**：工作负载正在更新容器组副本。 + +* **已停止**：工作负载的期望容器组副本数和当前容器组副本数都为 0。 diff --git a/content/zh/docs/_custom/clusterManagement/workloads/workloads-prer-workloadEdited.adoc b/content/zh/docs/_custom/clusterManagement/workloads/workloads-prer-workloadEdited.adoc new file mode 100644 index 000000000..ab83c2a0b --- /dev/null +++ b/content/zh/docs/_custom/clusterManagement/workloads/workloads-prer-workloadEdited.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d50e3c90a6c441ba8f7526d537afe063 +* 需要回退的工作负载必须被编辑过，从而系统中保存有可回退的修改记录。 diff --git a/content/zh/docs/_custom/glossary.adoc b/content/zh/docs/_custom/glossary.adoc new file mode 100644 index 000000000..077315015 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-code-addNodes.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-code-addNodes.adoc new file mode 100644 index 000000000..f6d4bbadb --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-code-addNodes.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: 6963bdcc859e4b46817de17172bb750a +// Bash +include::../../../_ks_components/code/bash.adoc[] + + ./kk add nodes -f config-sample.yaml -a kubekey-artifact.tar.gz + +---- \ No newline at end of file diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-code-initializeRegistry.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-code-initializeRegistry.adoc new file mode 100644 index 000000000..8f8c59156 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-code-initializeRegistry.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: 1b45c225a03c4b1986ddda5832c75de6 +// Bash +include::../../../_ks_components/code/bash.adoc[] + + ./kk init registry -f config-sample.yaml -a kubekey-artifact.tar.gz + +---- diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-code-privateRegistry.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-code-privateRegistry.adoc new file mode 100644 index 000000000..7d8a0e4ca --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-code-privateRegistry.adoc @@ -0,0 +1,10 @@ +// :ks_include_id: 0aa5c7c7c8bc4a8b8909c558f2500840 +// YAML +include::../../../_ks_components/code/yaml.adoc[] + + registry: + registryMirrors: [] + insecureRegistries: [] + privateRegistry: dockerhub.kubekey.local + +---- diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-code-startUpgradeOffline.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-code-startUpgradeOffline.adoc new file mode 100644 index 000000000..d797c7be6 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-code-startUpgradeOffline.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: 2721978148e845f6909d22f903ee70c0 +// Bash +include::../../../_ks_components/code/bash.adoc[] + + ./kk upgrade --with-kubernetes --with-kubesphere -f config-sample.yaml -a kubekey-artifact.tar.gz + +---- diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-desc-installationSuccessOutput.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-desc-installationSuccessOutput.adoc new file mode 100644 index 000000000..adf8f3dc6 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-desc-installationSuccessOutput.adoc @@ -0,0 +1,27 @@ +// :ks_include_id: b256b5b116ef4733a2be8513e5b03fd6 + + +// Bash +include::../../../_ks_components/code/bash.adoc[] + +##################################################### +###              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/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-desc-installationTime.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-desc-installationTime.adoc new file mode 100644 index 000000000..553ccbbe0 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-desc-installationTime.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: b338a2a33d4249a0a06c58487301fafe +取决于您的硬件和网络环境，安装过程可能需要 10 分钟到 30 分钟时间。如果显示如下信息，则表明安装成功： diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-desc-upgradeSuccess.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-desc-upgradeSuccess.adoc new file mode 100644 index 000000000..83525382e --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-desc-upgradeSuccess.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 17414933bdfa444fb13e2686c433d8f5 +如果显示如下信息，则表明升级成功： diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-note-123EdgeNodes.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-note-123EdgeNodes.adoc new file mode 100644 index 000000000..21df74902 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-note-123EdgeNodes.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 4e16378eba6e45f089fcbf4c3a1b23c4 +Kubernetes v1.24.x 暂不支持通过{ks_product_left} Web 控制台登录边缘节点终端。 diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-note-doNotDeleteConfig.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-note-doNotDeleteConfig.adoc new file mode 100644 index 000000000..6e3ca6f47 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-note-doNotDeleteConfig.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: 6bfe6884350d4647a7cca1af7853a154 +// Note +include::../../../_ks_components/admonitions/note.adoc[] + +安装完成后，请勿删除安装配置文件 **config-sample.yaml**，后续进行版本升级、节点添加等操作时仍需要使用该文件。如果该文件丢失，您需要重新创建安装配置文件。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-note-doNotDeleteConfig_v4.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-note-doNotDeleteConfig_v4.adoc new file mode 100644 index 000000000..3411a0a17 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-note-doNotDeleteConfig_v4.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: 6bfe6884350d4647a7cca1af7853a154 +// Note +include::../../../_ks_components/admonitions/note.adoc[] + +安装完成后，请勿删除安装配置文件 **config-sample.yaml**，后续进行节点添加等操作时仍需要使用该文件。如果该文件丢失，您需要重新创建安装配置文件。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-note-initializeRegistry.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-note-initializeRegistry.adoc new file mode 100644 index 000000000..a2462137b --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-note-initializeRegistry.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: f59af4ec0bd24d5a98d4003578c6e38d +// Note +include::../../../_ks_components/admonitions/note.adoc[] + +KubeKey 将在 **config-sample.yaml** 配置文件中 **spec:roleGroups:registry** 参数指定的服务器上创建私有镜像服务，默认地址为 **dockerhub.kubekey.local/kse**。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] \ No newline at end of file diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-note-rollbackNotSupported.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-note-rollbackNotSupported.adoc new file mode 100644 index 000000000..f9368cec6 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-note-rollbackNotSupported.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 1011fdd0de7a4b36819d4e4985b02817 +Kubernetes 和{ks_product_both}不支持版本回滚，目标版本必须高于原版本。 diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-obtainLoginInfo.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-obtainLoginInfo.adoc new file mode 100644 index 000000000..591749985 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-obtainLoginInfo.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: 84535f1ca66c4b19b1e1d7e6e885bff5 +. 从成功信息中的 **Console**、**Account** 和 **Password** 参数分别获取{ks_product_left} Web 控制台的 IP 地址、管理员用户名和管理员密码，并使用网页浏览器登录{ks_product_left} Web 控制台。 ++ +-- +// Note +include::../../../_ks_components/admonitions/note.adoc[] + +取决于您的网络环境，您可能需要配置流量转发规则并在防火墙中放行 30880 端口。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-checkInstallationLog.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-checkInstallationLog.adoc new file mode 100644 index 000000000..be76d98fa --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-checkInstallationLog.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: e0c9a69a3f7c4dfabc1d964f485628e4 +. 执行以下命令查看日志： ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + +kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-installer -o jsonpath='{.items[0].metadata.name}') -f + +---- +-- diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage.adoc new file mode 100644 index 000000000..565e43170 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage.adoc @@ -0,0 +1,32 @@ +// :ks_include_id: 654fbac8f3b34fdfbdfb17fa841b2b0a + +. 将{ks_product_left} {ks_product_ver} 安装包传输到任意集群节点，并登录该集群节点。 + +. 执行以下命令解压安装包，并进入安装包解压后生成的目录（将 替换为安装包的实际名称，将 替换为安装包解压后生成的目录）： ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + +tar -zxvf + +---- + +// Bash +include::../../../_ks_components/code/bash.adoc[] + +cd + +---- +-- + +. 执行以下命令为 KubeKey 二进制文件 **kk** 添加执行权限： ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + +sudo chmod +x kk + +---- +-- diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc new file mode 100644 index 000000000..943ec83e3 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc @@ -0,0 +1,32 @@ +// :ks_include_id: 654fbac8f3b34fdfbdfb17fa841b2b0a + +. 将{ks_product_both}安装包传输到任意集群节点，并登录该集群节点。 + +. 执行以下命令解压安装包，并进入安装包解压后生成的目录（将 替换为安装包的实际名称，将 替换为安装包解压后生成的目录）： ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + +tar -zxvf + +---- + +// Bash +include::../../../_ks_components/code/bash.adoc[] + +cd + +---- +-- + +. 执行以下命令为 KubeKey 二进制文件 **kk** 添加执行权限： ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + +sudo chmod +x kk + +---- +-- diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc new file mode 100644 index 000000000..cafb52f3e --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc @@ -0,0 +1,45 @@ +// :ks_include_id: e25e26f73c8441e69eef35173babd610 + +. 如果您访问 GitHub/Googleapis 受限，请登录任意集群节点，执行以下命令设置下载区域： ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + +export KKZONE=cn + +---- +-- + + +. 执行以下命令下载 KubeKey 最新版本： ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + +curl -sfL https://get-kk.kubesphere.io | sh - + +---- + +下载完成后当前目录下将生成 KubeKey 二进制文件 **kk**。 + +// Note +include::../../../_ks_components/admonitions/note.adoc[] + +如果用于执行本节操作的集群节点无法连接互联网，您可以从互联网连接正常的设备手动link:https://github.com/kubesphere/kubekey/releases[下载 KubeKey] 然后将其传输到用于执行本节操作的集群节点。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] +-- +// end::download-kubekey[] + +. 执行以下命令为 KubeKey 二进制文件 **kk** 添加执行权限： ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + +sudo chmod +x kk + +---- +-- diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-editCcKsInstaller.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-editCcKsInstaller.adoc new file mode 100644 index 000000000..ab3fea258 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-editCcKsInstaller.adoc @@ -0,0 +1,45 @@ +// :ks_include_id: 5f6544e2d6a54cc9a3461b0a1ec3366e + +ifeval::["{file_output_type}" == "html"] +. 执行以下命令下载配置文件 **cluster-configuration.yaml** 和 **kubesphere-installer.yaml**： ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + +curl -L -O https://github.com/kubesphere/ks-installer/releases/download/{ks_product_ver}/kubesphere-installer.yaml + +---- + +// Bash +include::../../../_ks_components/code/bash.adoc[] + +curl -L -O https://github.com/kubesphere/ks-installer/releases/download/{ks_product_ver}/cluster-configuration.yaml + +---- + +// Note +include::../../../_ks_components/admonitions/note.adoc[] + +如果您的集群节点无法连接互联网，您可以从互联网连接正常的设备手动下载配置文件 link:https://github.com/kubesphere/ks-installer/releases/download/{ks_product_ver}/kubesphere-installer.yaml[kubesphere-installer.yaml] 和 link:https://github.com/kubesphere/ks-installer/releases/download/{ks_product_ver}/cluster-configuration.yaml[cluster-configuration.yaml]，然后将其传输到 Kubernetes 集群的任意节点。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +. 如果您的集群节点无法连接互联网，执行以下命令在 **kubesphere-installer.yaml** 文件中设置私有镜像服务的地址 **dockerhub.kubekey.local**： ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + +sed -i "s#^\s*image: kubesphere.*/ks-installer:.*#        image: dockerhub.kubekey.local/kubesphere/ks-installer:v3.3.0#" kubesphere-installer.yaml + +---- +-- + +. 如果您的集群节点无法连接互联网，执行以下命令编辑 **cluster-configuration.yaml** 配置文件： +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +. 执行以下命令编辑 **cluster-configuration.yaml** 配置文件： +endif::[] \ No newline at end of file diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-editCcKsInstaller_new.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-editCcKsInstaller_new.adoc new file mode 100644 index 000000000..29ec3b8b3 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-editCcKsInstaller_new.adoc @@ -0,0 +1,46 @@ +// :ks_include_id: 5f6544e2d6a54cc9a3461b0a1ec3366e + +ifeval::["{file_output_type}" == "html"] +. 执行以下命令下载配置文件 **cluster-configuration.yaml** 和 **kubesphere-installer.yaml**： ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + +curl -L -O https://github.com/kubesphere/ks-installer/releases/download/v3.5.0/kubesphere-installer.yaml + +---- + +// Bash +include::../../../_ks_components/code/bash.adoc[] + +curl -L -O https://github.com/kubesphere/ks-installer/releases/download/v3.5.0/cluster-configuration.yaml + +---- + +// Note +include::../../../_ks_components/admonitions/note.adoc[] + +如果您的集群节点无法连接互联网，您可以从互联网连接正常的设备手动下载配置文件 link:https://github.com/kubesphere/ks-installer/releases/download/v3.5.0/kubesphere-installer.yaml[kubesphere-installer.yaml] 和 link:https://github.com/kubesphere/ks-installer/releases/download/v3.5.0/cluster-configuration.yaml[cluster-configuration.yaml]，然后将其传输到 Kubernetes 集群的任意节点。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +. 如果您的集群节点无法连接互联网，执行以下命令在 **kubesphere-installer.yaml** 文件中设置私有镜像服务的地址 **dockerhub.kubekey.local**： ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + +sed -i "s#^\s*image: kubesphere.*/ks-installer:.*# +image: dockerhub.kubekey.local/kubesphere/ks-installer:v3.5.0#" kubesphere-installer.yaml + +---- +-- + +. 如果您的集群节点无法连接互联网，执行以下命令编辑 **cluster-configuration.yaml** 配置文件： +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +. 执行以下命令编辑 **cluster-configuration.yaml** 配置文件： +endif::[] \ No newline at end of file diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-editHosts.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-editHosts.adoc new file mode 100644 index 000000000..3ea4644b0 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-editHosts.adoc @@ -0,0 +1,20 @@ +// :ks_include_id: bc97a1c3d087413bba734c07a3edb221 +. 登录所有集群节点，执行以下命令编辑 **/etc/hosts** 文件： ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + +vi /etc/hosts + +---- + +在 **/etc/hosts** 文件中添加以下信息，从而为集群节点配置私有镜像服务的域名解析规则（将 替换成私有镜像服务的实际 IP 地址），然后保存文件： + +// Bash +include::../../../_ks_components/code/bash.adoc[] + + dockerhub.kubekey.local + +---- +-- diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-editHosts_v4.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-editHosts_v4.adoc new file mode 100644 index 000000000..e2a4847d5 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-editHosts_v4.adoc @@ -0,0 +1,20 @@ +// :ks_include_id: bc97a1c3d087413bba734c07a3edb221 +. 登录所有集群节点，执行以下命令编辑 **/etc/hosts** 文件： ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + +vi /etc/hosts + +---- + +在 **/etc/hosts** 文件中添加以下信息，从而为集群节点配置私有镜像服务的域名解析规则（将 替换成私有镜像服务的实际 IP 地址，将私有镜像服务的默认地址 **dockerhub.kubekey.local** 替换为您的实际镜像仓库地址），然后保存文件： + +// Bash +include::../../../_ks_components/code/bash.adoc[] + + dockerhub.kubekey.local + +---- +-- diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-initializeRegistry.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-initializeRegistry.adoc new file mode 100644 index 000000000..f66bce8b9 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-initializeRegistry.adoc @@ -0,0 +1,106 @@ +// :ks_include_id: af7b991f4aa34769a70397593ae19d73 +. 执行以下命令编辑安装配置文件 **config-sample.yaml**： ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + +vi config-sample.yaml + +---- + +以下为部分示例配置文件，如需了解完整示例，请参阅link:https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md[此文件]。 + +// Bash +include::../../../_ks_components/code/bash.adoc[] + +apiVersion: kubekey.kubesphere.io/v1alpha2 +kind: Cluster +metadata: + name: sample +spec: + hosts: + - {name: node1, address: 192.168.6.6, internalAddress: 192.168.6.6, password: "Qcloud@123"} # arm64 节点注意添加参数 arch: arm64 + roleGroups: + etcd: + - node1     + control-plane: +   - node1 + worker: + - node1 +   # 如需使用 kk 自动部署镜像仓库，请设置该主机组 （建议仓库与集群分离部署，减少相互影响）     + registry: + - node1 + controlPlaneEndpoint: + ## Internal loadbalancer for apiservers + #internalLoadbalancer: haproxy # 如需部署高可用集群，且无负载均衡器可用，可开启该参数做集群内部负载均衡 + domain: lb.kubesphere.local + address: "" + port: 6443 + kubernetes: + version: v1.23.15 + clusterName: cluster.local + network: + plugin: calico + kubePodsCIDR: 10.233.64.0/18 + kubeServiceCIDR: 10.233.0.0/18 + ## multus support. https://github.com/k8snetworkplumbingwg/multus-cni + enableMultusCNI: false + registry: + # 如需使用 kk 部署 harbor, 可将该参数设置为 harbor，不设置该参数且需使用 kk 部署容器镜像仓库，将默认部署 docker registry。 + # harbor 不支持 arm64, arm64 环境部署时，可不配置该参数。 +   type: harbor + # 如使用 kk 部署的 harbor 或其他需要登录的仓库，需设置对应仓库的 auths，如使用 kk 部署默认的 docker registry 仓库，则无需配置该参数。 + # 注意：如使用 kk 部署 harbor，该参数请于 harbor 启动后设置。 +   auths: + "dockerhub.kubekey.local": + username: admin + password: Harbor12345 + plainHTTP: false # 如果仓库使用 http，请将该参数设置为true + privateRegistry: "dockerhub.kubekey.local" # 设置集群部署时使用的私有仓库地址 + registryMirrors: [] + insecureRegistries: [] + addons: [] + +---- + + +在 **spec:hosts** 参数下设置用于创建私有镜像服务的服务器的信息。 + +include::installationAndUpgrade-para-hosts.adoc[] + +在 **spec:roleGroups:registry** 参数下设置用于创建私有镜像服务的服务器名称（将 替换为 **spec:hosts** 参数下设置的服务器实际名称）。 + +// YAML +include::../../../_ks_components/code/yaml.adoc[] + + registry: + - + +---- + +将 **spec:registry:privateRegistry** 参数设置为私有镜像服务的地址 **dockerhub.kubekey.local**，然后保存文件。 + +// YAML +include::../../../_ks_components/code/yaml.adoc[] + + registry: + registryMirrors: [] + insecureRegistries: [] + privateRegistry: dockerhub.kubekey.local + +---- +-- + +. 执行以下命令初始化私有镜像服务： ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + + ./kk init registry -f config-sample.yaml -a kubekey-artifact.tar.gz + +---- + +include::installationAndUpgrade-note-initializeRegistry.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-transferConfig.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-transferConfig.adoc new file mode 100644 index 000000000..1c121e1e6 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-oper-transferConfig.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 66c1533ca6e84872b4cfbedc6db42824 +. 将安装配置文件 **config-sample.yaml** 传输到当前目录。 diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-para-controlPlaneEndpoint.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-para-controlPlaneEndpoint.adoc new file mode 100644 index 000000000..1955fb831 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-para-controlPlaneEndpoint.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: d52c19a289c447d1ad5ec4114ecd814a +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|internalLoadbalancer +|本地负载均衡器的类型。如果使用本地负载均衡配置，请将此参数设置为 **haproxy**。否则，请将此参数注释掉。 + +|domain +|负载均衡器的内部访问域名。请将此参数设置为 **lb.kubesphere.local**。 + +|address +|负载均衡器的 IP 地址。如果使用本地负载均衡配置，请将此参数留空；如果使用专用负载均衡器，请将此参数设置为负载均衡器的 IP 地址；如果使用通用服务器作为负载均衡器，请将此参数设置为负载均衡器的浮动 IP 地址。 + +|port +|负载均衡器监听的端口号，即 apiserver 服务的端口号。请将此参数设置为 **6443**。 +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-para-hosts.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-para-hosts.adoc new file mode 100644 index 000000000..5137a6143 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-para-hosts.adoc @@ -0,0 +1,29 @@ +// :ks_include_id: 011f0f1d835947cbb1b37e80036c0b2e +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|name +|用户自定义的服务器名称。 + +|address +|服务器的 SSH 登录 IP 地址。 + +|internalAddress +|服务器在子网内部的 IP 地址。 + +|port +|服务器的 SSH 端口号。如果使用默认端口 22 可不设置此参数。 + +|user +|服务器的 SSH 登录用户名，该用户必须为 **root** 用户或其他具有 **sudo** 命令执行权限的用户。如果使用 **root** 用户可不设置此参数。 + +|password +|服务器的 SSH 登录密码。如果已经设置 **privateKeyPath** 可不设置此参数。 + +|privateKeyPath +|服务器的 SSH 登录密钥的路径。如果已经设置 **password** 可不设置此参数。 + +|arch +|服务器的硬件架构。如果服务器的硬件架构为 Arm64，请将此参数设置为 **arm64**，否则请勿设置此参数。安装包默认仅支持所有集群节点都为 x86_64 或 arm64 架构的场景。如果各集群节点的硬件架构不完全相同，请联系{ks_product_both}技术支持团队。 +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-para-roleGroups.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-para-roleGroups.adoc new file mode 100644 index 000000000..f4267f0bc --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-para-roleGroups.adoc @@ -0,0 +1,20 @@ +// :ks_include_id: bcd276927dfd4924a47a068697e1b751 +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|etcd +|安装 etcd 数据库的节点。请在此参数下设置集群控制平面节点。 + +|control-plane +|集群控制平面节点。如果您已经为集群配置了高可用性，您可以设置多个控制平面节点。 + +|worker +|集群工作节点。 + +|registry +|用于创建私有镜像服务的服务器。该服务器不会用作集群节点。 +ifeval::["{file_output_type}" == "html"] +安装、升级{ks_product_both}时，如果集群节点无法连接互联网，需要在此参数下设置用于创建私有镜像服务的服务器。其他情况下请将此参数注释掉。 +endif::[] +|=== diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-para-targetKsK8sVersions.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-para-targetKsK8sVersions.adoc new file mode 100644 index 000000000..64126a353 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-para-targetKsK8sVersions.adoc @@ -0,0 +1,13 @@ +// :ks_include_id: 524ea797e25b46cc9d437e2effa79c8d +将以下参数替换为实际需要的值： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +| +|目标 Kubernetes 版本，例如 **v1.21.5**。{ks_product} {ks_product_ver} 支持 Kubernetes v1.21.x、v1.22.x、v1.23.x, v1.24.x, v1.25.x 和 v1.26.x。 + +| +|目标{ks_product_both}版本。请将此参数设置为 **{ks_product_ver}**。 +|=== diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-para-targetKsK8sVersions_new.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-para-targetKsK8sVersions_new.adoc new file mode 100644 index 000000000..c39079721 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-para-targetKsK8sVersions_new.adoc @@ -0,0 +1,13 @@ +// :ks_include_id: 524ea797e25b46cc9d437e2effa79c8d +将以下参数替换为实际需要的值： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +| +|目标 Kubernetes 版本，例如 **v1.21.5**。{ks_product} v3.5.0 支持 Kubernetes v1.21.x、v1.22.x、v1.23.x, v1.24.x, v1.25.x 和 v1.26.x。 + +| +|目标{ks_product_both}版本。请将此参数设置为 **v3.5.0**。 +|=== diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-prer-backUpData.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-prer-backUpData.adoc new file mode 100644 index 000000000..7ef14d266 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-prer-backUpData.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 50cd63fd16fa4df7a5bea0e87ac5d117 +为避免数据丢失，请提前备份所有重要数据。 diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-prer-obtainConfigSample.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-prer-obtainConfigSample.adoc new file mode 100644 index 000000000..e0bfcfe85 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-prer-obtainConfigSample.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 741fdd4419bf462d8fe4db1db108806f +* 您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅xref:03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc[安装 Kubernetes 和{ks_product_left}]。 \ No newline at end of file diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-prer-obtainInstallationPackage.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-prer-obtainInstallationPackage.adoc new file mode 100644 index 000000000..1d9bc268d --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-prer-obtainInstallationPackage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c5b6d2f08662480b8ae449c5d8c84ef6 +* 您需要联系{ks_product_both}技术支持团队获取{ks_product_left} {ks_product_ver} 安装包。 \ No newline at end of file diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-prer-obtainInstallationPackage_new.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-prer-obtainInstallationPackage_new.adoc new file mode 100644 index 000000000..f4bfbba96 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-prer-obtainInstallationPackage_new.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c5b6d2f08662480b8ae449c5d8c84ef6 +* 您需要联系{ks_product_both}技术支持团队获取{ks_product_left} v3.5.0 安装包。 \ No newline at end of file diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-prer-offlineInstallation.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-prer-offlineInstallation.adoc new file mode 100644 index 000000000..7e29cf9c4 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-prer-offlineInstallation.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: d1f066141f214cd6839e0b1ff16062b0 +ifeval::["{file_output_type}" == "html"] +* 如果您的集群节点无法连接互联网，您还需要准备一台 Linux 服务器用于创建私有镜像服务，该服务器必须与{ks_product_both}集群节点网络连通并且在 **/mnt/registry** 目录挂载至少 100 GB 磁盘空间。 + +// 除此之外，您需要提前创建离线安装包 **kubekey-artifact.tar.gz** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅 xref:03-installation-and-upgrade/01-preparations/02-create-an-offline-installation-package.adoc#f1b9272448bc43299a9e8cbd3b23cd1f[创建离线安装包]。 + +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +* 除集群节点外，您还需要准备一台 Linux 服务器用于创建私有镜像服务，该服务器必须与{ks_product_both}集群节点网络连通，并且在 **/mnt/registry** 目录挂载至少 100 GB 磁盘空间。 +endif::[] diff --git a/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-startInstallationOffline.adoc b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-startInstallationOffline.adoc new file mode 100644 index 000000000..99fa5e214 --- /dev/null +++ b/content/zh/docs/_custom/installationAndUpgrade/installationAndUpgrade-startInstallationOffline.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: d864cdae8aef4d39917a96709ad7d1d4 +// Bash +include::../../../_ks_components/code/bash.adoc[] + + ./kk create cluster -f config-sample.yaml -a kubekey-artifact.tar.gz + +---- diff --git a/content/zh/docs/_custom/multi-clusterProjectManagement/apps/apps-oper-viewResourceStatus.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/apps/apps-oper-viewResourceStatus.adoc new file mode 100644 index 000000000..2a0e1adcf --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/multi-clusterProjectManagement/apps/apps-para-details.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/apps/apps-para-details.adoc new file mode 100644 index 000000000..06bd4879d --- /dev/null +++ b/content/zh/docs/_custom/multi-clusterProjectManagement/apps/apps-para-details.adoc @@ -0,0 +1,19 @@ +// :ks_include_id: 70f19c4ccbb54fb4ad10de0f5c8a4a1e + +|项目 +|应用所属的项目。 + +|应用 +|应用的名称。 + +|版本 +|应用的版本。 + +|创建时间 +|应用的创建时间。 + +|更新时间 +|应用的更新时间。 + +|创建者 +|创建应用的用户。 diff --git a/content/zh/docs/_custom/multi-clusterProjectManagement/configmaps/config-desc.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/configmaps/config-desc.adoc new file mode 100644 index 000000000..fcc3aa375 --- /dev/null +++ b/content/zh/docs/_custom/multi-clusterProjectManagement/configmaps/config-desc.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: b4d12ee4d7d748a4915f6f72d47fa1d7 +本节介绍如何管理配置资源。 + +{ks_product_right}支持管理以下两类配置资源： + +* 保密字典：包含 Base64 编码的键值对，用于存储密码、令牌、密钥等保密数据。 + +* 配置字典：包含明文键值对，用于存储普通配置数据。 diff --git a/content/zh/docs/_custom/multi-clusterProjectManagement/configmaps/configmaps-oper-viewConfigmapDetails.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/configmaps/configmaps-oper-viewConfigmapDetails.adoc new file mode 100644 index 000000000..23c588fb7 --- /dev/null +++ b/content/zh/docs/_custom/multi-clusterProjectManagement/configmaps/configmaps-oper-viewConfigmapDetails.adoc @@ -0,0 +1,20 @@ +// :ks_include_id: 69e70e31d4604cfaaab5683e4ecae96c +. 在配置字典详情页面左侧的**属性**区域查看配置字典的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|项目 +|配置字典所属的项目。 + +|创建时间 +|配置字典的创建时间。 + +|创建者 +|创建配置字典的用户。 +|=== +-- + +. 在配置字典右侧的**数据**页签查看配置字典中存储的键值对数据。 diff --git a/content/zh/docs/_custom/multi-clusterProjectManagement/configmaps/configmaps-para-configmapList.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/configmaps/configmaps-para-configmapList.adoc new file mode 100644 index 000000000..e562b7c20 --- /dev/null +++ b/content/zh/docs/_custom/multi-clusterProjectManagement/configmaps/configmaps-para-configmapList.adoc @@ -0,0 +1,21 @@ +// :ks_include_id: 7faeedc1e81841e7a783f960b238f5f0 +* 配置字典列表提供以下信息： ++ +-- +[%header,cols="1,4"] +|=== +|参数 |描述 + +|名称 +|配置字典的名称。 + +|状态 +|配置字典当前的状态。 + +|数据 +|配置字典存储的键值对数据的键名称。不同的键通过半角逗号（,）分隔。 + +|创建时间 +|配置字典的创建时间。 +|=== +-- diff --git a/content/zh/docs/_custom/multi-clusterProjectManagement/project-config/project-quota-para.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/project-config/project-quota-para.adoc new file mode 100644 index 000000000..5ae518f49 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/multi-clusterProjectManagement/project-config/project-quota-para_v4.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/project-config/project-quota-para_v4.adoc new file mode 100644 index 000000000..c8a4290c4 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage.adoc new file mode 100644 index 000000000..2be7967e7 --- /dev/null +++ b/content/zh/docs/_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 161aaad98ab04d7fa4240eec51d232f7 +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的多集群项目。 diff --git a/content/zh/docs/_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc new file mode 100644 index 000000000..bbbbb480f --- /dev/null +++ b/content/zh/docs/_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 161aaad98ab04d7fa4240eec51d232f7 +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的联邦项目。 diff --git a/content/zh/docs/_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission.adoc new file mode 100644 index 000000000..b8074c487 --- /dev/null +++ b/content/zh/docs/_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: a7b11e38d6794c2692390f9d0afbb7df +您需要加入一个多集群项目并在项目中具有pass:a,q[{ks_permission}]权限。 diff --git a/content/zh/docs/_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc new file mode 100644 index 000000000..70cba9fe9 --- /dev/null +++ b/content/zh/docs/_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: a7b11e38d6794c2692390f9d0afbb7df +您需要加入一个联邦项目并在对应企业空间中具有pass:a,q[{ks_permission}]权限。 diff --git a/content/zh/docs/_custom/multi-clusterProjectManagement/routes/routes-create-ClusterDiff.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/routes/routes-create-ClusterDiff.adoc new file mode 100644 index 000000000..749f72184 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/multi-clusterProjectManagement/routes/routes-para-routeList.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/routes/routes-para-routeList.adoc new file mode 100644 index 000000000..7c62b6e5a --- /dev/null +++ b/content/zh/docs/_custom/multi-clusterProjectManagement/routes/routes-para-routeList.adoc @@ -0,0 +1,21 @@ +// :ks_include_id: d43be0d6bddf43e5aacfeed52c0fe32a +* 应用路由列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|应用路由的名称和描述。 + +|状态 +|应用路由当前的状态。 + +|应用 +|应用路由所对应的应用名称。 + +|创建时间 +|应用路由的创建时间。 +|=== +-- diff --git a/content/zh/docs/_custom/multi-clusterProjectManagement/services/services-oper-setClusterDiff.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/services/services-oper-setClusterDiff.adoc new file mode 100644 index 000000000..2ebea3934 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/multi-clusterProjectManagement/services/services-oper-setStorageAdvancedDiff.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/services/services-oper-setStorageAdvancedDiff.adoc new file mode 100644 index 000000000..85a583238 --- /dev/null +++ b/content/zh/docs/_custom/multi-clusterProjectManagement/services/services-oper-setStorageAdvancedDiff.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 417489540caa4044871d8fba1c13e801 +. 在**存储设置**页签，为服务后端工作负载管理的容器挂载卷，然后点击**下一步**。 + +. 在**高级设置**页签，为服务后端工作负载管理的容器组指定 IP 池和节点，设置服务的外部访问模式、会话保持设置和元数据，然后点击**下一步**。 + +. 在**集群差异设置**页签，为不同集群中的服务基于容器、端口和环境变量进行差异化设置，然后点击**创建**。服务创建完成后将显示在服务列表中。 diff --git a/content/zh/docs/_custom/multi-clusterProjectManagement/workloads/para-replicasPortsPods.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/workloads/para-replicasPortsPods.adoc new file mode 100644 index 000000000..ee9cd1690 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/multi-clusterProjectManagement/workloads/workloads-oper-openDetailsPage.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/workloads/workloads-oper-openDetailsPage.adoc new file mode 100644 index 000000000..b890d8235 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/multi-clusterProjectManagement/workloads/workloads-oper-setClusterDiff.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/workloads/workloads-oper-setClusterDiff.adoc new file mode 100644 index 000000000..01da4247e --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/multi-clusterProjectManagement/workloads/workloads-oper-viewWorkloadDetails.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/workloads/workloads-oper-viewWorkloadDetails.adoc new file mode 100644 index 000000000..c7e9e78ca --- /dev/null +++ b/content/zh/docs/_custom/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/oper-selectTimeRange.adoc[] +include::../../../../_ks_components/oper-Autorefresh.adoc[] +include::../../../../_ks_components/oper-refreshData.adoc[] +-- + +. 在工作负载详情页面右侧点击**事件**页签查看工作负载相关的事件。 ++ +-- +include::../../clusterManagement/clusterManagement-para-eventsTab.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/_custom/multi-clusterProjectManagement/workloads/workloads-oper-viewWorkloadDetails_v4.adoc b/content/zh/docs/_custom/multi-clusterProjectManagement/workloads/workloads-oper-viewWorkloadDetails_v4.adoc new file mode 100644 index 000000000..be8bf1c4f --- /dev/null +++ b/content/zh/docs/_custom/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/oper-selectTimeRange.adoc[] +// include::../../../../_ks_components/oper-Autorefresh.adoc[] +// include::../../../../_ks_components/oper-refreshData.adoc[] +// -- + +. 在工作负载详情页面右侧点击**事件**页签查看工作负载相关的事件。 ++ +-- +include::../../clusterManagement/clusterManagement-para-eventsTab.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/_custom/note-separateNamesByComma.adoc b/content/zh/docs/_custom/note-separateNamesByComma.adoc new file mode 100644 index 000000000..7f92ddd59 --- /dev/null +++ b/content/zh/docs/_custom/note-separateNamesByComma.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: bcbfd3ccebad4b3285b0a8fd9daf855d +// Note +include::../../_ks_components/admonitions/note.adoc[] + +请使用半角逗号（,）和空格分隔多个名称。 + +include::../../_ks_components/admonitions/admonEnd.adoc[] \ No newline at end of file diff --git a/content/zh/docs/_custom/para-replicasPortsPods.adoc b/content/zh/docs/_custom/para-replicasPortsPods.adoc new file mode 100644 index 000000000..ff890914d --- /dev/null +++ b/content/zh/docs/_custom/para-replicasPortsPods.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: 9dfd0319fc99473aa7930dfd36ff5321 +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|副本 +|工作负载的当前容器组副本数和期望容器组副本数。 + +|端口 +|工作负载管理的容器的端口名称、协议和端口号。 + +|容器组 +| +工作负载中运行的所有容器组。 + +include::clusterManagement/nodes/nodes-para-podList.adoc[] +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/platformManagement/accessControl/platformRoles/platformRoles-para-aliasDescription.adoc b/content/zh/docs/_custom/platformManagement/accessControl/platformRoles/platformRoles-para-aliasDescription.adoc new file mode 100644 index 000000000..8f37861dd --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/accessControl/platformRoles/platformRoles-para-aliasDescription.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: ab00e2a484af4b28883732e655a5eca8 +|别名 +|平台角色的别名。不同企业空间角色的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|平台角色的描述信息。描述可包含任意字符，最长 256 个字符。 diff --git a/content/zh/docs/_custom/platformManagement/accessControl/platformRoles/platformRoles-para-permissions.adoc b/content/zh/docs/_custom/platformManagement/accessControl/platformRoles/platformRoles-para-permissions.adoc new file mode 100644 index 000000000..68fe9791b --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/platformManagement/accessControl/platformRoles/platformRoles-para-permissions_new.adoc b/content/zh/docs/_custom/platformManagement/accessControl/platformRoles/platformRoles-para-permissions_new.adoc new file mode 100644 index 000000000..353a7f3d0 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/platformManagement/accessControl/users/users-oper-deleteASingleUser.adoc b/content/zh/docs/_custom/platformManagement/accessControl/users/users-oper-deleteASingleUser.adoc new file mode 100644 index 000000000..7518d15e7 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/platformManagement/accessControl/users/users-oper-deleteMultipleUsers.adoc b/content/zh/docs/_custom/platformManagement/accessControl/users/users-oper-deleteMultipleUsers.adoc new file mode 100644 index 000000000..e529b5998 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/accessControl/users/users-oper-deleteMultipleUsers.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 0a2acbdb2d9d421396a23302b0355ee0 +. 选择需要删除的用户左侧的复选框，然后在列表上方点击**删除**。 + +. 在**批量删除用户**对话框，输入用户的名称，然后点击**确定**。 ++ +-- +include::../../../note-separateNamesByComma.adoc[] +-- diff --git a/content/zh/docs/_custom/platformManagement/accessControl/users/users-para-description.adoc b/content/zh/docs/_custom/platformManagement/accessControl/users/users-para-description.adoc new file mode 100644 index 000000000..6024de1a3 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/accessControl/users/users-para-description.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 0f84e76eac814b369d9d7d787b76978f +|描述 +|用户的描述信息。描述可包含任意字符，最长 256 个字符。 diff --git a/content/zh/docs/_custom/platformManagement/accessControl/users/users-para-email.adoc b/content/zh/docs/_custom/platformManagement/accessControl/users/users-para-email.adoc new file mode 100644 index 000000000..6009fa660 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/accessControl/users/users-para-email.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 8045ddccddf74c4ebc4fdda0018be4f9 +|邮箱 +|用户的邮箱地址。邮箱地址可用于登录{ks_product_left} Web 控制台。 diff --git a/content/zh/docs/_custom/platformManagement/accessControl/users/users-para-lastLogin.adoc b/content/zh/docs/_custom/platformManagement/accessControl/users/users-para-lastLogin.adoc new file mode 100644 index 000000000..b4c424ecd --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/accessControl/users/users-para-lastLogin.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 094ac151a3d24a8a82e6c17d3cd06150 +|最近登录 +|用户最后一次登录{ks_product_left} Web 控制台的时间。 diff --git a/content/zh/docs/_custom/platformManagement/accessControl/users/users-para-openDetailsPage.adoc b/content/zh/docs/_custom/platformManagement/accessControl/users/users-para-openDetailsPage.adoc new file mode 100644 index 000000000..d92f093f6 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/platformManagement/accessControl/users/users-para-platformRole.adoc b/content/zh/docs/_custom/platformManagement/accessControl/users/users-para-platformRole.adoc new file mode 100644 index 000000000..a183ba379 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/accessControl/users/users-para-platformRole.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 6d1f98cd75794e74ac21e70c3d969a7b +|平台角色 +|用户在{ks_product_both}平台的角色。平台角色将决定用户在{ks_product_both}的权限。 diff --git a/content/zh/docs/_custom/platformManagement/accessControl/workspaces/workspaces-para-alias.adoc b/content/zh/docs/_custom/platformManagement/accessControl/workspaces/workspaces-para-alias.adoc new file mode 100644 index 000000000..7b3f005ea --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/accessControl/workspaces/workspaces-para-alias.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: e61943aee54940b8b168df6e8670fe56 +|别名 +|企业空间的别名。不同企业空间的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 diff --git a/content/zh/docs/_custom/platformManagement/accessControl/workspaces/workspaces-para-description.adoc b/content/zh/docs/_custom/platformManagement/accessControl/workspaces/workspaces-para-description.adoc new file mode 100644 index 000000000..a37839fe3 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/accessControl/workspaces/workspaces-para-description.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 4b6b94bc523849ce96c16f75888e6871 +|描述 +|企业空间的描述信息。描述可包含任意字符，最长 256 个字符。 diff --git a/content/zh/docs/_custom/platformManagement/appStoreManagement/appTemplates/appTemplates-para-templateCategories.adoc b/content/zh/docs/_custom/platformManagement/appStoreManagement/appTemplates/appTemplates-para-templateCategories.adoc new file mode 100644 index 000000000..3af198a21 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/platformManagement/appStoreManagement/appTemplates/appTemplates-para-templateStatus.adoc b/content/zh/docs/_custom/platformManagement/appStoreManagement/appTemplates/appTemplates-para-templateStatus.adoc new file mode 100644 index 000000000..5718ecc9f --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/appStoreManagement/appTemplates/appTemplates-para-templateStatus.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: 3ee13f9fe099432788220e03d24f96ce +|状态 +|应用模板当前的状态。 + +* **已发布**：应用模板中至少有一个应用版本状态已发布到应用商店。 + +* **已下架**：应用模板中的所有应用版本都已下架。 diff --git a/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-desc-waitForExtensionDisabled.adoc b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-desc-waitForExtensionDisabled.adoc new file mode 100644 index 000000000..aab31d399 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-desc-waitForExtensionDisabled.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c7f7a227d261492aa85e52060e0d8efc +扩展组件禁用过程可能需要一定时间，请等待禁用完成。 diff --git a/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-desc-waitForExtensionEnabled.adoc b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-desc-waitForExtensionEnabled.adoc new file mode 100644 index 000000000..541a522b8 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-desc-waitForExtensionEnabled.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: eccad0736cc54ecf90209d6d5e1c6530 +* 扩展组件启用过程可能需要一定时间，请等待启用完成。 diff --git a/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-oper-deleteStatusEs.adoc b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-oper-deleteStatusEs.adoc new file mode 100644 index 000000000..995ff0382 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-oper-deleteStatusEs.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: 90a37798901c4e17b3927a928d018e29 +删除以下参数： + +// YAML +include::../../../../_ks_components/code/yaml.adoc[] + +status: + es: + enabledTime: 2022-08-11T06:22:01UTC + status: enabled + +---- diff --git a/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-oper-disableOberservabilityCenter.adoc b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-oper-disableOberservabilityCenter.adoc new file mode 100644 index 000000000..6c0b93388 --- /dev/null +++ b/content/zh/docs/_custom/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/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/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-oper-editCC.adoc b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-oper-editCC.adoc new file mode 100644 index 000000000..ef4b62bc2 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-oper-editCC.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: 3d4578a964454b68a55ed88860355d8e +. 在 **kubectl** 对话框，执行以下命令编辑集群配置文件： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +kubectl edit cc ks-installer -n kubesphere-system + +---- +-- diff --git a/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc new file mode 100644 index 000000000..668117073 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 6eca522f12cc4fac84157f8cae7f92ba +. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 diff --git a/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-oper-openKubectl.adoc b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-oper-openKubectl.adoc new file mode 100644 index 000000000..5a69795e6 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-oper-openKubectl.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: db20d1bbd2ed4dc9af2b84f07b0b87e3 +. 将光标悬停在页面右下角的image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18]图标，然后在菜单中选择 **kubectl**。 diff --git a/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-oper-setExternalElasticsearch.adoc b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-oper-setExternalElasticsearch.adoc new file mode 100644 index 000000000..73d0e023c --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-oper-setExternalElasticsearch.adoc @@ -0,0 +1,22 @@ +// :ks_include_id: 3c4ccff9b03e44d9bc09a0d109039463 +* 如需使用外部 Elasticsearch 服务，将 **externalElasticsearchHost** 和 **externalElasticsearchPort** 参数分别设置为 Elasticsearch 服务的地址和端口号。 ++ +-- +// YAML +include::../../../../_ks_components/code/yaml.adoc[] + +spec: + common: + es: + externalElasticsearchHost: "" + externalElasticsearchPort: "" + +---- + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +如果您不设置外部 Elasticsearch 服务的地址和端口号，{ks_product_right}将安装并使用内置 Elasticsearch 服务。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] +-- diff --git a/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-oper-setParametersInCc.adoc b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-oper-setParametersInCc.adoc new file mode 100644 index 000000000..12131fe87 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-oper-setParametersInCc.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9cf6ccf21d414fdbb88676af3417b2fb +. 在集群配置文件中，设置以下参数，然后保存文件。 diff --git a/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-prer-platformAdmin.adoc b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-prer-platformAdmin.adoc new file mode 100644 index 000000000..03d778c0b --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/extensionManagement/extensionManagement-prer-platformAdmin.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 533e874085874479aae0d8bb598443f2 +您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅xref:04-platform-management/04-access-control/02-users/_index.adoc[用户]和xref:04-platform-management/04-access-control/03-platform-roles/_index.adoc[平台角色]。 diff --git a/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusterTags/clusterTags-openListPage.adoc b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusterTags/clusterTags-openListPage.adoc new file mode 100644 index 000000000..2d2d36836 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusterTags/clusterTags-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 0531ad01f6504951b7876d7d79c0bc59 +. 在**集群管理**页面，点击**集群标签**页签打开集群标签列表。 \ No newline at end of file diff --git a/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterBasicInfo.adoc b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterBasicInfo.adoc new file mode 100644 index 000000000..3e0a19ced --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterBasicInfo.adoc @@ -0,0 +1,16 @@ +// :ks_include_id: 9db9031f82114758ae483f38e21709cb +. 在**集群管理**页面，点击**添加集群**。 + +. 在**基本信息**页签，设置成员集群的名称、标签、提供商和描述信息，然后点击**下一步**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|成员集群的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 + +include::clusters-para-tagProviderDescription.adoc[] +|=== +-- diff --git a/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterTags.adoc b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterTags.adoc new file mode 100644 index 000000000..bfef9525d --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterTags.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 8caf86e9401c464db99437a414d7b638 +. 在需要操作的集群右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**添加标签**。 + +. 在**添加标签**对话框，选择标签的键和值，点击**添加**，然后点击**确定**。 ++ +-- +标签添加后，您可以集群列表上方点击搜索框按标签搜索集群。 +-- \ No newline at end of file diff --git a/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToHost.adoc b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToHost.adoc new file mode 100644 index 000000000..5a7aa14bd --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToHost.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 7cf91b11a38f4489821f2a2d6263ba79 +. 以具有 **platform-admin** 角色的用户登录主集群的 Web 控制台。 diff --git a/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToMember.adoc b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToMember.adoc new file mode 100644 index 000000000..4ca151591 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToMember.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 6f5ad82253e247759208da8268e3a081 +. 以具有 **platform-admin** 角色的用户登录成员集群的 Web 控制台。 diff --git a/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-setJwtsecret.adoc b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-setJwtsecret.adoc new file mode 100644 index 000000000..18fbb3b74 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-setJwtsecret.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: cdb73bd2ec05458fbc52d34a87cff019 +. 在集群配置文件中，将 **spec:authentication:jwtSecret** 参数设置为主集群的 jwtSecret 值，然后保存文件。 diff --git a/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-para-tagProviderDescription.adoc b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-para-tagProviderDescription.adoc new file mode 100644 index 000000000..612915f59 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-para-tagProviderDescription.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: b4185a2af95d4c7ba1cbf681916d81a0 +|标签 +|成员集群的标签。您可以在下拉列表中选择标签，也可以手动输入标签。 + +|提供商 +|成员集群的提供商。您可以在下拉列表中选择提供商，也可以手动输入提供商。 + +|描述 +|成员集群的描述信息。描述可包含任意字符，最长 256 个字符。 diff --git a/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-prer-enableMulticluster.adoc b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-prer-enableMulticluster.adoc new file mode 100644 index 000000000..4cb11f252 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-prer-enableMulticlusterManagement.adoc b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-prer-enableMulticlusterManagement.adoc new file mode 100644 index 000000000..1f4d5d808 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-prer-enableMulticlusterManagement.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 37c5f9735a854c9da9d6dae831f217d2 +* {ks_product_right}平台需要启用多集群管理扩展组件。有关更多信息，请参阅xref:04-platform-management/01-extension-management/13-multi-cluster-management/01-enable-multi-cluster-management.adoc[启用多集群管理]。 diff --git a/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-prer-obtainJwtsecret.adoc b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-prer-obtainJwtsecret.adoc new file mode 100644 index 000000000..2c7df93ba --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-prer-obtainJwtsecret.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: 33a4ed2e95284895920ebfa744f2f2eb +. 在 **kubectl** 对话框，执行以下命令获取主集群的 jwtSecret 值。 ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +kubectl -n kubesphere-system get cm kubesphere-config -o yaml | grep -v "apiVersion" | grep jwtSecret + +---- +-- diff --git a/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-prer-platformAdminHostMemeber.adoc b/content/zh/docs/_custom/platformManagement/multiclusterManagement/clusters/clusters-prer-platformAdminHostMemeber.adoc new file mode 100644 index 000000000..5f4d5ad46 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-commonParameters.adoc b/content/zh/docs/_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-commonParameters.adoc new file mode 100644 index 000000000..fc174978c --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-commonParameters_new.adoc b/content/zh/docs/_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-commonParameters_new.adoc new file mode 100644 index 000000000..760a77e81 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-duration.adoc b/content/zh/docs/_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-duration.adoc new file mode 100644 index 000000000..fcf28a869 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-duration.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 3c60b62a4b7b46268fc4359057be4bbd +|持续时间 +|设置系统等待一段时间并检查告警情况是否持续存在，如果告警情况持续存在才触发告警。 diff --git a/content/zh/docs/_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-ruleExpression.adoc b/content/zh/docs/_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-ruleExpression.adoc new file mode 100644 index 000000000..a30ee9aa1 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-triggerCondition.adoc b/content/zh/docs/_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-triggerCondition.adoc new file mode 100644 index 000000000..4bcb88f3c --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/platformManagement/platformManagement-oper-logIn.adoc b/content/zh/docs/_custom/platformManagement/platformManagement-oper-logIn.adoc new file mode 100644 index 000000000..6102dc7c3 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/platformManagement-oper-logIn.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 541b15e404b44af589125a703978271e +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 diff --git a/content/zh/docs/_custom/platformManagement/platformManagement-prer-enableAppStore.adoc b/content/zh/docs/_custom/platformManagement/platformManagement-prer-enableAppStore.adoc new file mode 100644 index 000000000..87efef97e --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/platformManagement-prer-enableAppStore.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 5fdcd8cc560f4cff91cb47b7de175bd3 +* {ks_product_right}平台需要启用应用管理扩展组件。有关更多信息，请参阅xref:04-platform-management/01-extension-management/01-app-management/01-enable-app-management.adoc[启用应用管理]。 diff --git a/content/zh/docs/_custom/platformManagement/platformManagement-prer-requiredPermission.adoc b/content/zh/docs/_custom/platformManagement/platformManagement-prer-requiredPermission.adoc new file mode 100644 index 000000000..40131b5d3 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/platformManagement-prer-requiredPermission.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 95e415bcbafa45ed8545cb7700801b09 +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:04-platform-management/04-access-control/02-users/_index.adoc[用户]和xref:04-platform-management/04-access-control/03-platform-roles/_index.adoc[平台角色]。 diff --git a/content/zh/docs/_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc b/content/zh/docs/_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc new file mode 100644 index 000000000..59c6ceff4 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 95e415bcbafa45ed8545cb7700801b09 +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:05-users-and-roles/01-users/_index.adoc[用户]和xref:05-users-and-roles/02-platform-roles/_index.adoc[平台角色]。 diff --git a/content/zh/docs/_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-filterRule.adoc b/content/zh/docs/_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-filterRule.adoc new file mode 100644 index 000000000..6bfc1daad --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-filterRule.adoc @@ -0,0 +1,22 @@ +// :ks_include_id: 6883b8e230774b5085de676f53fe897b +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|键 +|通知内容中的键。点击下拉列表可选择预设的键，在下拉列表中可以输入自定义的键。 + +|操作符 +|筛选条件的操作符。 + +* **包含**：键对应的值包含特定的字符串。 + +* **不包含**：键对应的值不包含特定的字符串。 + +* **存在**：通知内容中存在特定的键。 + +* **不存在**：通知内容中不存在特定的键。 + +|值 +|键对应的值必须包含的字符串。按 **Enter** 可设置多个字符串，键对应的值包含其中一个字条串即满足条件。 +|=== diff --git a/content/zh/docs/_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-filterRule_new.adoc b/content/zh/docs/_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-filterRule_new.adoc new file mode 100644 index 000000000..5fdcf0a65 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-groupChatBotSettings.adoc b/content/zh/docs/_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-groupChatBotSettings.adoc new file mode 100644 index 000000000..e15775f17 --- /dev/null +++ b/content/zh/docs/_custom/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_right}将向该 URL 发送通知。 + +|Secret +|群机器人的访问密钥。 + +|关键词 +|群机器人接受的关键词。点击**添加**可设置多个关键词。 +|=== +-- diff --git a/content/zh/docs/_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions.adoc b/content/zh/docs/_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions.adoc new file mode 100644 index 000000000..a0bb3c3a4 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: cd2ef9bcec6f4a9e8c517cfa2a4c539d +* 过滤条件 ++ +-- +{ks_product_right}发送的通知以键值对的形式呈现，您可以设置系统仅发送标签符合特定条件的通知。点击**添加**可设置多个条件。 + +include::notificationChannels-para-filterRule.adoc[] +-- diff --git a/content/zh/docs/_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc b/content/zh/docs/_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc new file mode 100644 index 000000000..b5a2b9374 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: cd2ef9bcec6f4a9e8c517cfa2a4c539d +* 过滤条件 ++ +-- +{ks_product_right}发送的通知以键值对的形式呈现。当此处填写的**键**和**值**与规则组告警规则的标签设置中的**键**和**值**一致时，就可以通过标签过滤，发送标签符合特定条件的告警通知。点击**添加**可设置多个条件。 + +include::notificationChannels-para-filterRule_new.adoc[] +-- diff --git a/content/zh/docs/_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc b/content/zh/docs/_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc new file mode 100644 index 000000000..31859ac00 --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: a951805f6c724c60851e752934b9e529 +* 点击**发送测试信息**以确认通知渠道工作正常。 diff --git a/content/zh/docs/_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sessionId.adoc b/content/zh/docs/_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sessionId.adoc new file mode 100644 index 000000000..eb35585a1 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-aliasDescription.adoc b/content/zh/docs/_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-aliasDescription.adoc new file mode 100644 index 000000000..4d7dff49b --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-aliasDescription.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 920119fed2624b659ff20db4f8b42082 +|别名 +|静默策略的别名。不同静默策略的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|静默策略的描述信息。描述可包含任意字符，最长 256 个字符。 diff --git a/content/zh/docs/_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceConditions.adoc b/content/zh/docs/_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceConditions.adoc new file mode 100644 index 000000000..7915b0157 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceConditions_new.adoc b/content/zh/docs/_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceConditions_new.adoc new file mode 100644 index 000000000..cec7cae59 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceTime.adoc b/content/zh/docs/_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceTime.adoc new file mode 100644 index 000000000..b9d5f335a --- /dev/null +++ b/content/zh/docs/_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceTime.adoc @@ -0,0 +1,16 @@ +// :ks_include_id: 4cae0895d3854461b646043abc44ff2b +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|持续静默 +|满足静默条件的通知在所有时间静默。 + +|在特定时间范围内静默 +|满足静默条件的通知在指定的时间范围内静默。您需要选择静默的开始时间和结束时间。 + +|周期性静默 +|满足静默条件的通知每日、每周或每月在指定的时间范围内静默。您需要选择静默的日期、开始时间和结束时间。 +|=== + +静默策略创建完成后将显示在静默策略列表中。 diff --git a/content/zh/docs/_custom/pluggable-component-management/edit-ks-installer.adoc b/content/zh/docs/_custom/pluggable-component-management/edit-ks-installer.adoc new file mode 100644 index 000000000..fb741723e --- /dev/null +++ b/content/zh/docs/_custom/pluggable-component-management/edit-ks-installer.adoc @@ -0,0 +1,11 @@ +// :ks_include_id: bdad0846da234ee885d8445a68831c7d + +. 您需要使用具有 **platform-admin** 角色的用户（例如 **admin** 用户）登录{ks_product_left} Web 控制台，在左上角点击**平台管理 > 集群管理**。 + +. 在左侧导航栏，点击**定制资源定义**。 + +. 在 **定制资源定义**页面的搜索框中，输入 **clusterconfiguration** 并按 **Enter** 进行搜索。 + +. 点击搜索结果中的 **ClusterConfiguration** 进入其详情页面。 + +. 在**资源状态**页签上，点击 **ks-installer** 右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**编辑 YAML**。 diff --git a/content/zh/docs/_custom/pluggable-component-management/view-component-installation-log.adoc b/content/zh/docs/_custom/pluggable-component-management/view-component-installation-log.adoc new file mode 100644 index 000000000..4751c15a9 --- /dev/null +++ b/content/zh/docs/_custom/pluggable-component-management/view-component-installation-log.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: 869f4ffb7dfb40ab91283be53050a5f3 + +. 启用组件后，您可以将鼠标悬停至 Web 控制台右下角的image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,20,25]，点击 **kubectl**，在弹出的对话框执行以下命令来查看组件安装过程。 ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + +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/zh/docs/_custom/projectManagement/apps/apps-basic-para.adoc b/content/zh/docs/_custom/projectManagement/apps/apps-basic-para.adoc new file mode 100644 index 000000000..64174b2f0 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/projectManagement/apps/apps-compose-description.adoc b/content/zh/docs/_custom/projectManagement/apps/apps-compose-description.adoc new file mode 100644 index 000000000..1049ac52c --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/apps/apps-compose-description.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 282a1d4ff17c46e19164103e677b6b0d + +您可以自定义应用的服务、工作负载和路由创建自制应用。相比基于模板的应用，自制应用支持应用治理，您可以为自制应用启用应用治理从而使用流量监控、灰度发布和链路追踪功能。 \ No newline at end of file diff --git a/content/zh/docs/_custom/projectManagement/apps/apps-oper-editAppInformation.adoc b/content/zh/docs/_custom/projectManagement/apps/apps-oper-editAppInformation.adoc new file mode 100644 index 000000000..1987a319f --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/apps/apps-oper-editAppInformation.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: 4d2fb1de6b844f18938f0c8b6f08e279 +. 在需要操作的应用右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置应用的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|应用的别名。不同应用的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|应用的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|=== +-- diff --git a/content/zh/docs/_custom/projectManagement/apps/apps-oper-installApp.adoc b/content/zh/docs/_custom/projectManagement/apps/apps-oper-installApp.adoc new file mode 100644 index 000000000..78f939643 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/apps/apps-oper-installApp.adoc @@ -0,0 +1,23 @@ +// :ks_include_id: 0a4b47588752413da3e9f8fdb60e06fa +. 在**基本信息**页签，设置应用的基本信息，然后点击**下一步**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|用户自定义的应用名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母开头并以小写字母或数字结尾，最长 32 个字符。 + +|版本 +|应用的版本。 + +|描述 +|应用的描述信息。描述可包含任意字符，最长 256 个字符。 + +|位置 +|应用所属的企业空间、集群和项目。 +|=== +-- + +. 在**应用设置**页签，根据需要设置应用的功能参数，然后点击**安装**。 \ No newline at end of file diff --git a/content/zh/docs/_custom/projectManagement/apps/apps-oper-openDetailsPage.adoc b/content/zh/docs/_custom/projectManagement/apps/apps-oper-openDetailsPage.adoc new file mode 100644 index 000000000..1145646fc --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/apps/apps-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c26d258b7e114b3e8e333660dfafc3a7 +. 在**应用**页面，点击**基于模板的应用**或**自制应用**打开应用列表，然后在列表中点击一个应用的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/projectManagement/apps/apps-oper-openListPage.adoc b/content/zh/docs/_custom/projectManagement/apps/apps-oper-openListPage.adoc new file mode 100644 index 000000000..84f27df60 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/apps/apps-oper-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 1573d8675ac344b49d00046f3bb0b822 +. 在**应用**页面，点击**基于模板的应用**或**自制应用**打开应用列表。 diff --git a/content/zh/docs/_custom/projectManagement/apps/apps-oper-viewResourceStatus.adoc b/content/zh/docs/_custom/projectManagement/apps/apps-oper-viewResourceStatus.adoc new file mode 100644 index 000000000..967e042d1 --- /dev/null +++ b/content/zh/docs/_custom/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_both}提供的流量监控、灰度发布和链路追踪功能。 + +|虚拟 IP 地址 +|服务供集群内部访问的虚拟 IP 地址。仅在服务的内部访问类型为 **VirtualIP** 时显示。 +|=== +-- + +* **工作负载**区域提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|工作负载的名称。 + +|类型 +|工作负载的类型。 + +|状态 +|工作负载当前的状态。 + +include::../../clusterManagement/workloads/workloads-para-workloadStatus.adoc[] + +|修改记录 +|工作负载的当前修改记录。 +|=== +-- \ 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 new file mode 100644 index 000000000..16e89ebd6 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/apps/apps-oper-viewResourceStatus_v4.adoc @@ -0,0 +1,61 @@ +// :ks_include_id: c4590bcc1e7e440b8eaf162491107dc0 +. 在应用详情页面左侧的**资源状态**页签查看组成应用的服务和工作负载。 + +* **服务**区域提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|服务的名称。 + +|项目 +|服务所属的项目。 + +|内部访问 +|服务供集群内部访问的虚拟 IP 地址。 + +|外部访问 +|服务供集群外部访问的端口号。 + +// |内部访问模式 +// | +// include::../../clusterManagement/services/services-para-internalAccess.adoc[] + +// include::../../clusterManagement/services/services-para-virtualip-headless.adoc[] + +// |应用治理 +// |应用是否已启用应用治理。应用治理启用后，您可以使用{ks_product_both}提供的流量监控、灰度发布和链路追踪功能。 + +// |虚拟 IP 地址 +// |服务供集群内部访问的虚拟 IP 地址。仅在服务的内部访问类型为 **VirtualIP** 时显示。 +|=== +-- + +* **工作负载**区域提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|工作负载的名称。 + +|项目 +|工作负载所属的项目。 + +// |类型 +// |工作负载的类型。 + +|状态 +|工作负载当前的状态。 + +include::../../clusterManagement/workloads/workloads-para-workloadStatus.adoc[] + +// |修改记录 +// |工作负载的当前修改记录。 +|=== +-- \ No newline at end of file diff --git a/content/zh/docs/_custom/projectManagement/apps/apps-para-details1.adoc b/content/zh/docs/_custom/projectManagement/apps/apps-para-details1.adoc new file mode 100644 index 000000000..1258b153d --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/apps/apps-para-details1.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 6d568952e6604999a005dfff5d21d3d3 +|集群 +|应用所属的集群。 + +|项目 +|应用所属的项目。 + +include::apps-para-status.adoc[] diff --git a/content/zh/docs/_custom/projectManagement/apps/apps-para-details2.adoc b/content/zh/docs/_custom/projectManagement/apps/apps-para-details2.adoc new file mode 100644 index 000000000..05ee99d59 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/apps/apps-para-details2.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: cc2613e81ffc4baa9d26ef37bbdc0e9f +|版本 +|应用的版本。 + +|创建时间 +|应用的创建时间。 + +|更新时间 +|应用的更新时间。 + +|创建者 +|创建应用的用户。 diff --git a/content/zh/docs/_custom/projectManagement/apps/apps-para-status.adoc b/content/zh/docs/_custom/projectManagement/apps/apps-para-status.adoc new file mode 100644 index 000000000..1b6a722c3 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/apps/apps-para-status.adoc @@ -0,0 +1,13 @@ +// :ks_include_id: 9db80030fef4430e98fae7a372d67f6d +|状态 +|应用当前的状态。 + +* **创建中**：系统正在创建应用。 + +* **运行中**：应用运行正常。 + +* **升级中**：系统正在升级应用版本。 + +* **删除中**：系统正在删除应用。 + +* **失败**：应用创建失败。 diff --git a/content/zh/docs/_custom/projectManagement/apps/apps-para-status_v4.adoc b/content/zh/docs/_custom/projectManagement/apps/apps-para-status_v4.adoc new file mode 100644 index 000000000..dc20af9b4 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/apps/apps-para-status_v4.adoc @@ -0,0 +1,15 @@ +// :ks_include_id: 9db80030fef4430e98fae7a372d67f6d +|状态 +|应用当前的状态。 + +* **创建中**：系统正在创建应用。 + +* **已创建**：应用已创建但还未运行。 + +* **运行中**：应用运行正常。 + +* **升级中**：系统正在升级应用版本。 + +* **删除中**：系统正在删除应用。 + +* **失败**：应用创建失败。 diff --git a/content/zh/docs/_custom/projectManagement/apps/apps-types.adoc b/content/zh/docs/_custom/projectManagement/apps/apps-types.adoc new file mode 100644 index 000000000..8fe4de09a --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/apps/apps-types.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: faff93159cca48358390bdd176c1577d + +在{ks_product_both}平台，应用特指由一个或多个工作负载、服务、应用路由等资源组成的业务程序。根据应用的创建方式，{ks_product_right}平台上的应用分为以下两类： + +* 基于模板的应用：通过已有的应用模板创建的应用。创建应用所使用的应用模板可以为上传到企业空间的应用模板、已发布到应用商店的应用模板或第三方应用仓库中的应用模板。 + +* 自制应用：由用户手动编排工作负载、服务、应用路由等资源创建的应用。在创建自制应用时，您可以启用应用治理以使用{ks_product_both}提供的流量监控、灰度发布和链接追踪功能。 \ No newline at end of file diff --git a/content/zh/docs/_custom/projectManagement/customScaling/customScaling-oper-openDetailsPage.adoc b/content/zh/docs/_custom/projectManagement/customScaling/customScaling-oper-openDetailsPage.adoc new file mode 100644 index 000000000..160435081 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/customScaling/customScaling-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 826ae67a40634df8a39c61d38bcdbbee +. 在**自定义伸缩**页面，点击目标自定义伸缩任务的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/projectManagement/customScaling/customScaling-prer-enableCustomScaling.adoc b/content/zh/docs/_custom/projectManagement/customScaling/customScaling-prer-enableCustomScaling.adoc new file mode 100644 index 000000000..d5e71796d --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/customScaling/customScaling-prer-enableCustomScaling.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c1083cc9ce1f4ea7bedb9fd1f1dd808e +* 您已经创建一个自定义伸缩任务。 diff --git a/content/zh/docs/_custom/projectManagement/grayscaleRelease/grayscaleRelease-oper-openDetailsPage.adoc b/content/zh/docs/_custom/projectManagement/grayscaleRelease/grayscaleRelease-oper-openDetailsPage.adoc new file mode 100644 index 000000000..f3f40097d --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/grayscaleRelease/grayscaleRelease-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c9236cd08c5e43f9a20e107705d04a48 +. 在**灰度发布**页面，点击**发布任务**，然后点击一个灰度发布任务的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/projectManagement/grayscaleRelease/grayscaleRelease-para-strategySettings.adoc b/content/zh/docs/_custom/projectManagement/grayscaleRelease/grayscaleRelease-para-strategySettings.adoc new file mode 100644 index 000000000..6141ee064 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/grayscaleRelease/grayscaleRelease-para-strategySettings.adoc @@ -0,0 +1,24 @@ +// :ks_include_id: 24a43a70d2cc491b86afd4bda8e41b78 +* 对于**蓝绿部署**，在新版本或旧版本右侧点击**接管**可将业务流量全部转发给该版本。 + +* 对于**金丝雀发布**任务，您可以选择指定新旧版本的流量分配比例，或根据请求参数将请求转发给新版本或旧版本。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|指定流量分配 +|拖动滑块可设置新旧版本接收业务流量的百分比。 + +|指定请求参数 +|将参数满足特定条件的请求转发给新版本，其他请求转发给旧版本。 +|=== +-- + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +流量镜像任务将业务流量的副本发送给新版本进行测试，而不实际暴露新版本，所以不需要设置业务流量转发策略。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/_custom/projectManagement/grayscaleRelease/grayscaleRelease-para-trafficSuccessLatency.adoc b/content/zh/docs/_custom/projectManagement/grayscaleRelease/grayscaleRelease-para-trafficSuccessLatency.adoc new file mode 100644 index 000000000..c51f818f3 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/grayscaleRelease/grayscaleRelease-para-trafficSuccessLatency.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: c831ace6bfe442abba34ed44c8c2ec4b +|流量 +|新旧版本的每秒请求数量。 + +|请求成功率 +|新旧版本的成功请求百分比。 + +|请求延迟 +|新旧版本的平均请求延迟。 diff --git a/content/zh/docs/_custom/projectManagement/grayscaleRelease/grayscaleRelease-prer-enableApplicationGovernance.adoc b/content/zh/docs/_custom/projectManagement/grayscaleRelease/grayscaleRelease-prer-enableApplicationGovernance.adoc new file mode 100644 index 000000000..3598ce0a7 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/grayscaleRelease/grayscaleRelease-prer-enableApplicationGovernance.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: d21b709ba38e40b78399826de4588ecd +ifeval::["{file_output_type}" == "html"] + +* {ks_product_right}平台需要启用应用治理扩展组件。 + +endif::[] + +ifeval::["{file_output_type}" == "pdf"] + +* {ks_product_right}平台需要启用应用治理扩展组件。有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。 + +endif::[] diff --git a/content/zh/docs/_custom/projectManagement/imageBuilders/imageBuilders-desc-creationComplete.adoc b/content/zh/docs/_custom/projectManagement/imageBuilders/imageBuilders-desc-creationComplete.adoc new file mode 100644 index 000000000..37c102ba6 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/imageBuilders/imageBuilders-desc-creationComplete.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 1ea59c0e60ef40fbb5f7a7341c382f1e +镜像构建器创建完成后将显示在镜像构建器列表中。 diff --git a/content/zh/docs/_custom/projectManagement/imageBuilders/imageBuilders-desc-imageBuilderCreated.adoc b/content/zh/docs/_custom/projectManagement/imageBuilders/imageBuilders-desc-imageBuilderCreated.adoc new file mode 100644 index 000000000..d55ba19c0 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/imageBuilders/imageBuilders-desc-imageBuilderCreated.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: f52c5a33e96e4c138d01b50b78731090 +镜像构建器开始运行后将自动进行以下操作： diff --git a/content/zh/docs/_custom/projectManagement/imageBuilders/imageBuilders-oper-openDetailsPage.adoc b/content/zh/docs/_custom/projectManagement/imageBuilders/imageBuilders-oper-openDetailsPage.adoc new file mode 100644 index 000000000..650e6e76d --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/imageBuilders/imageBuilders-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d93217c5c87e49bfa268c2f02486f7c3 +. 在镜像构建器列表中点击一个镜像构建器的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/projectManagement/imageBuilders/imageBuilders-para-creationTime.adoc b/content/zh/docs/_custom/projectManagement/imageBuilders/imageBuilders-para-creationTime.adoc new file mode 100644 index 000000000..785d30bb5 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/imageBuilders/imageBuilders-para-creationTime.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: dc27d543d85f4d5bbcba78203ed681d4 +|创建时间 +|镜像构建器的创建时间。 diff --git a/content/zh/docs/_custom/projectManagement/imageBuilders/imageBuilders-para-imageName.adoc b/content/zh/docs/_custom/projectManagement/imageBuilders/imageBuilders-para-imageName.adoc new file mode 100644 index 000000000..13d2074c4 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/imageBuilders/imageBuilders-para-imageName.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 4f350e60e809473fba0431f9d5c73f71 +|名称 +|镜像构建器的名称。由系统自动生成，格式为 <镜像命名空间>**-**<镜像名称>**-**<镜像标签>**-**<随机码>。 diff --git a/content/zh/docs/_custom/projectManagement/imageBuilders/imageBuilders-para-type.adoc b/content/zh/docs/_custom/projectManagement/imageBuilders/imageBuilders-para-type.adoc new file mode 100644 index 000000000..883277a1b --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/imageBuilders/imageBuilders-para-type.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: fd79f6c4d3e744308f805372d06ec344 +|类型 +|镜像构建器的类型。 + +* **源码构建镜像**：使用源代码构建镜像。 + +* **制品构建镜像**：使用制品构建镜像。 diff --git a/content/zh/docs/_custom/projectManagement/microserviceConfiguration/microserviceConfiguration-oper-openDetailsPage.adoc b/content/zh/docs/_custom/projectManagement/microserviceConfiguration/microserviceConfiguration-oper-openDetailsPage.adoc new file mode 100644 index 000000000..95a9ce6b2 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/microserviceConfiguration/microserviceConfiguration-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 352d6d8a19f04dbeb3551dbec55871b0 +. 在微服务配置列表中，点击一个微服务配置的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc b/content/zh/docs/_custom/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc new file mode 100644 index 000000000..d4bd13671 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/projectManagement/microservices/microservices-oper-openInstanceList.adoc b/content/zh/docs/_custom/projectManagement/microservices/microservices-oper-openInstanceList.adoc new file mode 100644 index 000000000..cd9fe0f44 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/projectManagement/microservices/microservices-para-instances.adoc b/content/zh/docs/_custom/projectManagement/microservices/microservices-para-instances.adoc new file mode 100644 index 000000000..f72f1b7c3 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/microservices/microservices-para-instances.adoc @@ -0,0 +1,20 @@ +// :ks_include_id: 63f2cf5af75e41deb6a5d5c45da3d5b3 +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|微服务实例的名称。 + +|权重 +|微服务实例在微服务中的权重。发送给微服务的流量将根据微服务实例的权重分配给微服务实例。 + +|IP 地址 +|微服务实例的在{ks_product_both}集群内部的访问地址。 + +|端口 +|微服务实例的访问端口号。 + +|创建时间 +|微服务实例的创建时间。 +|=== diff --git a/content/zh/docs/_custom/projectManagement/microservices/microservices-prer-enableSpringCloud.adoc b/content/zh/docs/_custom/projectManagement/microservices/microservices-prer-enableSpringCloud.adoc new file mode 100644 index 000000000..ec1473af8 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/microservices/microservices-prer-enableSpringCloud.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: 386a46cc0a3947d2976ae884512759d6 +ifeval::["{file_output_type}" == "html"] +* {ks_product_right}平台需要启用 Spring Cloud 扩展组件。 +endif::[] +ifeval::["{file_output_type}" == "pdf"] +* {ks_product_right}平台需要启用 Spring Cloud 扩展组件。有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。 +endif::[] \ No newline at end of file diff --git a/content/zh/docs/_custom/projectManagement/projectManagement-oper-openProjectPage.adoc b/content/zh/docs/_custom/projectManagement/projectManagement-oper-openProjectPage.adoc new file mode 100644 index 000000000..09c68c849 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/projectManagement-oper-openProjectPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9b4eef92c7d44ab79e49b128781dbfde +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的项目。 diff --git a/content/zh/docs/_custom/projectManagement/projectManagement-prer-requiredPermission.adoc b/content/zh/docs/_custom/projectManagement/projectManagement-prer-requiredPermission.adoc new file mode 100644 index 000000000..3b5e83958 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc b/content/zh/docs/_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc new file mode 100644 index 000000000..dd65109e0 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 6579f3ef4c70439ca10c8e8de94ce9fb +您需要加入一个项目并在项目中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:09-project-management/06-project-settings/03-project-members/_index.adoc[项目成员]和xref:09-project-management/06-project-settings/02-project-roles/_index.adoc[项目角色]。 diff --git a/content/zh/docs/_custom/projectManagement/projectRoles/projectRoles-desc-initialProjectAdmin.adoc b/content/zh/docs/_custom/projectManagement/projectRoles/projectRoles-desc-initialProjectAdmin.adoc new file mode 100644 index 000000000..dc4776473 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/projectRoles/projectRoles-desc-initialProjectAdmin.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c5751818dcc6470db19af8b18c1f1069 +项目的创建者自动成为项目管理员。此外，{ks_product_right}平台的 **admin** 用户默认在所有项目中具有所有权限。在企业空间初始状态下，可由以上用户邀请其他用户加入项目并设置用户在项目中的角色。 diff --git a/content/zh/docs/_custom/projectManagement/projectRoles/projectRoles-para-aliasAndDescription.adoc b/content/zh/docs/_custom/projectManagement/projectRoles/projectRoles-para-aliasAndDescription.adoc new file mode 100644 index 000000000..1acb41935 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/projectRoles/projectRoles-para-aliasAndDescription.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 306f31ec34bf463a85cce5be5d58905e +|别名 +|项目角色的别名。不同项目角色的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|项目角色的描述信息。描述可包含任意字符，最长 256 个字符。 diff --git a/content/zh/docs/_custom/projectManagement/projectRoles/projectRoles-para-permissions.adoc b/content/zh/docs/_custom/projectManagement/projectRoles/projectRoles-para-permissions.adoc new file mode 100644 index 000000000..62bfe09cd --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/projectManagement/projectRoles/projectRoles-para-permissions_new.adoc b/content/zh/docs/_custom/projectManagement/projectRoles/projectRoles-para-permissions_new.adoc new file mode 100644 index 000000000..c9aca66a5 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/projectManagement/projectRoles/projectRoles-para-permissions_v4.adoc b/content/zh/docs/_custom/projectManagement/projectRoles/projectRoles-para-permissions_v4.adoc new file mode 100644 index 000000000..4827eb42c --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/projectRoles/projectRoles-para-permissions_v4.adoc @@ -0,0 +1,160 @@ +// :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"] +// |=== +// |权限 |允许操作 + +// |自定义监控查看 +// |查看自定义监控面板。 + +// |自定义监控管理 +// |创建自定义监控面板、编辑自定义监控面板信息、编辑自定义监控面板、删除自定义监控面板。 + +// |规则组查看 +// |查看规则组列表、查看规则组详情。 + +// |规则组管理 +// |创建规则组、编辑规则组、删除规则组。 + +// |告警查看 +// |查看告警列表。 +// |=== +// -- + + +// * 项目设置 +// + +// -- +// [%header,cols="1a,4a"] +// |=== +// |权限 |允许操作 + +// |项目设置管理 +// |查看项目概览信息、编辑项目信息、编辑项目配额、编辑默认容器配额、删除项目。 +// |=== +// -- diff --git a/content/zh/docs/_custom/projectManagement/projectRoles/projectRoles-para-presetRoles.adoc b/content/zh/docs/_custom/projectManagement/projectRoles/projectRoles-para-presetRoles.adoc new file mode 100644 index 000000000..6c66012f1 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/projectRoles/projectRoles-para-presetRoles.adoc @@ -0,0 +1,16 @@ +// :ks_include_id: 2b56feb1f8cc44b5b2eda05290fc26e5 +{ks_product_right}提供以下预置项目角色： + +[%header,cols="1a,4a"] +|=== +|角色 |描述 + +|admin +|项目管理员，在项目中具有所有权限。 + +|operator +|项目操作员，在项目中具有除项目设置管理、角色管理、成员管理以外的权限。 + +|viewer +|项目观察员，在项目中具有资源查看权限。 +|=== diff --git a/content/zh/docs/_custom/projectManagement/services/services-desc-autoCreateWorkload.adoc b/content/zh/docs/_custom/projectManagement/services/services-desc-autoCreateWorkload.adoc new file mode 100644 index 000000000..692f2ace1 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/services/services-desc-autoCreateWorkload.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 090f3fcc283e40d2a5b07f8dcb4ac645 +为创建工作负载，{ks_product_both}将创建镜像构建器，并自动执行以下步骤： diff --git a/content/zh/docs/_custom/projectManagement/services/services-desc-seeImageBuilder.adoc b/content/zh/docs/_custom/projectManagement/services/services-desc-seeImageBuilder.adoc new file mode 100644 index 000000000..1a15211a9 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/projectManagement/services/services-desc-setLabelsAnnotations.adoc b/content/zh/docs/_custom/projectManagement/services/services-desc-setLabelsAnnotations.adoc new file mode 100644 index 000000000..e5911abb1 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/services/services-desc-setLabelsAnnotations.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 0dc49673473f4b0faae45bafaaf6990c +为服务后端工作负载管理的容器组指定 IP 池和节点，设置服务的外部访问模式、会话保持设置和元数据。 diff --git a/content/zh/docs/_custom/projectManagement/services/services-desc-setServiceLabelWorkloadAnnotation.adoc b/content/zh/docs/_custom/projectManagement/services/services-desc-setServiceLabelWorkloadAnnotation.adoc new file mode 100644 index 000000000..9963c7074 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/services/services-desc-setServiceLabelWorkloadAnnotation.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: b48f001ab35b4c5d86dfeb6455441fd5 +设置服务的标签和工作负载的注解。 diff --git a/content/zh/docs/_custom/projectManagement/services/services-oper-buildImageUsingArtifact.adoc b/content/zh/docs/_custom/projectManagement/services/services-oper-buildImageUsingArtifact.adoc new file mode 100644 index 000000000..235ae22cd --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/services/services-oper-buildImageUsingArtifact.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: bc3932ca9b3f46c8b0b79e131d2e14d9 +. 使用镜像构建器将用户上传的制品文件构建为容器镜像。 diff --git a/content/zh/docs/_custom/projectManagement/services/services-oper-createWorkloadUsingImage.adoc b/content/zh/docs/_custom/projectManagement/services/services-oper-createWorkloadUsingImage.adoc new file mode 100644 index 000000000..c5c99f999 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/services/services-oper-createWorkloadUsingImage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 7a0a9a69b8634926bdef057bd7c149b6 +. 在{ks_product_both}平台拉取镜像并创建有状态副本集或部署。 diff --git a/content/zh/docs/_custom/projectManagement/services/services-oper-pullSourceCodeAndBuildImage.adoc b/content/zh/docs/_custom/projectManagement/services/services-oper-pullSourceCodeAndBuildImage.adoc new file mode 100644 index 000000000..9863b6735 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/services/services-oper-pullSourceCodeAndBuildImage.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 163ce46573404b5db1ad521a92036c9d +. 连接用户指定的源代码仓库并获取应用程序的源代码。 + +. 使用镜像构建器将源代码构建为容器镜像。 diff --git a/content/zh/docs/_custom/projectManagement/services/services-oper-pushPullImage.adoc b/content/zh/docs/_custom/projectManagement/services/services-oper-pushPullImage.adoc new file mode 100644 index 000000000..84bfcc026 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/services/services-oper-pushPullImage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 47accd090e41451b86db2d5ab8618141 +. 将容器镜像推送到用户指定的镜像服务。 diff --git a/content/zh/docs/_custom/projectManagement/services/services-oper-setBasicInformation.adoc b/content/zh/docs/_custom/projectManagement/services/services-oper-setBasicInformation.adoc new file mode 100644 index 000000000..ff4ca92aa --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/services/services-oper-setBasicInformation.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: b5f9785a467642188bf3156e649b5046 +. 在**基本信息**页签，设置服务的基本信息，然后点击**下一步**。 diff --git a/content/zh/docs/_custom/projectManagement/services/services-oper-setStorageAdvanced.adoc b/content/zh/docs/_custom/projectManagement/services/services-oper-setStorageAdvanced.adoc new file mode 100644 index 000000000..ddb1973b0 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/services/services-oper-setStorageAdvanced.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 046dfe4aa0334cd393ccf4c776cd19f2 +. 在**存储设置**页签，为服务后端工作负载管理的容器挂载卷，然后点击**下一步**。 + +. 在**高级设置**页签，为服务后端工作负载管理的容器组指定 IP 池和节点，设置服务的外部访问模式、会话保持设置和元数据，然后点击**创建**。服务创建完成后将显示在服务列表中。 diff --git a/content/zh/docs/_custom/projectManagement/services/services-para-app.adoc b/content/zh/docs/_custom/projectManagement/services/services-para-app.adoc new file mode 100644 index 000000000..099c91f97 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/services/services-para-app.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 2df70ed494ae4c76b008a5d347901192 +|应用 +|服务所属的应用。如果服务不属于任何应用，此处将显示服务的名称。 diff --git a/content/zh/docs/_custom/projectManagement/services/services-para-artifactFile.adoc b/content/zh/docs/_custom/projectManagement/services/services-para-artifactFile.adoc new file mode 100644 index 000000000..8f3a7d2d8 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/services/services-para-artifactFile.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: f411b3f211414f0aa7b55ad69983de5a +|制品文件 +|从本地上传用于构建镜像的制品文件。 diff --git a/content/zh/docs/_custom/projectManagement/services/services-para-buildEnvironmentArtifact.adoc b/content/zh/docs/_custom/projectManagement/services/services-para-buildEnvironmentArtifact.adoc new file mode 100644 index 000000000..ad3201031 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/services/services-para-buildEnvironmentArtifact.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: bb82028898a7426f82840b8d9939f2ba +|构建环境 +|容器镜像的构建环境。请根据制品文件的格式和版本选择构建环境。 diff --git a/content/zh/docs/_custom/projectManagement/services/services-para-buildEnvironmentSourceCode.adoc b/content/zh/docs/_custom/projectManagement/services/services-para-buildEnvironmentSourceCode.adoc new file mode 100644 index 000000000..82c72e7c6 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/services/services-para-buildEnvironmentSourceCode.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 9fd6858a23104720ad86b9b4d8e1c4b4 +|构建环境 +|容器镜像的构建环境。请根据源代码的语言和版本选择构建环境。 diff --git a/content/zh/docs/_custom/projectManagement/services/services-para-buildSettings.adoc b/content/zh/docs/_custom/projectManagement/services/services-para-buildSettings.adoc new file mode 100644 index 000000000..d94fe6a3e --- /dev/null +++ b/content/zh/docs/_custom/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_both}镜像构建时所使用的认证令牌。如果已设置的令牌，请求需要提供正确令牌才能触发镜像构建。令牌只能包含大写字母、小写字母和数字。 + +服务创建完成后，{ks_product_right}将创建镜像构建器并提供 URL 可用于第三方应用程序触发镜像构建。您在可以镜像构建器的详情页面获取 URL。有关更多信息，请参阅xref:07-project-management/08-image-builder/03-view-image-builder-details.adoc[查看镜像构建器详情]。 diff --git a/content/zh/docs/_custom/projectManagement/services/services-para-codeRelativePath.adoc b/content/zh/docs/_custom/projectManagement/services/services-para-codeRelativePath.adoc new file mode 100644 index 000000000..516c946a3 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/services/services-para-codeRelativePath.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 2ccc6559660848e48415b8d10030c5d5 +|代码相对路径 +|源代码在代码仓库中的路径。 diff --git a/content/zh/docs/_custom/projectManagement/services/services-para-codeRepositoryURL.adoc b/content/zh/docs/_custom/projectManagement/services/services-para-codeRepositoryURL.adoc new file mode 100644 index 000000000..e062f9723 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/services/services-para-codeRepositoryURL.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: f8c32dc78a164b579934671dbbc85d6e +|代码仓库 URL +|源代码仓库的地址。目前仅支持 Git 仓库。 diff --git a/content/zh/docs/_custom/projectManagement/services/services-para-environmentVariablesArtifact.adoc b/content/zh/docs/_custom/projectManagement/services/services-para-environmentVariablesArtifact.adoc new file mode 100644 index 000000000..c70cb5c00 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/projectManagement/services/services-para-environmentVariablesSourceCode.adoc b/content/zh/docs/_custom/projectManagement/services/services-para-environmentVariablesSourceCode.adoc new file mode 100644 index 000000000..0ca62f245 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/projectManagement/services/services-para-serviceVersion.adoc b/content/zh/docs/_custom/projectManagement/services/services-para-serviceVersion.adoc new file mode 100644 index 000000000..206c40f5b --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/services/services-para-serviceVersion.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: bc156fd69a5d47f7a81e90f30cbf8f4a +|版本 +|服务的版本号。版本只能包含小写字母和数字，最长 16 个字符。 diff --git a/content/zh/docs/_custom/projectManagement/services/services-para-setServiceInformation.adoc b/content/zh/docs/_custom/projectManagement/services/services-para-setServiceInformation.adoc new file mode 100644 index 000000000..c1d7bc2e0 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/services/services-para-setServiceInformation.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 5ca206c1516d4f62ae7cf5eba8662626 +设置服务的基本信息。 diff --git a/content/zh/docs/_custom/projectManagement/services/services-prer-artifact.adoc b/content/zh/docs/_custom/projectManagement/services/services-prer-artifact.adoc new file mode 100644 index 000000000..91e5a52af --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/services/services-prer-artifact.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 3d4b6be852084351b5a3379d1242953f +* 您需要提前准备用于构建镜像的制品文件。{ks_product_right}默认支持 JAR、WAR 和二进制格式的制品文件。 diff --git a/content/zh/docs/_custom/projectManagement/services/services-prer-imageRegistry.adoc b/content/zh/docs/_custom/projectManagement/services/services-prer-imageRegistry.adoc new file mode 100644 index 000000000..bcd0d16bc --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/projectManagement/services/services-prer-sourceCodeRepository.adoc b/content/zh/docs/_custom/projectManagement/services/services-prer-sourceCodeRepository.adoc new file mode 100644 index 000000000..e45e3e7c1 --- /dev/null +++ b/content/zh/docs/_custom/projectManagement/services/services-prer-sourceCodeRepository.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 87f2d9d930e741ff8798083db03186e3 +* 您需要具有可用的代码仓库。{ks_product_right}默认支持 Git 仓库和 Java、Node.js 和 Python 源代码。 + +* 如果您使用私有代码仓库，您需要提前在项目中创建保存代码仓库密钥的保密字典。有关更多信息，请参阅xref:07-project-management/05-configuration/01-secrets/01-create-a-secret.adoc[创建保密字典]。 diff --git a/content/zh/docs/_custom/projectManagement/workloads/workloads-desc-enableLogCollectionMulticlusterProject.adoc b/content/zh/docs/_custom/projectManagement/workloads/workloads-desc-enableLogCollectionMulticlusterProject.adoc new file mode 100644 index 000000000..1700f6f03 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/projectManagement/workloads/workloads-desc-enableLogCollectionProject.adoc b/content/zh/docs/_custom/projectManagement/workloads/workloads-desc-enableLogCollectionProject.adoc new file mode 100644 index 000000000..494566743 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/radondb/radondb-desc-dbProductIntro.adoc b/content/zh/docs/_custom/radondb/radondb-desc-dbProductIntro.adoc new file mode 100644 index 000000000..e31e84936 --- /dev/null +++ b/content/zh/docs/_custom/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_both}应用商店。您可以在{ks_product_left} Web 控制台安装 RadonDB {ks_db_product} 应用，从而以容器化的方式部署 {ks_db_product} 数据库并通过图形界面对 {ks_db_product} 数据库进行管理。 diff --git a/content/zh/docs/_custom/radondb/radondb-install-app.adoc b/content/zh/docs/_custom/radondb/radondb-install-app.adoc new file mode 100644 index 000000000..8a560683c --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondb-install-app.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 6bde291a074f470ea74bb887f7ec61f2 + +. 在**应用信息**页面，点击**安装**。 \ No newline at end of file diff --git a/content/zh/docs/_custom/radondb/radondb-oper-clickRadondbAppsTab.adoc b/content/zh/docs/_custom/radondb/radondb-oper-clickRadondbAppsTab.adoc new file mode 100644 index 000000000..63f384d46 --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondb-oper-clickRadondbAppsTab.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: a58c1ab91f824dfea967e391137ca1dc +. 在**应用**页面点击 **RadonDB 应用**页签。 diff --git a/content/zh/docs/_custom/radondb/radondb-oper-openDatabaseUserList.adoc b/content/zh/docs/_custom/radondb/radondb-oper-openDatabaseUserList.adoc new file mode 100644 index 000000000..94e50d794 --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondb-oper-openDatabaseUserList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: c93a1471e07842fea7f1f71070066e61 +. 在页面右侧点击**数据库用户**页签打开数据库用户列表。 diff --git a/content/zh/docs/_custom/radondb/radondb-oper-openRuleGroupDetailsPage.adoc b/content/zh/docs/_custom/radondb/radondb-oper-openRuleGroupDetailsPage.adoc new file mode 100644 index 000000000..e499921f6 --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondb-oper-openRuleGroupDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: b20ded10071a437cb7deb49f31c8ef21 +. 在规则组列表中点击一个规则组的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/radondb/radondb-oper-openRuleGroupList.adoc b/content/zh/docs/_custom/radondb/radondb-oper-openRuleGroupList.adoc new file mode 100644 index 000000000..55acd84fa --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondb-oper-openRuleGroupList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 32accc489de14734a39cb120fccac552 +. 在页面右侧点击**告警规则组**页签打开规则组列表。 diff --git a/content/zh/docs/_custom/radondb/radondb-prer-alerRuleGroupPermissionsManage.adoc b/content/zh/docs/_custom/radondb/radondb-prer-alerRuleGroupPermissionsManage.adoc new file mode 100644 index 000000000..5c7badf56 --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondb-prer-alerRuleGroupPermissionsManage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 4d279d14badb4232b6542a5da39926b1 +* 您需要在{ks_product_left} Web 控制台加入一个项目，并在项目中具有**应用负载管理**和**规则组管理**权限。 diff --git a/content/zh/docs/_custom/radondb/radondb-prer-alerRuleGroupPermissionsView.adoc b/content/zh/docs/_custom/radondb/radondb-prer-alerRuleGroupPermissionsView.adoc new file mode 100644 index 000000000..dfa9c884a --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondb-prer-alerRuleGroupPermissionsView.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 514e3f0143bd4c10842526fa9d3ecbcc +* 您需要在{ks_product_left} Web 控制台加入一个项目，并在项目中具有**应用负载查看**和**规则组查看**权限。 diff --git a/content/zh/docs/_custom/radondb/radondb-prer-enableDmp.adoc b/content/zh/docs/_custom/radondb/radondb-prer-enableDmp.adoc new file mode 100644 index 000000000..68e84954b --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondb-prer-enableDmp.adoc @@ -0,0 +1,7 @@ +// :ks_include_id: fbdee05fed2d4021839cb2ec9bf19339 +ifeval::["{file_output_type}" == "html"] +* {ks_product_right}平台需要启用数据库管理平台扩展组件。 +endif::[] +ifeval::["{file_output_type}" == "pdf"] +* {ks_product_right}平台需要启用数据库管理平台扩展组件。有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。 +endif::[] diff --git a/content/zh/docs/_custom/radondb/radondb-prer-requiredPermission.adoc b/content/zh/docs/_custom/radondb/radondb-prer-requiredPermission.adoc new file mode 100644 index 000000000..455da31e7 --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondb-prer-requiredPermission.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: f369e4a204164378b95018c1b0b2483e +* 您需要在{ks_product_left} Web 控制台加入一个项目，并在项目中具有pass:a,q[{ks_permission}]权限。 diff --git a/content/zh/docs/_custom/radondb/radondbClickhouse/radondbClickhouse-oper-openDetailsPage.adoc b/content/zh/docs/_custom/radondb/radondbClickhouse/radondbClickhouse-oper-openDetailsPage.adoc new file mode 100644 index 000000000..aa8fb46e6 --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbClickhouse/radondbClickhouse-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: dff6e184455b4b33ae79210aba481932 +. 在 RadonDB 应用列表中，点击 RadonDB ClickHouse 应用的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/radondb/radondbClickhouse/radondbClickhouse-para-usernamePassword.adoc b/content/zh/docs/_custom/radondb/radondbClickhouse/radondbClickhouse-para-usernamePassword.adoc new file mode 100644 index 000000000..14b3f5443 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/radondb/radondbClickhouse/radondbClickhouse-prer-databaseStatusRunning.adoc b/content/zh/docs/_custom/radondb/radondbClickhouse/radondbClickhouse-prer-databaseStatusRunning.adoc new file mode 100644 index 000000000..b923eaeca --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbClickhouse/radondbClickhouse-prer-databaseStatusRunning.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 69f5611b6e834378a32660759919920f +* RadonDB ClickHouse 状态为**运行中**。 diff --git a/content/zh/docs/_custom/radondb/radondbClickhouse/radondbClickhouse-prer-installRadondbClickHouse.adoc b/content/zh/docs/_custom/radondb/radondbClickhouse/radondbClickhouse-prer-installRadondbClickHouse.adoc new file mode 100644 index 000000000..4a6f4570c --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/radondb/radondbEck/radondbEck-prer-installRadondbEck.adoc b/content/zh/docs/_custom/radondb/radondbEck/radondbEck-prer-installRadondbEck.adoc new file mode 100644 index 000000000..b7eeeddc1 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/radondb/radondbEck/radondbeck-oper-openDetailsPage.adoc b/content/zh/docs/_custom/radondb/radondbEck/radondbeck-oper-openDetailsPage.adoc new file mode 100644 index 000000000..b3b03c231 --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbEck/radondbeck-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 15b3fc1df70646a9aa9dfe5ba02f8edb +. 在 RadonDB 应用列表中，点击 RadonDB ECK 应用的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/radondb/radondbEck/radondbeck-prer-createAlertGroup.adoc b/content/zh/docs/_custom/radondb/radondbEck/radondbeck-prer-createAlertGroup.adoc new file mode 100644 index 000000000..27198ca27 --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbEck/radondbeck-prer-createAlertGroup.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 19e21c1cd5ea4ba28bc287ebd9116ff1 +* 您已经创建了告警规则组。 diff --git a/content/zh/docs/_custom/radondb/radondbEck/radondbeck-prer-databaseStatusRunning.adoc b/content/zh/docs/_custom/radondb/radondbEck/radondbeck-prer-databaseStatusRunning.adoc new file mode 100644 index 000000000..7382f174c --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbEck/radondbeck-prer-databaseStatusRunning.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 5d06dd730e0e4a5291c9371a777d68d3 +* RadonDB ECK 状态为**运行中**。 diff --git a/content/zh/docs/_custom/radondb/radondbKafka/radondbkafka-oper-openDatabaseUserList.adoc b/content/zh/docs/_custom/radondb/radondbKafka/radondbkafka-oper-openDatabaseUserList.adoc new file mode 100644 index 000000000..58b2c50fb --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/radondb/radondbKafka/radondbkafka-oper-openDetailsPage.adoc b/content/zh/docs/_custom/radondb/radondbKafka/radondbkafka-oper-openDetailsPage.adoc new file mode 100644 index 000000000..3883a6eee --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbKafka/radondbkafka-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 17b3b61a099b460fbea8886a5f6d43ca +. 在 RadonDB 应用列表中，点击 RadonDB Kafka 应用的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/radondb/radondbKafka/radondbkafka-prer-databaseStatusRunning.adoc b/content/zh/docs/_custom/radondb/radondbKafka/radondbkafka-prer-databaseStatusRunning.adoc new file mode 100644 index 000000000..718b30f70 --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbKafka/radondbkafka-prer-databaseStatusRunning.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: f8360981ea784a128e8db037604d4687 +* RadonDB Kafka 状态为**运行中**。 diff --git a/content/zh/docs/_custom/radondb/radondbKafka/radondbkafka-prer-installRadondbkafka.adoc b/content/zh/docs/_custom/radondb/radondbKafka/radondbkafka-prer-installRadondbkafka.adoc new file mode 100644 index 000000000..8d73e3c71 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/radondb/radondbMongoDB/radondbmongodb-oper-openDetailsPage.adoc b/content/zh/docs/_custom/radondb/radondbMongoDB/radondbmongodb-oper-openDetailsPage.adoc new file mode 100644 index 000000000..1aa33d2be --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbMongoDB/radondbmongodb-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 17f87955f1e74216a03d3e1442183171 +. 在 RadonDB 应用列表中，点击 RadonDB MongoDB 应用的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/radondb/radondbMongoDB/radondbmongodb-prer-createAlertGroup.adoc b/content/zh/docs/_custom/radondb/radondbMongoDB/radondbmongodb-prer-createAlertGroup.adoc new file mode 100644 index 000000000..382e5c7fd --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbMongoDB/radondbmongodb-prer-createAlertGroup.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 2dc1d3aaa26e4abd847b2ae0e8c34dde +* 您已经创建了告警规则组。 diff --git a/content/zh/docs/_custom/radondb/radondbMongoDB/radondbmongodb-prer-databaseStatusRunning.adoc b/content/zh/docs/_custom/radondb/radondbMongoDB/radondbmongodb-prer-databaseStatusRunning.adoc new file mode 100644 index 000000000..6dbb2caf1 --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbMongoDB/radondbmongodb-prer-databaseStatusRunning.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 8713a085b4b24c45b87ef1f69629d943 +* RadonDB MongoDB 状态为**运行中**。 diff --git a/content/zh/docs/_custom/radondb/radondbMongoDB/radondbmongodb-prer-installRadondbmongodb.adoc b/content/zh/docs/_custom/radondb/radondbMongoDB/radondbmongodb-prer-installRadondbmongodb.adoc new file mode 100644 index 000000000..2f333bb76 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/radondb/radondbMySql/radondbmysql-oper-openDetailsPage.adoc b/content/zh/docs/_custom/radondb/radondbMySql/radondbmysql-oper-openDetailsPage.adoc new file mode 100644 index 000000000..e8babf535 --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbMySql/radondbmysql-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 87a744239cbf45f6ab07421f14732d53 +. 在 RadonDB 应用列表中，点击 RadonDB MySQL 应用的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/radondb/radondbMySql/radondbmysql-para-usernamePassword.adoc b/content/zh/docs/_custom/radondb/radondbMySql/radondbmysql-para-usernamePassword.adoc new file mode 100644 index 000000000..3052fb989 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/radondb/radondbMySql/radondbmysql-prer-createAlertGroup.adoc b/content/zh/docs/_custom/radondb/radondbMySql/radondbmysql-prer-createAlertGroup.adoc new file mode 100644 index 000000000..813a2d175 --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbMySql/radondbmysql-prer-createAlertGroup.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: db623d4f1c0d415d97e137b978c3e158 +* 您已经创建了告警规则组。 diff --git a/content/zh/docs/_custom/radondb/radondbMySql/radondbmysql-prer-databaseStatusRunning.adoc b/content/zh/docs/_custom/radondb/radondbMySql/radondbmysql-prer-databaseStatusRunning.adoc new file mode 100644 index 000000000..6ffc728cb --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbMySql/radondbmysql-prer-databaseStatusRunning.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 72954448032c40cc8f0d906fc41cfbec +* RadonDB MySQL 状态为**运行中**。 diff --git a/content/zh/docs/_custom/radondb/radondbMySql/radondbmysql-prer-installRadondbmysql.adoc b/content/zh/docs/_custom/radondb/radondbMySql/radondbmysql-prer-installRadondbmysql.adoc new file mode 100644 index 000000000..e5c91c9e1 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/radondb/radondbOpenSearch/radondbopensearch-oper-openDatabaseUserList.adoc b/content/zh/docs/_custom/radondb/radondbOpenSearch/radondbopensearch-oper-openDatabaseUserList.adoc new file mode 100644 index 000000000..ac22d4e34 --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbOpenSearch/radondbopensearch-oper-openDatabaseUserList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 7875a37b9e2b43b8b107b03bed4aa8f5 +. 在页面右侧点击 **OpenSearch 用户**页签打开数据库用户列表。 diff --git a/content/zh/docs/_custom/radondb/radondbOpenSearch/radondbopensearch-oper-openDetailsPage.adoc b/content/zh/docs/_custom/radondb/radondbOpenSearch/radondbopensearch-oper-openDetailsPage.adoc new file mode 100644 index 000000000..bc22df289 --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbOpenSearch/radondbopensearch-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 97bdd6d29117459f9e286142fe67d522 +. 在 RadonDB 应用列表中，点击 RadonDB OpenSearch 应用的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/radondb/radondbOpenSearch/radondbopensearch-prer-databaseStatusRunning.adoc b/content/zh/docs/_custom/radondb/radondbOpenSearch/radondbopensearch-prer-databaseStatusRunning.adoc new file mode 100644 index 000000000..ecf8d928b --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbOpenSearch/radondbopensearch-prer-databaseStatusRunning.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 6951cd28fc784779b19c4409813b8fb0 +* RadonDB OpenSearch 状态为**运行中**。 diff --git a/content/zh/docs/_custom/radondb/radondbOpenSearch/radondbopensearch-prer-installRadondbopensearch.adoc b/content/zh/docs/_custom/radondb/radondbOpenSearch/radondbopensearch-prer-installRadondbopensearch.adoc new file mode 100644 index 000000000..ab64d25ed --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/radondb/radondbPostgreSQL/radondbpg-para-usernamePassword.adoc b/content/zh/docs/_custom/radondb/radondbPostgreSQL/radondbpg-para-usernamePassword.adoc new file mode 100644 index 000000000..ee819d146 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/radondb/radondbPostgreSQL/radondbpq-oper-openDatabaseUserList.adoc b/content/zh/docs/_custom/radondb/radondbPostgreSQL/radondbpq-oper-openDatabaseUserList.adoc new file mode 100644 index 000000000..d3cd3b1d7 --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbPostgreSQL/radondbpq-oper-openDatabaseUserList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 855e9c8a5ec24671aff7410cdffd8692 +. 在页面右侧点击 **OpenSearch 用户**页签打开数据库用户列表。 diff --git a/content/zh/docs/_custom/radondb/radondbPostgreSQL/radondbpq-oper-openDetailsPage.adoc b/content/zh/docs/_custom/radondb/radondbPostgreSQL/radondbpq-oper-openDetailsPage.adoc new file mode 100644 index 000000000..1edff82c3 --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbPostgreSQL/radondbpq-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 5213a0f3567e4087adace8424f5ab2e2 +. 在 RadonDB 应用列表中，点击 RadonDB PostgreSQL 应用的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/radondb/radondbPostgreSQL/radondpq-prer-databaseStatusRunning.adoc b/content/zh/docs/_custom/radondb/radondbPostgreSQL/radondpq-prer-databaseStatusRunning.adoc new file mode 100644 index 000000000..1cd211ded --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbPostgreSQL/radondpq-prer-databaseStatusRunning.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 01b12b8e4ead4b4eba730d5d592a9f3f +* RadonDB PostgreSQL 状态为**运行中**。 diff --git a/content/zh/docs/_custom/radondb/radondbPostgreSQL/radondpq-prer-installRadondbpq.adoc b/content/zh/docs/_custom/radondb/radondbPostgreSQL/radondpq-prer-installRadondbpq.adoc new file mode 100644 index 000000000..055e8f174 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/radondb/radondbRedisCluster/radondbRedisCluster-oper-openDetailsPage.adoc b/content/zh/docs/_custom/radondb/radondbRedisCluster/radondbRedisCluster-oper-openDetailsPage.adoc new file mode 100644 index 000000000..c9e97ca2b --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbRedisCluster/radondbRedisCluster-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 4cd4d0e0ec884581930fe2e8ae013cbe +. 在 RadonDB 应用列表中，点击 RadonDB Redis Cluster 应用的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/radondb/radondbRedisCluster/radondbRedisCluster-para-redisSettings.adoc b/content/zh/docs/_custom/radondb/radondbRedisCluster/radondbRedisCluster-para-redisSettings.adoc new file mode 100644 index 000000000..4506ba53b --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/radondb/radondbRedisCluster/radondbRedisCluster-prer-createAlertGroup.adoc b/content/zh/docs/_custom/radondb/radondbRedisCluster/radondbRedisCluster-prer-createAlertGroup.adoc new file mode 100644 index 000000000..b8352b258 --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbRedisCluster/radondbRedisCluster-prer-createAlertGroup.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: ccf50c036f65470881029f4b8a95cb86 +* 您已经创建了告警规则组。 diff --git a/content/zh/docs/_custom/radondb/radondbRedisCluster/radondbRedisCluster-prer-databaseStatusRunning.adoc b/content/zh/docs/_custom/radondb/radondbRedisCluster/radondbRedisCluster-prer-databaseStatusRunning.adoc new file mode 100644 index 000000000..125c7bd10 --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbRedisCluster/radondbRedisCluster-prer-databaseStatusRunning.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 87e4912d18cb4894a1834909e7c8f1ee +* RadonDB Redis Cluster 状态为**运行中**。 diff --git a/content/zh/docs/_custom/radondb/radondbRedisCluster/radondbRedisCluster-prer-installRadondbRedisCluster.adoc b/content/zh/docs/_custom/radondb/radondbRedisCluster/radondbRedisCluster-prer-installRadondbRedisCluster.adoc new file mode 100644 index 000000000..b0cb9b98f --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/radondb/radondbRedisSentinel/radondbRedisSentinel-oper-openDetailsPage.adoc b/content/zh/docs/_custom/radondb/radondbRedisSentinel/radondbRedisSentinel-oper-openDetailsPage.adoc new file mode 100644 index 000000000..181b8941b --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbRedisSentinel/radondbRedisSentinel-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: af7c62d166454ab193c42b8965ecfebf +. 在 RadonDB 应用列表中，点击 RadonDB Redis Sentinel 应用的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/radondb/radondbRedisSentinel/radondbRedisSentinel-para-redisSettings.adoc b/content/zh/docs/_custom/radondb/radondbRedisSentinel/radondbRedisSentinel-para-redisSettings.adoc new file mode 100644 index 000000000..8d4f8afd2 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/radondb/radondbRedisSentinel/radondbRedisSentinel-prer-databaseStatusRunning.adoc b/content/zh/docs/_custom/radondb/radondbRedisSentinel/radondbRedisSentinel-prer-databaseStatusRunning.adoc new file mode 100644 index 000000000..1cf153e4b --- /dev/null +++ b/content/zh/docs/_custom/radondb/radondbRedisSentinel/radondbRedisSentinel-prer-databaseStatusRunning.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 3b7e825804054abdb9a92bff016bc3b6 +* RadonDB Redis Sentinel 状态为**运行中**。 diff --git a/content/zh/docs/_custom/radondb/radondbRedisSentinel/radondbRedisSentinel-prer-installRadondbRedisSentinel.adoc b/content/zh/docs/_custom/radondb/radondbRedisSentinel/radondbRedisSentinel-prer-installRadondbRedisSentinel.adoc new file mode 100644 index 000000000..4f62e566b --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/radondb/ruleGroups-oper-editAlertRules.adoc b/content/zh/docs/_custom/radondb/ruleGroups-oper-editAlertRules.adoc new file mode 100644 index 000000000..aa9fc85db --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/workspaceManagement/appRepositories/appRepositories-para-createAppRepository.adoc b/content/zh/docs/_custom/workspaceManagement/appRepositories/appRepositories-para-createAppRepository.adoc new file mode 100644 index 000000000..e3d8b55d4 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/workspaceManagement/appRepositories/appRepositories-para-createAppRepository_v4.adoc b/content/zh/docs/_custom/workspaceManagement/appRepositories/appRepositories-para-createAppRepository_v4.adoc new file mode 100644 index 000000000..a90bf51aa --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/appRepositories/appRepositories-para-createAppRepository_v4.adoc @@ -0,0 +1,20 @@ +// :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/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc new file mode 100644 index 000000000..a0d58ab32 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 6c2cd879adcb4a5fa3abaf7929167ef7 +. 在应用模板列表中点击一个应用模板的名称打开其详情页面。 diff --git a/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-oper-searchForAppTemplates.adoc b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-oper-searchForAppTemplates.adoc new file mode 100644 index 000000000..edc4da33d --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-oper-searchForAppTemplates.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 2f8bbec5d37b4c239396337ce7576a71 +* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的应用模板。 diff --git a/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-oper-viewAppInstances.adoc b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-oper-viewAppInstances.adoc new file mode 100644 index 000000000..3aa5d15e2 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-oper-viewAppInstances.adoc @@ -0,0 +1,25 @@ +// :ks_include_id: a04eb03cbce9496996bd54443b6e4d64 +. 在应用模板详情页面右侧点击**应用实例**页签，查看使用应用模板在{ks_product_both}平台安装的应用。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|应用的名称。 + +include::../../projectManagement/apps/apps-para-status.adoc[] + +include::appTemplates-para-version.adoc[] + +|项目 +|应用所属的项目。 + +|集群 +|应用所属的集群。 + +|创建时间 +|应用的创建时间。 +|=== +-- diff --git a/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-oper-viewAttributes.adoc b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-oper-viewAttributes.adoc new file mode 100644 index 000000000..ac2abe5ac --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-oper-viewAttributes.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 97cb07634c9f4b08ab3ebea9f440d8e8 +. 在应用模板详情页面左侧的**属性**区域，查看应用模板的资源属性。 diff --git a/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-oper-viewVersions.adoc b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-oper-viewVersions.adoc new file mode 100644 index 000000000..9869506b0 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-oper-viewVersions.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: d78cb35f91534425932451fc1aeb33e2 +. 在应用模板详情页面右侧的**版本**页签，查看应用模板中包含的应用版本。 diff --git a/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-appTemplateName.adoc b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-appTemplateName.adoc new file mode 100644 index 000000000..207d95f27 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-appTemplateName.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: de8b37eae7ea4bdba3f2534f9d1b19c2 +|名称 +|应用模板的名称、图标和描述信息。 diff --git a/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-creationTime.adoc b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-creationTime.adoc new file mode 100644 index 000000000..eb0a7789f --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-creationTime.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: e53d38c7198848ea827f13da3541565e +|创建时间 +|应用模板的创建时间。 diff --git a/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-developer.adoc b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-developer.adoc new file mode 100644 index 000000000..3d20bc5cc --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-developer.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 76c5e6ca0e0d40fb8a75e2ea04ba859a +|开发者 +|上传应用版本的用户。 diff --git a/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-latestVersion.adoc b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-latestVersion.adoc new file mode 100644 index 000000000..675c5899b --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-latestVersion.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 3348c4c6bb6b473e887f8a6b5d1883c9 +|最新版本 +|应用模板中的 Helm Chart 和应用程序的最新版本。每个应用模板可包含应用的多个版本。 diff --git a/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-latestVersion_v4.adoc b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-latestVersion_v4.adoc new file mode 100644 index 000000000..0e17e7937 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-latestVersion_v4.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 3348c4c6bb6b473e887f8a6b5d1883c9 +|最新版本 +|应用模板中 Helm Chart 的最新版本。每个应用模板可包含应用的多个版本。 diff --git a/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-status.adoc b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-status.adoc new file mode 100644 index 000000000..d57407456 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-status.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: b1063d2135a7413f839d796f93c2afa0 +|状态 +|应用模板当前的状态。 + +* **未发布**：应用模板已创建成功，但是未发布到{ks_product_both}平台的应用商店。 + +* **已发布**：应用模板已创建成功，并且已发布到{ks_product_both}平台的应用商店。 + +* **已下架**：应用模板发布到{ks_product_both}平台的应用商店后被应用商店管理员下架。 \ No newline at end of file diff --git a/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-status_v4.adoc b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-status_v4.adoc new file mode 100644 index 000000000..2d9727f2c --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-status_v4.adoc @@ -0,0 +1,9 @@ +// :ks_include_id: b1063d2135a7413f839d796f93c2afa0 +|状态 +|应用模板当前的状态。 + +* **未上架**：应用模板已创建成功，但是未上架到{ks_product_both}平台的应用商店。 + +* **已上架**：应用模板已创建成功，并且已上架到{ks_product_both}平台的应用商店。 + +* **已下架**：应用模板上架到{ks_product_both}平台的应用商店后被应用商店管理员下架。 \ No newline at end of file diff --git a/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-type.adoc b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-type.adoc new file mode 100644 index 000000000..80ed6a573 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-type.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 933bd63e86ea4c958e7578f625e38dca +|类型 +|应用模板的类型。 diff --git a/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-version.adoc b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-version.adoc new file mode 100644 index 000000000..91a01157f --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-version.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 942eb298f1394bef9c3269ba02cc1311 +|版本 +|Helm Chart 的版本。 diff --git a/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-versionUpdateTime.adoc b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-versionUpdateTime.adoc new file mode 100644 index 000000000..f26de34c0 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-versionUpdateTime.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: 3c207e89fc77423187d81dd47480e0b4 +|更新时间 +|应用版本的更新时间。 diff --git a/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-viewAppInformation.adoc b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-viewAppInformation.adoc new file mode 100644 index 000000000..fdfc3111d --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-viewAppInformation.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 869781900cdb48f19e54811ea9a8abcc +. 在应用模板详情页面右侧点击**应用信息**页签，查看应用模板的介绍、截图和版本信息。 diff --git a/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-viewAppReviewRecords.adoc b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-viewAppReviewRecords.adoc new file mode 100644 index 000000000..6a06b7097 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-viewAppReviewRecords.adoc @@ -0,0 +1,24 @@ +// :ks_include_id: 6bd43a37515948a98375ba0850fee61a +. 在应用模板详情页面右侧点击**应用审核**页签，查看应用版本的审核记录。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|时间 +|应用审核记录的生成时间。 + +|状态 +|应用审核记录对应的应用版本状态。 + +|版本 +|生成审核记录对应的 Helm Chat 和应用程序的版本。 + +|拒绝原因 +|应用版本提交审核后，应用商店管理员拒绝版本发布的原因。仅在应用版本被应用商店管理员拒绝时显示。 + +|操作者 +|操作应用版本的用户。 +|=== +-- diff --git a/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-workspace.adoc b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-workspace.adoc new file mode 100644 index 000000000..d96ff2783 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-para-workspace.adoc @@ -0,0 +1,3 @@ +// :ks_include_id: d2cbf65cb5824a99bf21c210999ce5a7 +|企业空间 +|提交应用模板的企业空间。 diff --git a/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-prer-enableAppManagment.adoc b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-prer-enableAppManagment.adoc new file mode 100644 index 000000000..ae5a68686 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/appTemplates/appTemplates-prer-enableAppManagment.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: ee9b0f0546704ae1bfc9104d3fa7f5e5 +ifeval::["{file_output_type}" == "html"] + +* {ks_product_right}平台需要启用应用管理扩展组件。 + +endif::[] + +ifeval::["{file_output_type}" == "pdf"] + +* {ks_product_right}平台需要启用应用管理扩展组件。有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。 + +endif::[] diff --git a/content/zh/docs/_custom/workspaceManagement/devopsProjects/devopsProject-para-aliasAndDescription.adoc b/content/zh/docs/_custom/workspaceManagement/devopsProjects/devopsProject-para-aliasAndDescription.adoc new file mode 100644 index 000000000..a808db2bb --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/workspaceManagement/devopsProjects/devopsProject-prer-enableDevops.adoc b/content/zh/docs/_custom/workspaceManagement/devopsProjects/devopsProject-prer-enableDevops.adoc new file mode 100644 index 000000000..53572aca5 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/devopsProjects/devopsProject-prer-enableDevops.adoc @@ -0,0 +1,12 @@ +// :ks_include_id: f7fb88afed0545c4b9cefe39062aa225 +ifeval::["{file_output_type}" == "html"] + +* {ks_product_right}平台需要启用 DevOps 扩展组件。 + +endif::[] + +ifeval::["{file_output_type}" == "pdf"] + +* {ks_product_right}平台需要启用 DevOps 扩展组件。有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。 + +endif::[] diff --git a/content/zh/docs/_custom/workspaceManagement/projects/projects-desc-viewProjectList.adoc b/content/zh/docs/_custom/workspaceManagement/projects/projects-desc-viewProjectList.adoc new file mode 100644 index 000000000..594198ae8 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/projects/projects-desc-viewProjectList.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 3eeb5c203aae46429d31b7aefa3d19f1 +本节介绍如何查看项目列表。 diff --git a/content/zh/docs/_custom/workspaceManagement/projects/projects-openListPage.adoc b/content/zh/docs/_custom/workspaceManagement/projects/projects-openListPage.adoc new file mode 100644 index 000000000..4d543fb31 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/projects/projects-openListPage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 72b327c9dfd647bbb5416abd154eab96 +. 在**项目**页面点击**项目**或**多集群项目**打开项目列表。 diff --git a/content/zh/docs/_custom/workspaceManagement/projects/projects-oper-searchForProjects.adoc b/content/zh/docs/_custom/workspaceManagement/projects/projects-oper-searchForProjects.adoc new file mode 100644 index 000000000..d25541533 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/projects/projects-oper-searchForProjects.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: e4d2a0b225a247ccb0285a72a9b4d8b0 +* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的项目。 diff --git a/content/zh/docs/_custom/workspaceManagement/projects/projects-para-projectList.adoc b/content/zh/docs/_custom/workspaceManagement/projects/projects-para-projectList.adoc new file mode 100644 index 000000000..4cef68b9a --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/workspaceManagement/projects/projects-para-projectList_new.adoc b/content/zh/docs/_custom/workspaceManagement/projects/projects-para-projectList_new.adoc new file mode 100644 index 000000000..37c2e347c --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/projects/projects-para-projectList_new.adoc @@ -0,0 +1,8 @@ +// :ks_include_id: 63380fe4a19e47f9adc7412b139ff6bc +|名称 +|项目的名称和描述信息。 + +|状态 +| +include::../../clusterManagement/projects/projects-para-status.adoc[] + diff --git a/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-desc-toolBox.adoc b/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-desc-toolBox.adoc new file mode 100644 index 000000000..638e55f9e --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-desc-toolBox.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 90ec47841f944fafb24efa49dae7b328 +本节介绍如何使用工具箱。 diff --git a/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-desc-useLogQueryTools.adoc b/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-desc-useLogQueryTools.adoc new file mode 100644 index 000000000..06d9853c3 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-desc-useLogQueryTools.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: 11bc8bda3d544c559d443538a8b165cb +本节介绍如何查询容器日志。 + +{ks_product_right}提供日志查询工具。用户可以查询自身权限范围内的日志。{ks_product_right}支持查询以下类型的日志： diff --git a/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-desc-viewKubeconfig.adoc b/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-desc-viewKubeconfig.adoc new file mode 100644 index 000000000..3311da9bc --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-desc-viewKubeconfig.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: e29dfe6c970a4e5ca5b2958a5d35c83d +本节介绍如何查看 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/_custom/workspaceManagement/toolBox/toolBox-oper-useLogQueryTools.adoc b/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-oper-useLogQueryTools.adoc new file mode 100644 index 000000000..143e4ba91 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-oper-useLogQueryTools.adoc @@ -0,0 +1,16 @@ +// :ks_include_id: 4193b7c9a87a4a178301d417f9773e57 +. 以具有相关资源查看权限的用户登录{ks_product_left} Web 控制台。 + +. 将光标悬停在页面右下角的image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18]图标，然后在菜单中选择**容器日志查询**、**资源事件查询**或**审计日志查询**。 + +. 在弹出的对话框，设置搜索条件查询日志。 ++ +-- +* 如果已启用多集群功能，点击**集群**下拉列表可查询特定集群中的日志。 + +* 点击搜索框，设置搜索条件，然后按 **Enter** 可查看符合特定条件的日志。您可以同时设置多个搜索条件。 + +* 在查询结果页面可查看日志的时间分布图，点击image:/images/ks-qkcp/zh/icons/start-dark.svg[start-dark,18,18]/image:/images/ks-qkcp/zh/icons/stop-dark-white.svg[stop-dark-white,18,18]可开启/停止实时数据刷新，点击**日志导出**下拉列表可选择正序或倒序导出容器日志，点击**刷新频率**的时间可选择数据的刷新频率。 + +* 在查询结果列表右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]可定制列表中显示的信息。 +-- diff --git a/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-oper-viewKubeconfig.adoc b/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-oper-viewKubeconfig.adoc new file mode 100644 index 000000000..f4d47d678 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-oper-viewKubeconfig.adoc @@ -0,0 +1,14 @@ +// :ks_include_id: b0e53b8c6b7949668a6b41de9862d4e1 +. 登录{ks_product_left} Web 控制台。 + +. 将光标悬停在页面右下角的image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18]图标，然后在菜单中选择 **kubeconfig**。 + +. 在弹出的对话框查看 kubeconfig 配置信息。 ++ +-- +* **clusters:cluster:server** 字段显示的访问地址为虚拟 IP 地址，只能从集群内部部访问。如需从集群外部访问，请将该地址修改为 kube-apiserver 对外暴露的地址。 + +* **contexts:cluster:namespace** 字段默认显示的项目名称为 **default**。请将该字段取值修改为当前用户实际具有访问权限的项目名称。 + +* 点击image:/images/ks-qkcp/zh/icons/download-dark.svg[download-dark,18,18]可将 **kubeconfig.yaml** 文件下载到本地。 +-- diff --git a/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-prer-useLogQueryTools.adoc b/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-prer-useLogQueryTools.adoc new file mode 100644 index 000000000..15203e40e --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-prer-useLogQueryTools.adoc @@ -0,0 +1,18 @@ +// :ks_include_id: 767f7ca66b4048cd98a9ff15a50b4d62 +* 您需要获得平台、集群、企业空间或项目的资源查看权限，以查看特定范围的日志。 + +ifeval::["{file_output_type}" == "html"] + +* {ks_product_right}平台需要启用日志、事件和审计扩展组件。 + +* {ks_product_right}集群需要添加 Elasticsearch 日志接收器。 + +endif::[] + +ifeval::["{file_output_type}" == "pdf"] + +* {ks_product_right}平台需要启用日志、事件和审计扩展组件。有关更多信息，请参阅《{ks_product_full_both}平台管理指南》的“扩展组件管理”章节。 + +* {ks_product_right}集群需要添加 Elasticsearch 日志接收器。有关更多信息，请参阅《{ks_product_full_right}集群管理指南》的“添加日志接收器”章节。 + +endif::[] diff --git a/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-prer-viewKubeconfig.adoc b/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-prer-viewKubeconfig.adoc new file mode 100644 index 000000000..77a653e5d --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/toolBox/toolBox-prer-viewKubeconfig.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 40808c5525064e71af36e47e96b1d978 +您需要获取{ks_product_both}用户名和密码。 diff --git a/content/zh/docs/_custom/workspaceManagement/webConsole/webConsole-desc-changeEmailLanguagePassword.adoc b/content/zh/docs/_custom/workspaceManagement/webConsole/webConsole-desc-changeEmailLanguagePassword.adoc new file mode 100644 index 000000000..3a8330ad0 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/webConsole/webConsole-desc-changeEmailLanguagePassword.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 149e9993d7754b0cad7ae5e66b491179 +本节介绍如何修改当前用户的邮箱、语言和密码。 diff --git a/content/zh/docs/_custom/workspaceManagement/webConsole/webConsole-note-firstLogin.adoc b/content/zh/docs/_custom/workspaceManagement/webConsole/webConsole-note-firstLogin.adoc new file mode 100644 index 000000000..b4bc9d0ef --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/webConsole/webConsole-note-firstLogin.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 8a815fa5b82845cfa11a8ce3911564e2 +初次登录时系统将提示修改用户密码。 diff --git a/content/zh/docs/_custom/workspaceManagement/webConsole/webConsole-note-goToWorkspace.adoc b/content/zh/docs/_custom/workspaceManagement/webConsole/webConsole-note-goToWorkspace.adoc new file mode 100644 index 000000000..48a932484 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/webConsole/webConsole-note-goToWorkspace.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: b73ee63b32ed4389bc6d4e01f2522e0c +* 如果当前用户同时具有平台级别的权限，您需要在页面左上角选择**平台管理 > 访问控制**，然后点击一个企业空间的名称进入企业空间。 diff --git a/content/zh/docs/_custom/workspaceManagement/webConsole/webConsole-oper-changeEmailLanguagePassword.adoc b/content/zh/docs/_custom/workspaceManagement/webConsole/webConsole-oper-changeEmailLanguagePassword.adoc new file mode 100644 index 000000000..699d07e77 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/webConsole/webConsole-oper-changeEmailLanguagePassword.adoc @@ -0,0 +1,25 @@ +// :ks_include_id: 24b68b27cd234dc19c8f3db06ff7be8c +. 登录{ks_product_left} Web 控制台。 + +. 在页面右上角点击当前用户名，然后在下拉列表中选择**用户设置**。 + +. 在**基本信息**页签设置用户的邮箱和语言。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|邮箱 +|用户的邮箱地址。邮箱地址可用于登录{ks_product_left} Web 控制台。 + +|语言 +|{ks_product_right} Web 控制台对当前用户显示的语言。 +|=== +-- + +. 点击**密码设置**页签可修改当前用户的密码。 ++ +-- +密码必须包含数字、大写字母和小写字母，长度为 8 至 64 个字符。 +-- diff --git a/content/zh/docs/_custom/workspaceManagement/webConsole/webConsole-oper-logIn.adoc b/content/zh/docs/_custom/workspaceManagement/webConsole/webConsole-oper-logIn.adoc new file mode 100644 index 000000000..acc281d0a --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/webConsole/webConsole-oper-logIn.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: b690a1bf28354fa9a64364d91a595cd7 +. 打开 Web 浏览器，在地址栏中输入{ks_product_left} Web 控制台的 IP 地址和端口号。 + +. 在{ks_product_both}登录页面，输入用户信息然后点击**登录**。 diff --git a/content/zh/docs/_custom/workspaceManagement/webConsole/webConsole-prer-logIn.adoc b/content/zh/docs/_custom/workspaceManagement/webConsole/webConsole-prer-logIn.adoc new file mode 100644 index 000000000..22786037f --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/webConsole/webConsole-prer-logIn.adoc @@ -0,0 +1,4 @@ +// :ks_include_id: b7d4651227e646b1b025777d274f6c4a +* 您需要联系{ks_product_both}平台管理员获取 Web 控制台的 IP 地址和端口号。 + +* 取决于您的网络环境，您可能需要配置防火墙策略和流量转发策略。有关具体操作，请联系您的网络环境管理员。 diff --git a/content/zh/docs/_custom/workspaceManagement/workspace-quotas/workspaceQuotas-para-cpuMemoryQuotas.adoc b/content/zh/docs/_custom/workspaceManagement/workspace-quotas/workspaceQuotas-para-cpuMemoryQuotas.adoc new file mode 100644 index 000000000..f9143ea94 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/workspace-quotas/workspaceQuotas-para-cpuMemoryQuotas.adoc @@ -0,0 +1,17 @@ +// :ks_include_id: 5ad1ed3919ae46abbe1b16d6a66d149c +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|CPU 上限 +|企业空间运行在单个集群中所有容器 CPU 上限总和的最大值。 + +|CPU 预留 +|企业空间运行在单个集群中所有容器 CPU 预留总和的最大值。 + +|内存上限 +|企业空间运行在单个集群中所有容器内存上限总和的最大值。 + +|内存预留 +|企业空间运行在单个集群中所有容器内存预留总和的最大值。 +|=== \ No newline at end of file diff --git a/content/zh/docs/_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc b/content/zh/docs/_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc new file mode 100644 index 000000000..5bc504c18 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 9e983855b51f4d47a0318514ec5e4d84 +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的企业空间。 diff --git a/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission.adoc b/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission.adoc new file mode 100644 index 000000000..b012eb816 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 05d7ebe027f04cc589e8baa04343e651 +您需要加入一个企业空间并在企业空间中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:06-workspace-management/06-workspace-settings/03-workspace-members/_index.adoc[企业空间成员]、xref:06-workspace-management/06-workspace-settings/04-workspace-roles/_index.adoc[企业空间角色]和xref:06-workspace-management/06-workspace-settings/05-departments/_index.adoc[部门]。 diff --git a/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_new.adoc b/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_new.adoc new file mode 100644 index 000000000..d723b7823 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_new.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 05d7ebe027f04cc589e8baa04343e651 +您需要加入一个企业空间并在企业空间中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:08-workspace-management/05-workspace-settings/03-workspace-members/_index.adoc[企业空间成员]和xref:08-workspace-management/05-workspace-settings/04-workspace-roles/_index.adoc[企业空间角色]。 diff --git a/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc b/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc new file mode 100644 index 000000000..458f5f080 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: 05d7ebe027f04cc589e8baa04343e651 +您需要加入一个企业空间并在企业空间中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:08-workspace-management/06-workspace-settings/03-workspace-members/_index.adoc[企业空间成员]和xref:08-workspace-management/06-workspace-settings/04-workspace-roles/_index.adoc[企业空间角色]。 diff --git a/content/zh/docs/_custom/workspaceManagement/workspaceMembers/workspaceMembers-desc-initialWorkspaceAdmin.adoc b/content/zh/docs/_custom/workspaceManagement/workspaceMembers/workspaceMembers-desc-initialWorkspaceAdmin.adoc new file mode 100644 index 000000000..8567180e2 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/workspaceMembers/workspaceMembers-desc-initialWorkspaceAdmin.adoc @@ -0,0 +1,2 @@ +// :ks_include_id: e84bfd6e91754efa8444c040d1726c11 +企业空间的创建者自动成为企业空间管理员。此外，{ks_product_right}平台的 **admin** 用户默认在所有企业空间中具有所有权限。在企业空间初始状态下，可由以上用户邀请其他用户加入企业空间并设置用户在企业空间中的角色。 diff --git a/content/zh/docs/_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-aliasAndDescription.adoc b/content/zh/docs/_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-aliasAndDescription.adoc new file mode 100644 index 000000000..6f8c12628 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-aliasAndDescription.adoc @@ -0,0 +1,6 @@ +// :ks_include_id: 9cee592273284279a2ca4b2ff0c861a5 +|别名 +|企业空间角色的别名。不同企业空间角色的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|企业空间角色的描述信息。描述可包含任意字符，最长 256 个字符。 diff --git a/content/zh/docs/_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions.adoc b/content/zh/docs/_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions.adoc new file mode 100644 index 000000000..3729fb3a7 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions_new.adoc b/content/zh/docs/_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions_new.adoc new file mode 100644 index 000000000..11e03fc02 --- /dev/null +++ b/content/zh/docs/_custom/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/zh/docs/_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions_v4.adoc b/content/zh/docs/_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions_v4.adoc new file mode 100644 index 000000000..35c41c098 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions_v4.adoc @@ -0,0 +1,83 @@ +// :ks_include_id: b53ca408cc88447789f75df42c73bcc7 +所有企业空间成员都可以查看企业空间基本信息。其他操作所需的权限如下： + +* 项目 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|项目创建 +|创建项目，并成为所创建的项目的管理员。 + +|项目管理 +|创建、编辑和删除企业空间中的项目。 + +|项目查看 +|查看项目列表、查看项目中的所有资源。 +|=== +-- + +* 应用 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|应用仓库管理 +|添加应用仓库、编辑应用仓库、删除应用仓库。 + +|应用仓库查看 +|查看应用仓库列表。 + +|应用/应用版本/应用实例管理 +|创建应用模板、编辑应用模板信息、使用应用模板安装应用、上传应用版本、删除应用版本、将应用版本发布到应用商店、删除应用模板。 + +|应用/应用版本/应用实例查看 +|查看应用模板列表、查看应用模板详情、下载 Helm Chart 压缩包。 +|=== +-- + +* 访问控制 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +// |部门管理 +// |设置部门组织结构、将用户分配到部门、移除部门成员。 + +// |部门查看 +// |查看部门组织结构。 + +// |成员管理 +// |邀请用户加入企业空间、修改企业空间成员的角色、移除企业空间成员。 + +|成员查看 +|查看企业空间成员列表、查看企业空间成员详情。 + +// |角色管理 +// |创建企业空间角色、编辑企业空间角色信息、编辑企业空间角色权限、删除企业空间角色。 + +|角色查看 +|查看企业空间角色列表、查看企业空间角色详情。 +|=== +-- + +// * 企业空间设置 +// + +// -- +// [%header,cols="1a,4a"] +// |=== +// |权限 |允许操作 + +// |企业空间设置管理 +// |编辑企业空间信息、启用和禁用网络隔离、删除企业空间、编辑企业空间配额。 + +// |企业空间设置查看 +// |查看集群资源用量、查看项目资源用量排行、查看企业空间资源用量、查看企业空间配额。 +// |=== +// -- diff --git a/content/zh/docs/_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-presetRoles.adoc b/content/zh/docs/_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-presetRoles.adoc new file mode 100644 index 000000000..531173af8 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-presetRoles.adoc @@ -0,0 +1,19 @@ +// :ks_include_id: a438eaa55c9043cbb3d66ebadd42472e +{ks_product_right}平台提供以下预置企业空间角色： + +[%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/zh/docs/_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-presetRoles_v4.adoc b/content/zh/docs/_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-presetRoles_v4.adoc new file mode 100644 index 000000000..c7e0fdbf5 --- /dev/null +++ b/content/zh/docs/_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-presetRoles_v4.adoc @@ -0,0 +1,19 @@ +// :ks_include_id: a438eaa55c9043cbb3d66ebadd42472e +{ks_product_right}平台提供以下预置企业空间角色： + +[%header,cols="1a,4a"] +|=== +|角色 |描述 + +|workspace-admin +|企业空间管理员，在企业空间内具有全部权限。 + +|workspace-self-provisioner +|企业空间自治用户，在企业空间内可以创建项目、查看企业空间设置，同时对自身创建的项目具有管理权限。 + +|workspace-viewer +|企业空间观察员，可以查看企业空间内的所有资源。 + +|workspace-regular +|企业空间普通用户，在企业空间内只具有企业空间设置查看权限。该角色一般授予不需要其他企业空间权限的项目成员。 +|=== \ No newline at end of file diff --git a/content/zh/docs/v4.1/01-intro/01-introduction.adoc b/content/zh/docs/v4.1/01-intro/01-introduction.adoc new file mode 100644 index 000000000..1c7f8a9e9 --- /dev/null +++ b/content/zh/docs/v4.1/01-intro/01-introduction.adoc @@ -0,0 +1,69 @@ +--- +title: "KubeSphere LuBan" +weight: 01 +--- + +{ks_product_right}（KubeSphere Enterprise），是基于 Kubernetes 内核的分布式多租户商用云原生操作系统。在开源能力的基础上，在多云集群管理、微服务治理、应用管理等多个核心业务场景进行功能延伸。商用扩展中心实现高度模块化，满足不同场景业务需求。以强大的企业级云原生底座，完善的专家级解决方案和服务支持，赋能企业数字化转型和规模化运营。 + +自{ks_product_left} v4.0 起，引入扩展机制，推出了全新的 KubeSphere 架构：**KubeSphere LuBan**，它构建在 link:https://kubernetes.io/zh-cn/docs/concepts/extend-kubernetes/[Kubernetes] 之上，支持高度可配置和可扩展。KubeSphere LuBan，是一个分布式的云原生可扩展开放架构，为扩展组件提供一个可热插拔的微内核。自此，KubeSphere 所有功能组件及第三方组件都会基于 KubeSphere LuBan，以扩展组件的方式无缝融入到 KubeSphere 控制台中，并独立维护版本，真正实现即插即用的应用级云原生操作系统。 + + +== 为什么推出 KubeSphere LuBan + +自 2018 年以来，KubeSphere 混合多云容器管理平台已发布过十几个版本，其中包括三个重大版本。为了满足用户需求，KubeSphere 集成了众多企业级功能，如多租户管理，多集群管理，DevOps，GitOps，服务网格，微服务，可观测（包括监控、告警、日志、审计、事件、通知等），应用商店，边缘计算，网络与存储管理等。 + +虽然 KubeSphere 的一站式容器解决方案极大地提升了用户的容器使用体验，但也带来了如下挑战： + +**发版周期长** + +在发布新版本时，需要等待所有组件完成开发、测试并通过集成测试。 + +**响应用户不及时** + +由于各组件无法单独迭代，KubeSphere 发布后，对社区和用户组件反馈处理需要等待 KubeSphere 发布新版本后才能一并交付给用户，导致响应不够及时。 + +**代码耦合** + +尽管目前已能实现单独启用/禁用特定组件，但这些组件的前后端代码仍然耦合在一起，容易互相影响，架构上不够优雅。 + +**系统资源占用过多** + +部分组件默认启用，对于没有相关需求的用户来说，可能会占用过多的系统资源。 + +== KubeSphere LuBan 优势 + +**插件式的核心框架** + +支持独立开发和部署组件以扩展系统的功能。组件可以根据需求进行添加、升级或移除，而不需要修改核心框架的代码。 + +**全开放的基础 UI 组件库** + +组件对所有人开放，任何人都可以自由地访问、使用和扩展这些组件。用户根据自己的需求进行定制和扩展，以满足不同的设计和功能要求。 + +**前后端热更新、热修复** + +开发者可以在系统运行时对前端和后端进行实时更新和修复，提高了开发和运维的效率，同时保证了应用程序的可用性和用户体验。 + +**开放性扩展中心，生态共建** + +我们提供一个开放的平台，鼓励第三方开发者通过组件向系统添加新的功能或增强现有功能，在系统的框架内进行开发和集成，并将他们的组件与系统进行无缝连接，共同构建一个健康、繁荣的生态系统。 + +== KubeSphere LuBan 如何帮助到您 + +KubeSphere LuBan 架构可以使以下人员受益： + +**KubeSphere 用户** + +KubeSphere 用户可以自由选择启用哪些 KubeSphere 扩展组件。同时还能将自己的应用无缝融入到 KubeSphere 控制台。此外，随着 KubeSphere 扩展组件生态的丰富，用户可以在 KubeSphere 扩展市场中自由选择更丰富的产品和服务，最终实现容器管理平台的千人千面的效果。 + +**KubeSphere 维护者** + +扩展机制使得维护者可以更聚焦 KubeSphere 核心功能的开发，并可使得 KubeSphere Core 更加轻量，版本发布节奏也可以加快。此外，因为扩展组件能够独立进行迭代，能够更及时地满足用户的需求。 + +**KubeSphere 贡献者** + +扩展机制的引入使得 KubeSphere Core 及 KubeSphere 其他扩展组件变得更加松耦合，开发也更加易于上手。 + +**云原生应用开发商（ISV）或其他开源项目** + +众多 ISV 或其他开源项目可以低成本将产品或开源项目无缝融入到 KubeSphere 生态系统中。比如 Karmada/KubeEdge 的开发人员可以基于 KubeSphere LuBan 开发独立的 Karmada/KubeEdge 控制台。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/01-intro/02-architecture.adoc b/content/zh/docs/v4.1/01-intro/02-architecture.adoc new file mode 100644 index 000000000..906f6fc72 --- /dev/null +++ b/content/zh/docs/v4.1/01-intro/02-architecture.adoc @@ -0,0 +1,43 @@ +--- +title: "KubeSphere LuBan 架构" +weight: 02 +--- + +为了使 KubeSphere 灵活可扩展，我们设计了微内核 + 扩展组件的架构（代号 LuBan）。其中内核部分（KubeSphere Core）仅包含系统运行的必备基础功能，而将独立的业务模块分别封装在各个扩展组件（Extensions）中。用户可在系统运行时动态地安装、卸载、启用、禁用扩展组件。 + +== KubeSphere LuBan 架构 + +KubeSphere LuBan 架构设计如下图所示。 + +image:/images/ks-qkcp/zh/v4.0/4.0-architecture.png[architecture,80%] + +== 什么是 KubeSphere 扩展组件？ + +KubeSphere 扩展组件是一个可以对 KubeSphere 功能进行扩展并借助 Helm 进行编排的，遵循 KubeSphere 扩展组件开发规范的 Helm Chart。 + +作为云原生领域的开发者，您不必再花大量的时间去学习一个私有的应用编排方式。 + +请前往 link:https://kubesphere.com.cn/extensions/marketplace/[KubeSphere Marketplace] 查看、安装已发布的扩展组件。 + +== KubeSphere 扩展组件可以做什么？ + +从前端 UI 到后端 API，KubeSphere 的几乎每个部分都可以通过扩展 API 进行定制和增强。KubeSphere 的许多核心功能也都是作为扩展构建的，并使用相同的扩展 API。 + +以下是使用扩展 API 可以实现的一些示例： + +. 在项目的侧边导航栏，注入新的菜单与功能页面，支持管理更多类型的资源。 +. 在平台层级菜单中注入功能入口，对平台的管理能力进行增强。 +. 直接嵌入已有的第三方功能组件页面到 KubeSphere，对各分散的系统进行聚合。 +. 覆盖 KubeSphere 已有的页面路由，实现您独有的业务逻辑。 +. 对 KubeSphere 的 API 进行扩展。 + +如果您想更全面地了解扩展 API，请参阅link:https://dev-guide.kubesphere.io/extension-dev-guide/zh/feature-customization/[功能定制]。 + +== 如何构建扩展组件？ + +请参阅link:https://dev-guide.kubesphere.io/extension-dev-guide/zh/development-procedure/[开发流程]章节来熟悉如何构建扩展组件。 + +如果您在扩展组件的开发过程中有疑问，请尝试在 link:https://github.com/kubesphere/kubesphere/issues/new/choose[GitHub Issue] 获得帮助。 + + + diff --git a/content/zh/docs/v4.1/01-intro/03-scenarios.adoc b/content/zh/docs/v4.1/01-intro/03-scenarios.adoc new file mode 100644 index 000000000..bfab5722e --- /dev/null +++ b/content/zh/docs/v4.1/01-intro/03-scenarios.adoc @@ -0,0 +1,22 @@ +--- +title: "应用场景" +weight: 03 +--- + +{ks_product_right}适用于以下场景。 + +== 资源量化运营 + +多部门资源管理往往会给运维带来巨大的资源管理压力，运维部门统计各业务线的资源利用率，评估各业务资源利用率的合理性，都需要巨大的工作时间成本。{ks_product_right}提供多维度、多角度的资源量化统计方式，资源数据一目了然。 + +== 多级权限管控 + +公司各业务线如何高效协同一直是个亘古难题，基础设施运维、应用运维以及业务开发人员如何能通过平台紧密合作，实现权限隔离成为了组织架构的核心需求。{ks_product_right}提供 “三权分立” 的用户权限体系，平台管理员、集群运维和应用运维三大权限视角合理分配，促进部门协作。 + +== 智能弹性运维 + +基础资源过度浪费会给企业带来额外的运营成本，如何有效分析资源使用的合理性、在不同的场景下进行高效资源弹性管理也成为运维人员的难题。{ks_product_right}提供业务资源的智能推荐方案，定时分析，一键应用，同时支持自定义指标弹性伸缩，赋能智能运维。 + +== 云原生一栈式转型 + +不少企业转型云原生都会遇到技术选型难题，如何实现 DevOps 运维一体化，云原生微服务治理，云边协同，AI 人工智能以及云原生下的可观测性。各种技术方案的选型以及运维给各企业带来了极大的困扰。{ks_product_right}集成业界最佳实践，提供高度图形化，一致性的使用体验，助力企业低成本走向云原生。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/01-intro/_index.adoc b/content/zh/docs/v4.1/01-intro/_index.adoc new file mode 100644 index 000000000..509f84c40 --- /dev/null +++ b/content/zh/docs/v4.1/01-intro/_index.adoc @@ -0,0 +1,39 @@ +--- +title: "产品简介" +keywords: "{ks_product}, KubeSphere, KubeSphere Enterprise, KubeSphere LuBan, 产品简介" +description: 介绍{ks_product_both}的产品优势，架构以及应用场景。 +weight: 01 +--- + +本节介绍{ks_product_both}的产品优势，架构以及应用场景。 + +ifeval::["{file_output_type}" == "pdf"] + +== 产品版本 + +本文档适用于{ks_product_left} v4.1.0 版本。 + +== 读者对象 + +本文档主要适用于以下读者： + +* {ks_product_right}用户 + +* 交付工程师 + +* 运维工程师 + +* 售后工程师 + + +== 修订记录 + +[%header,cols="1a,1a,3a"] +|=== +|文档版本 |发布日期 |修改说明 + +|01 +|{pdf_releaseDate} +|第一次正式发布。 +|=== +endif::[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/02-quickstart/01-install-ks-core.adoc b/content/zh/docs/v4.1/02-quickstart/01-install-ks-core.adoc new file mode 100644 index 000000000..463152822 --- /dev/null +++ b/content/zh/docs/v4.1/02-quickstart/01-install-ks-core.adoc @@ -0,0 +1,649 @@ +--- +title: "安装 KubeSphere 企业版" +keywords: "Kubernetes, KubeSphere, 快速入门, 安装, KubeSphere Core" +description: "介绍如何安装 KubeSphere。" +weight: 01 +--- + +// 以下内容与“安装 Kubernetes 和 KubeSphere 企业版”的内容完全一样，不同点：层级提升一层导致 include 链接有变化；修改 link 链接为 pdf 文档名称。 + +本节介绍如何安装 Kubernetes 和{ks_product_left}。 + +安装过程中将用到开源工具 KubeKey。有关 KubeKey 的更多信息，请访问 link:https://github.com/kubesphere/kubekey[GitHub KubeKey 仓库]。 + + +== 前提条件 + +* 您需要联系{ks_product_both}的服务支持团队获取{ks_product_left} v4.1.0 安装包。 + +// 如实施现场条件允许在线拉取公开仓库，具备在线安装条件，可联系 KubeSphere 产品团队获取在线安装文件及相关信息。 + +* 您需要准备至少 1 台 Linux 服务器作为集群节点。在生产环境中，为确保集群具备高可用性，建议准备至少 5 台 Linux 服务器，其中 3 台作为控制平面节点，另外 2 台作为工作节点。如果您在多台 Linux 服务器上安装{ks_product_left}，请确保所有服务器属于同一子网。 + +* 集群节点的操作系统和版本须为 Ubuntu 16.04、Ubuntu 18.04、Ubuntu 20.04、Ubuntu 22.04、Debian 9、Debian 10、CentOS 7、CentOS Stream、RHEL 7、RHEL 8、SLES 15 或 openSUSE Leap 15。多台服务器的操作系统可以不同。关于其它操作系统和版本支持，请联系{ks_product_both}技术支持。 + +* 在生产环境中，为确保集群具有足够的计算和存储资源，建议每台集群节点配置至少 8 个 CPU 核心、16 GB 内存和 200 GB 磁盘空间。除此之外，建议在每台集群节点的 **/var/lib/docker**（对于 Docker）或 **/var/lib/containerd**（对于 containerd） 目录额外挂载至少 200 GB 磁盘空间用于存储容器运行时数据。 + +* 除集群节点外，您还需要准备一台 Linux 服务器用于创建私有镜像服务，该服务器必须与{ks_product_both}集群节点网络连通，并且在 **/mnt/registry** 目录挂载至少 100 GB 磁盘空间。 + +* 在生产环境中，建议提前为{ks_product_both}集群配置高可用性以避免单个控制平面节点出现故障时集群服务中断。有关更多信息，请参阅《{ks_product_right}安装指南》的“配置高可用性”章节。 ++ +-- +// Note +include::../../../_ks_components/admonitions/note.adoc[] + +如果您规划了多个控制平面节点，请务必提前为集群配置高可用性。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +* 默认情况下，{ks_product_right}使用集群节点的本地磁盘空间作为持久化存储。在生产环境中，建议提前配置外部存储系统作为持久化存储。有关更多信息，请参阅《{ks_product_right}安装指南》的“配置外部持久化存储”章节。 + +* 如果集群节点未安装容器运行时，安装工具 KubeKey 将在安装过程中自动为每个集群节点安装 Docker 作为容器运行时。您也可以提前手动安装 containerd、CRI-O 或 iSula 作为容器运行时。 ++ +-- +// Note +include::../../../_ks_components/admonitions/note.adoc[] + +CRI-O 和 iSula 与{ks_product_both}的兼容性尚未经过充分测试，可能存在未知问题。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +* 请确保所有集群节点上 **/etc/resolv.conf** 文件中配置的 DNS 服务器地址可用。否则，{ks_product_right}集群可能会出现域名解析问题。 + +* 请确保在所有集群节点上都可以使用 **sudo**、**curl** 和 **openssl** 命令。 + +* 请确保所有集群节点时间同步。 + + +== 配置防火墙规则 + +{ks_product_right}需要特定端口和协议用于服务之间的通信。如果您的基础设施环境已启用防火墙，您需要在防火墙设置中放行所需的端口和协议。如果您的基础设施环境未启用防火墙，您可以跳过此步骤。 + +下表列出需要在防火墙中放行的端口和协议。 + +[%header,cols="1a,1a,1a,1a,2a"] +|=== +|服务 |协议 |起始端口 |结束端口 |备注 + +|ssh +|TCP +|22 +| +| + +|etcd +|TCP +|2379 +|2380 +| + +|apiserver +|TCP +|6443 +| +| + +|calico +|TCP +|9099 +|9100 +| + +|bgp +|TCP +|179 +| +| + +|nodeport +|TCP +|30000 +|32767 +| + +|master +|TCP +|10250 +|10258 +| + +|dns +|TCP +|53 +| +| + +|dns +|UDP +|53 +| +| + +|metrics-server +|TCP +|8443 +| +| + +|local-registry +|TCP +|5000 +| +|离线环境需要 + +|local-apt +|TCP +|5080 +| +|离线环境需要 + +|rpcbind +|TCP +|111 +| +|使用 NFS 作为持久化存储时需要 + +|ipip +|IPENCAP/IPIP +| +| +|使用 Calico 时需要 +|=== + +== 安装依赖项 + +您需要为所有集群节点安装 socat、conntrack、ebtables 和 ipset。如果上述依赖项在各集群节点上已存在，您可以跳过此步骤。 + +在 Ubuntu 操作系统上，执行以下命令为服务器安装依赖项： + +// Bash +include::../../../_ks_components/code/bash.adoc[] + +sudo apt install socat conntrack ebtables ipset -y + +---- + +如果集群节点使用其他操作系统，请将 **apt** 替换为操作系统对应的软件包管理工具。 + +== 查看安装包内容 + +了解{ks_product_left} v4.1.0 的安装包内容，以便进行后续步骤。 + +安装包包含以下文件： + +[,bash] +---- +kse-all-v4.1.0-offline-linux-amd64/ +├── charts +│   ├── ks-core # KubeSphere 企业版核心组件 +│   ├── kse-extensions-publish # 用于发布 KubeSphere 企业版扩展组件 +│   ├── csi-qingcloud # 用于对接青云云平台存储 +│   ├── csi-neonsan # 用于对接 NeonSan 存储 +│   └── nfs-client-provisioner # 用于对接 NFS 存储 +├── tools +│ ├── pre-check.sh # 用于 KubeSphere 企业版升级前的集群环境检查 +│ ├── backup.sh # 用于 KubeSphere 企业版升级前备份系统企业空间中的关键资源 +│ └── upgrade.sh # KubeSphere 企业版升级脚本，提供快速升级能力 +│ ├── oras # OCI 工具，便于镜像同步等操作 +│ └── ks-core-values.yaml # 升级配置示例文件，用于配置各组件的升级参数 +├── kse-extensions # 其中包含所有扩展组件的 installplan，可用于快速安装 KubeSphere 企业版扩展组件 +├── config-sample.yaml # 安装配置文件的模版 +├── create_project_harbor.sh # 用于快速创建 harbor 项目 +├── kk # 集群部署工具 +├── kubekey-artifact.tar.gz # KubeSphere 企业版制品，其中包含集群部署所需的二进制文件及镜像 +└── manifest-v410-amd64.yaml # KubeSphere 企业版制品清单，其中包含各组件的版本以及镜像列表 +---- + + + +== 配置安装配置文件 + +**config-sample.yaml** 是{ks_product_both}的安装配置文件，请先配置该文件，以便进行后续步骤。 + +include::../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[] ++ + +. 执行以下命令编辑安装配置文件 **config-sample.yaml**： ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + +vi config-sample.yaml + +---- + +以下为部分示例配置文件，如需了解完整示例，请参阅link:https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md[此文件]。 + +// YAML +include::../../../_ks_components/code/yaml.adoc[] + +apiVersion: kubekey.kubesphere.io/v1alpha2 +kind: Cluster +metadata: + name: sample +spec: + hosts: + - {name: controlplane1, address: 192.168.0.2, internalAddress: 192.168.0.2, port: 23, user: ubuntu, password: Testing123, arch: arm64} # arm64 节点注意添加参数 arch: arm64 + - {name: controlplane2, address: 192.168.0.3, internalAddress: 192.168.0.3, user: ubuntu, privateKeyPath: "~/.ssh/id_rsa"} + - {name: worker1, address: 192.168.0.4, internalAddress: 192.168.0.4, user: ubuntu, password: Testing123} + - {name: worker2, address: 192.168.0.5, internalAddress: 192.168.0.5, user: ubuntu, password: Testing123} + - {name: registry, address: 192.168.0.6, internalAddress: 192.168.0.6, user: ubuntu, password: Testing123} + roleGroups: + etcd: + - controlplane1 + - controlplane2 + control-plane: + - controlplane1 + - controlplane2 + worker: + - worker1 + - worker2 + # 如需使用 kk 自动部署镜像仓库，请设置 registry（建议镜像仓库与集群节点分离部署，减少相互影响） + registry: + - registry + controlPlaneEndpoint: + internalLoadbalancer: haproxy # 如需部署⾼可⽤集群，且⽆负载均衡器可⽤，可开启该参数，做集群内部负载均衡 + domain: lb.kubesphere.local + address: "" + port: 6443 + kubernetes: + version: v1.23.15 + clusterName: cluster.local + network: + plugin: calico + kubePodsCIDR: 10.233.64.0/18 + kubeServiceCIDR: 10.233.0.0/18 + ## multus support. https://github.com/k8snetworkplumbingwg/multus-cni + enableMultusCNI: false + registry: + # 如需使用 kk 部署 harbor，可将该参数设置为 harbor，不设置该参数且需使用 kk 部署容器镜像仓库，将默认部署 docker registry。 + # harbor 不支持 arm64，arm64 环境部署时，可不配置该参数。 + type: harbor + # 如使用 kk 部署的 harbor 或其他需要登录的仓库，需设置对应仓库的 auths，如使用 kk 部署默认的 docker registry 仓库，则无需配置 auths 参数。 + # 注意：如使用 kk 部署 harbor，auths 参数请于创建 harbor 项目之后设置。 + auths: + "dockerhub.kubekey.local": + username: admin # harbor 默认用户名 + password: Harbor12345 # harbor 默认密码 + plainHTTP: false  # 如果仓库使用 http，请将该参数设置为true + privateRegistry: "dockerhub.kubekey.local/kse"   # 设置集群部署时使用的私有仓库地址 + registryMirrors: [] + insecureRegistries: [] + addons: [] + +---- +-- + +. 在 **config-sample.yaml** 配置文件的 **spec:hosts** 参数下设置各服务器的信息。 ++ +-- +include::../../_custom/installationAndUpgrade/installationAndUpgrade-para-hosts.adoc[] + +-- + +. 在 **config-sample.yaml** 配置文件的 **spec:roleGroups** 参数下设置服务器的角色： ++ +-- +include::../../_custom/installationAndUpgrade/installationAndUpgrade-para-roleGroups.adoc[] +-- + +. 如果您规划了多个控制平面节点，在 **config-sample.yaml** 配置文件的 **spec:controlPlaneEndpoint** 参数下设置高可用性信息。 ++ +-- +include::../../_custom/installationAndUpgrade/installationAndUpgrade-para-controlPlaneEndpoint.adoc[] +-- + +. 如果您需要使用外部持久化存储，在 **config-sample.yaml** 配置文件的 **spec:addons** 参数下设置外部持久化存储信息。 ++ +==== +* 如果使用云上存储设备，在 **spec:addons** 下设置以下参数（将 替换为存储插件配置文件的实际路径）： ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + + - name: csi-qingcloud + namespace: kube-system + sources: + chart: + name: csi-qingcloud + path: charts/csi-qingcloud + valuesFile: +---- +-- + +* 如果使用 NeonSAN 存储设备，在 **spec:addons** 下设置以下参数（将 替换为存储插件配置文件的实际路径）： ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + + - name: csi-neonsan + namespace: kube-system + sources: + chart: + name: csi-neonsan + path: charts/csi-neonsan + valuesFile: + +---- +-- + +* 如果使用 NFS 存储系统，在 **spec:addons** 下设置以下参数（将 替换为存储插件配置文件的实际路径）： ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + + - name: nfs-client + namespace: kube-system + sources: + chart: + name: nfs-client-provisioner + repo: charts/nfs-client-provisioner + valuesFile: + +---- +-- +==== + +== 创建私有镜像仓库 + +[.admon.attention,cols="a"] +|=== +|注意 + +| +如果您已有可用的镜像仓库，可跳过此步骤。但需要把私有镜像服务的默认地址 **dockerhub.kubekey.local/kse** 替换为您的实际镜像仓库地址。 +|=== + +. 在配置文件 **config-sample.yaml** 的 **spec:hosts** 参数下设置用于创建私有镜像服务的服务器的信息。 ++ +-- +[,yaml] +---- +spec: + hosts: + - {name: registry, address: 192.168.0.6, internalAddress: 192.168.0.6, user: ubuntu, password: Testing123} +---- + +include::../../_custom/installationAndUpgrade/installationAndUpgrade-para-hosts.adoc[] +-- + +. 在 **spec:roleGroups:registry** 参数下设置用于创建私有镜像服务的服务器名称（将 替换为 **spec:hosts** 参数下设置的服务器实际名称）。 ++ +[,yaml] +---- +spec: + roleGroups: + registry: + - +---- + +. 将 **spec:registry:privateRegistry** 参数设置为私有镜像服务的默认地址 **dockerhub.kubekey.local/kse**，然后保存文件。 ++ +[,yaml] +---- +spec: + registry: + registryMirrors: [] + insecureRegistries: [] + privateRegistry: dockerhub.kubekey.local/kse +---- + + +. 执行以下命令初始化私有镜像服务： ++ +==== +[,bash] +---- +./kk init registry -f config-sample.yaml -a kubekey-artifact.tar.gz +---- + +如果显示如下信息，则表明镜像仓库创建成功。 + +image:/images/ks-qkcp/zh/v4.1/verify-registry.png[verify-registry, 100%] + +include::../../_custom/installationAndUpgrade/installationAndUpgrade-note-initializeRegistry.adoc[] + +==== + +. 若 **spec:registry:type** 参数设置为 **harbor**，执行以下命令创建 Harbor 项目。 ++ +-- +// Bash +include::../../../_ks_components/code/bash.adoc[] + +bash create_project_harbor.sh + +---- + +创建 harbor 项目后，在 **config-sample.yaml** 中配置 **spec:registry:auths** 参数。 + +[.admon.note,cols="a"] +|=== +|说明 + +| +harbor 安装文件在 /opt/harbor 目录下，可在该目录下对 harbor 进行运维。 + +|=== +-- + + ++ + +include::../../_custom/installationAndUpgrade/installationAndUpgrade-oper-editHosts_v4.adoc[] + +== 安装 Kubernetes + +// Note +include::../../../_ks_components/admonitions/note.adoc[] + +* 如果您已有可用的 Kubernetes 集群，可跳过此步骤。 + +* 安装包中集成了 CentOS 7、Ubuntu 18.04、Ubuntu 20.04、Ubuntu 22.04 依赖包，如使用这些操作系统需要使用 kk 自动安装系统依赖，可在安装命令后添加 --with-packages ; 如使用这些操作系统之外的操作系统或由于依赖问题导致失败，需手动安装相关依赖（conntrack）。 + +* 如需使用 openebs localpv，可在如下命令后添加参数 --with-local-storage，如需对接其他存储，可在配置文件 addons 中添加配置相关存储插件，或 Kubernetes 集群部署完成后自行安装。 + +* 如使用 kk 部署的 harbor，请确保安装 Kubernetes 之前，已创建 harbor 项目，且配置文件 config-sample.yaml 中已配置 spec:registry:auths 参数。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] + +执行以下命令创建 Kubernetes 集群： + +include::../../_custom/installationAndUpgrade/installationAndUpgrade-startInstallationOffline.adoc[] + +如果显示如下信息，则表明 Kubernetes 集群创建成功。 + +[,yaml] +---- +Pipeline[CreateclusterPipeline] execute successfully +Installation is complete. +---- + + +== 导入镜像到私有镜像仓库 + +执行以下命令将镜像导入到指定的私有镜像仓库中。 + +[,bash] +---- +./kk artifact images push -f config-sample.yaml -a kubekey-artifact.tar.gz +---- + +如果显示如下信息，则表明导入成功。 + +[,yaml] +---- +Pipeline[ArtifactImagesPushPipeline] execute successfully +---- + +== 安装{ks_product_left} + +=== 步骤 1：部署 ks-core + +. 在集群节点，执行以下命令安装 KubeSphere Core。 ++ +==== +[,bash] +---- +helm upgrade --install -n kubesphere-system --create-namespace ks-core charts/ks-core \ +--debug \ +--wait \ +--set cloud.enabled=false \ +--set upgrade.enabled=false \ +--set global.imageRegistry=dockerhub.kubekey.local/kse \ +--set extension.imageRegistry=dockerhub.kubekey.local/kse +---- + +[.admon.attention,cols="a"] +|=== +|注意 + +| +将 **global.imageRegistry** 和 **extension.imageRegistry** 的默认地址 **dockerhub.kubekey.local/kse** 替换为您的实际镜像仓库地址。 +|=== + +取决于您的硬件和网络环境，您可能需要配置流量转发规则并在防火墙中放行 30880 端口。如果显示如下信息，则表明 ks-core 安装成功： + +[,yaml] +---- +NOTES: +Thank you for choosing KubeSphere Helm Chart. + +Please be patient and wait for several seconds for the KubeSphere deployment to complete. + +1. Wait for Deployment Completion + + Confirm that all KubeSphere components are running by executing the following command: + + kubectl get pods -n kubesphere-system + +2. Access the KubeSphere Console + + Once the deployment is complete, you can access the KubeSphere console using the following URL: + + http://192.168.6.10:30880 + +3. Login to KubeSphere Console + + Use the following credentials to log in: + + Account: admin + Password: P@88w0rd + +NOTE: It is highly recommended to change the default password immediately after the first login. + +For additional information and details, please visit https://kubesphere.io. +---- +==== + +. 从成功信息中的 **Console**、**Account** 和 **Password** 参数分别获取{ks_product_left} Web 控制台的 IP 地址、管理员用户名和管理员密码，并使用网页浏览器登录{ks_product_left} Web 控制台。 ++ +[.admon.note,cols="a"] +|=== +|说明 + +| +此时，{ks_product_right} Web 控制台仅提供{ks_product_both}的核心功能，若要使用扩展组件，还需继续执行以下 2 个步骤以便安装扩展组件。 +|=== + +=== 步骤 2：发布扩展组件 + +执行以下命令，将{ks_product_both}提供的所有扩展组件导入到 Web 控制台的扩展中心。 + +[,bash] +---- +helm template -n kubesphere-system charts/kse-extensions-publish --set museum.enabled=true,global.imageRegistry=dockerhub.kubekey.local/kse | kubectl apply -f - +---- + +如果显示如下信息，则表明扩展组件发布成功。 + +image:/images/ks-qkcp/zh/v4.1/verify-extension-release.png[verify-extension-release, 100%] + +=== 步骤 3：部署扩展组件 + +发布扩展组件后，登录{ks_product_left} Web 控制台，可在扩展中心查看并安装扩展组件。或者，按照以下步骤快速部署扩展组件。 + +// . 若要安装可观测相关扩展组件，需要先部署 vector（WhizardTelemetry 数据流水线）和 whizard-monitoring（WhizardTelemetry 监控） +// 扩展组件。否则，可跳过此步骤。 +// + +// -- +// [,bash] +// ---- +// # 安装 vector 和 whizard-monitoring +// kubectl apply -f kse-extensions/vector-installplan.yaml +// kubectl apply -f kse-extensions/whizard-monitoring-installplan.yaml + +// # 检查 vector 和 whizard-monitoring 的安装状态，等待状态变为 Installed +// kubectl get installplan vector -w +// kubectl get installplan whizard-monitoring -w +// ---- +// -- + +// . 如需安装 Spring Cloud 扩展组件，可提前安装。否则，可跳过此步骤。 +// + +// -- +// [.admon.attention,cols="a"] +// |=== +// |注意 + +// | +// Spring Cloud 启动较慢，且包含聚合 API，因此 Spring Cloud 完全启动前会导致需要连接 kube-apiserver 的 Pod 异常，建议提前安装。 + +// |=== + +// [,bash] +// ---- +// # 安装 springcloud +// kubectl apply -f kse-extensions/springcloud-installplan.yaml + +// # 检查 springcloud 运行状态，确保 spring-cloud-controller-manager 和 springcloud-agent-nacos 为 running 状态 +// kubectl get pod -n extension-springcloud +// ---- +// -- + +. 执行以下命令，安装指定扩展组件或所有扩展组件。 ++ +-- +[,bash] +---- +# 安装指定扩展组件，请将 {EXTENSION-NAME} 替换为实际名称 +kubectl apply -f kse-extensions/{EXTENSION-NAME}-installplan.yaml + +# 安装所有扩展组件 +kubectl apply -f kse-extensions +---- + +[.admon.note,cols="a"] +|=== +|说明 + +| +* 在{ks_product_both}安装包的 kse-extensions 目录下获取各个扩展组件的 `{EXTENSION-NAME}`，也可参考下图获取。 +* 请参阅《{ks_product_right}安装指南》的“升级{ks_product_both}”章节，查看组件清单，了解更多信息。 +|=== + +[.admon.attention,cols="a"] +|=== +|注意 + +| +对于已修改扩展组件配置的扩展组件，请勿重新执行 `kubectl apply -f kse-extensions/{EXTENSION-NAME}-installplan.yaml`，避免扩展组件配置被覆盖。 +|=== +-- + +. 执行以下命令，等待扩展组件状态变更为 **Installed**，则表明部署成功。 ++ +-- +[,bash] +---- +kubectl get installplan -w +---- + +image:/images/ks-qkcp/zh/v4.1/verify-extension-installed.png[ verify-extension-installed,100%] +-- diff --git a/content/zh/docs/v4.1/02-quickstart/02-install-a-demo-extension.adoc b/content/zh/docs/v4.1/02-quickstart/02-install-a-demo-extension.adoc new file mode 100644 index 000000000..338bb976b --- /dev/null +++ b/content/zh/docs/v4.1/02-quickstart/02-install-a-demo-extension.adoc @@ -0,0 +1,65 @@ +--- +title: "安装示例组件" +keywords: "Kubernetes, KubeSphere, 快速入门, 安装组件, 示例, DevOps" +description: "以 DevOps 安装为例，演示如何在 KubeSphere Web 控制台安装组件。" +weight: 02 +--- + +KubeSphere 扩展组件，是运行在 KubeSphere Core 之上，用来扩展并增强 KubeSphere 产品能力，以进一步满足企业各类型的业务需求。 + +// ifeval::["{file_output_type}" == "html"] + +// 本节以安装 DevOps 为例，演示如何在{ks_product_left} Web 控制台安装扩展组件。DevOps 安装完成后，即可在企业空间中创建 DevOps 项目。有关组件使用的更多信息，请参阅link:../../11-use-extensions/[扩展组件使用]章节。 + +// == 前提条件 + +// * 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../05-users-and-roles/01-users/[用户]和link:../../05-users-and-roles/02-platform-roles/[平台角色]。 + +// * 您需要注册一个 KubeSphere 云账号。 + +// == 订阅步骤 + +// . 点击{ks_product_left} Web 控制台左上角的**扩展市场**，进入扩展市场页面。 +// . 搜索查找 DevOps，点击**订阅**。 +// . 如果您未绑定 https://kubesphere.cloud/login/[KubeSphere 云账号]，前往**扩展中心**绑定您的 KubeSphere 云账户，然后进入订阅流程。 +// . 订阅完成后，进入组件安装流程。 +// endif::[] + + +// ifeval::["{file_output_type}" == "pdf"] + +本节以安装 DevOps 为例，演示如何在{ks_product_left} Web 控制台安装扩展组件。DevOps 安装完成后，即可在企业空间中创建 DevOps 项目。有关组件使用的更多信息，请参阅《{ks_product_right}扩展组件使用指南》。 + +== 前提条件 + +* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅《{ks_product_right}用户和角色管理指南》。 + +// endif::[] + +== 安装步骤 + +. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 +. 点击**扩展中心**，查看扩展组件列表。 +. 点击 DevOps 右侧的**安装**按钮，进入组件安装页面。 +. 在组件安装对话框的**版本选择**页签，选择 DevOps 的版本号，并安装好所有必装组件（若有），点击**下一步**。 ++ +include::../../_ks_components/admonitions/note.adoc + +安装检测时，会识别扩展组件是否有依赖组件。依赖组件分为必装组件和选装组件。 + +若必装组件的状态为**未就绪**，您需要先行安装正确版本的必装组件，以确保扩展组件的正常使用。而选装组件不会影响扩展组件的安装。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] + + +. 在**扩展组件安装**页签，修改 DevOps 的配置后（可选），点击**开始安装**即开始安装 DevOps。 ++ +image:/images/ks-qkcp/zh/v4.0/install-extensions.png[,100%] + +. 在**集群选择**页签，根据名称，标识，标签选择集群，可选择多个集群。 + +. 在**差异化配置**页签，分别编辑选中集群的 YAML 配置，也可不修改，使用初始默认配置。点击**确定**，开始配置集群 Agent。 + +安装完成后，默认启用该组件。您可以在扩展中心配置、升级、禁用、卸载扩展组件。 + + diff --git a/content/zh/docs/v4.1/02-quickstart/03-control-user-permissions.adoc b/content/zh/docs/v4.1/02-quickstart/03-control-user-permissions.adoc new file mode 100644 index 000000000..d54ea9855 --- /dev/null +++ b/content/zh/docs/v4.1/02-quickstart/03-control-user-permissions.adoc @@ -0,0 +1,204 @@ +--- +title: "控制用户权限" +keywords: "Kubernetes, {ks_product}, 快速入门, 用户, 权限" +description: "介绍如何创建用户，并使用企业空间、项目和角色控制用户的访问权限。" +weight: 03 +--- + +ifeval::["{file_output_type}" == "html"] +本节介绍如何创建用户，并使用企业空间、项目和角色控制用户的访问权限。有关用户权限控制的更多信息，请参阅link:../../05-users-and-roles/[用户和角色管理]。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +本节介绍如何创建用户，并使用企业空间、项目和角色控制用户的访问权限。有关用户权限控制的更多信息，请参阅《{ks_product_right}用户和角色管理指南》。 +endif::[] + +作为多租户系统，{ks_product_right}支持在平台、集群、企业空间和项目级别基于角色对用户的权限进行控制，实现逻辑层面的资源隔离。 + + +== 前提条件 + +您需要准备一个 Kubernetes 集群，并已安装{ks_product_left}。 + +== 创建用户 + +. 使用默认用户 **admin** 和密码 **P@88w0rd** 登录{ks_product_left} Web 控制台。 ++ +-- +// Note +include::../../../_ks_components/admonitions/note.adoc[] + +为了您的账户安全，首次登录时系统会提示您修改密码。密码修改后，后续请使用新密码登录。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +. 点击**用户和角色管理**。 + +. 在左侧导航栏，选择**用户**。 + +. 在用户列表页面，点击**创建**。 + +. 在**创建用户**对话框，输入以下必填参数： ++ +-- +* **用户名**：用户的名称。 +* **邮箱**：用户的邮箱地址。 +* **密码**：用户的密码。 +-- ++ +. 点击**确定**。用户创建后将显示在用户列表中。 + + +== 创建企业空间 + +. 登录{ks_product_left} Web 控制台。 +. 点击**企业空间管理**，点击**创建**。 +. 在**创建企业空间**的**基本信息**页面，输入企业空间的名称（例如 **demo-workspace**）。 ++ +-- +// Note +include::../../../_ks_components/admonitions/note.adoc[] + +对于多集群环境，设置企业空间的基本信息后，点击**下一步**。在**集群设置**页面，选择企业空间需要使用的集群。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] +-- ++ +. 点击**确定**。企业空间创建后将显示在企业空间列表中。 + + +== 创建企业空间角色 + +. 在企业空间列表页面，点击企业空间的名称 **demo-workspace** 进入该企业空间。 + +. 在左侧导航栏，选择**企业空间设置** > **企业空间角色**。 ++ +-- +企业空间角色列表页面默认列出以下四个内置角色。 +[%header,cols="1a,2a"] +|=== +|角色 |描述 + +|**workspace-viewer** +|企业空间观察员，可以查看企业空间中的所有资源。 +|**workspace-self-provisioner** +|企业空间普通成员，可以查看企业空间设置、管理应用模板、创建项目。 +|**workspace-regular** +|企业空间普通成员，可以查看企业空间设置。 +|**workspace-admin** +|企业空间管理员，可以管理企业空间中的所有资源。 +|=== + +// Note +include::../../../_ks_components/admonitions/note.adoc[] + +企业空间内置角色的名称以 <企业空间名称>-<角色名称> 格式显示。例如，在名称为 **demo-workspace** 的企业空间中，角色 **admin** 的实际角色名称为 **demo-workspace-admin**。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] +-- ++ +. 在企业空间角色列表页面，点击**创建**。 + +. 在**创建企业空间角色**对话框，输入**名称**，然后点击**编辑权限**继续。 + +. 在**编辑权限**对话框，权限归类在不同的**功能模块**下。 ++ +-- +在本示例中，点击**项目管理**，并为该角色选择**项目创建**、**项目管理**和**项目查看**。 + +// Note +include::../../../_ks_components/admonitions/note.adoc[] + +**依赖于**表示当前授权项依赖所列出的授权项，勾选该权限后系统会自动选上所有依赖权限。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] +-- ++ +. 点击**确定**。新创建的角色将显示在企业空间角色列表中。 + + +== 邀请用户到企业空间 + +. 在左侧导航栏，选择**企业空间设置** > **企业空间成员**。 + +. 在企业空间成员列表页面，点击**邀请**。 + +. 在**邀请成员**对话框，点击用户右侧的image:/images/ks-qkcp/zh/icons/add-dark.svg[add,18,18]并为用户分配在当前企业空间中的角色。 + +. 点击**确定**。用户被邀请后将显示在企业空间成员列表中。 + + +== 创建项目 + +. 在左侧导航栏，选择**项目**。 + +. 在**项目**页签，点击**创建**。 + +. 在**创建项目**对话框，输入项目的**名称**（例如 **demo-project**）。 ++ +-- +// Note +include::../../../_ks_components/admonitions/note.adoc[] + +对于多集群环境，您需要选择要创建项目的集群。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] +-- ++ +. 点击**确定**。项目创建后将显示在项目列表中。 + + +== 创建项目角色 + +. 在**项目**页签，点击项目的名称 **demo-project** 进入该项目。 + +. 在左侧导航栏，选择**项目设置** > **项目角色**。 ++ +-- +项目角色页面默认列出以下三个内置角色。 + +[%autowidth] +|=== +|角色 |描述 + +|**viewer** +|项目观察员，可以查看项目中的所有资源。 + +|**operator** +|项目管理员，可以管理项目中除用户和角色之外的资源。 + +|**admin** +|项目管理员，可以管理项目中的所有资源。 +|=== +-- ++ +. 在项目角色列表页面，点击**创建**。 + +. 在**创建角色**对话框，输入**名称**，然后点击**编辑权限**继续。 + +. 在**编辑权限**对话框，权限归类在不同的**功能模块**下。 ++ +-- +在本示例中，点击**访问控制**，并为该角色选择**成员查看**和**角色查看**。 + +// Note +include::../../../_ks_components/admonitions/note.adoc[] + +**依赖于**表示当前授权项依赖所列出的授权项，勾选该权限后系统会自动选上所有依赖权限。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] +-- ++ +. 点击**确定**。新创建的角色将显示在项目角色列表中。 + + +== 邀请用户到项目 + +. 在左侧导航栏，选择**项目设置** > **项目成员**。 + +. 在项目成员列表页面，点击**邀请**。 + +. 在**邀请成员**对话框，点击用户右侧的image:/images/ks-qkcp/zh/icons/add-dark.svg[add,18,18]并为用户分配在当前项目中的角色。 + +. 点击**确定**。用户被邀请后将显示在项目成员列表中。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/02-quickstart/04-change-display-language.adoc b/content/zh/docs/v4.1/02-quickstart/04-change-display-language.adoc new file mode 100644 index 000000000..9e65d3cee --- /dev/null +++ b/content/zh/docs/v4.1/02-quickstart/04-change-display-language.adoc @@ -0,0 +1,33 @@ +--- +title: "修改界面语言" +keywords: "Kubernetes, {ks_product}, 集群管理, Web 控制台, 修改语言" +description: "介绍如何修改当前用户的界面语言。" +weight: 04 +--- + +本节介绍如何修改{ks_product_left} Web 控制台的界面语言。 + +== 前提条件 + +已获取{ks_product_left} Web 控制台的用户名和密码。 + +== 操作步骤 + +. 登录{ks_product_left} Web 控制台。 + +. 在页面右上角点击当前用户名，然后在下拉列表中选择**用户设置**。 + +. 在**基本信息**页签设置用户的邮箱和语言。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|邮箱 +|用户的邮箱地址。邮箱地址可用于登录{ks_product_left} Web 控制台。 + +|语言 +|{ks_product_right} Web 控制台对当前用户显示的语言。当前支持简体中文和繁体中文。 +|=== +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/02-quickstart/_index.adoc b/content/zh/docs/v4.1/02-quickstart/_index.adoc new file mode 100644 index 000000000..3e3a9d8ec --- /dev/null +++ b/content/zh/docs/v4.1/02-quickstart/_index.adoc @@ -0,0 +1,40 @@ +--- +title: "快速入门" +keywords: "Kubernetes, {ks_product}, 快速入门" +description: "介绍如何安装{ks_product_both}和扩展组件，以及如何进行访问控制。" +weight: 02 +--- + +本节简要介绍如何安装{ks_product_both}和扩展组件，以及如何控制用户权限，帮助您快速了解使用{ks_product_left}。 + +有关{ks_product_both}安装和使用的更多信息，请参阅文档的其他章节。 + +ifeval::["{file_output_type}" == "pdf"] +== 产品版本 + +本文档适用于{ks_product_left} v4.1.0 版本。 + +== 读者对象 + +本文档主要适用于以下读者： + +* {ks_product_right}用户 + +* 交付工程师 + +* 运维工程师 + +* 售后工程师 + + +== 修订记录 + +[%header,cols="1a,1a,3a"] +|=== +|文档版本 |发布日期 |修改说明 + +|01 +|{pdf_releaseDate} +|第一次正式发布。 +|=== +endif::[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/01-supported-k8s.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/01-supported-k8s.adoc new file mode 100644 index 000000000..20f0f3686 --- /dev/null +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/01-supported-k8s.adoc @@ -0,0 +1,415 @@ +--- +title: "环境要求" +keywords: "Kubernetes, {ks_product}, 组件,支持矩阵" +description: "介绍{ks_product_both}的环境要求。" +weight: 01 +--- + + +本节介绍{ks_product_both}的环境要求。 + +== 系统要求 + +[%header,cols="3a,4a,4a"] +|=== +|系统 |最低要求（每个节点）| 生产环境要求（每个节点） + +|Ubuntu 16.04，18.04，20.04，22.04 +|CPU：2 核，内存：4 GB，硬盘：40 GB +|CPU：8 核，内存：16 GB，硬盘：200 GB + +|Debian Buster，Stretch +|CPU：2 核，内存：4 GB，硬盘：40 GB +|CPU：8 核，内存：16 GB，硬盘：200 GB + +|CentOS 7.x，CentOS Stream +|CPU：2 核，内存：4 GB，硬盘：40 GB +|CPU：8 核，内存：16 GB，硬盘：200 GB + +|Red Hat Enterprise Linux 7.x，8.x +|CPU：2 核，内存：4 GB，硬盘：40 GB +|CPU：8 核，内存：16 GB，硬盘：200 GB + +|SUSE Linux Enterprise Server 15/openSUSE Leap 15.2 +|CPU：2 核，内存：4 GB，硬盘：40 GB +|CPU：8 核，内存：16 GB，硬盘：200 GB +|=== + +== 依赖项要求 + +[%header,cols="1a,4a,4a"] +|=== +|依赖项 |Kubernetes 版本 ≥ 1.18|Kubernetes 版本 < 1.18 + +|socat +|必须 +|可选，但建议安装 + +|conntrack +|必须 +|可选，但建议安装 + +|ebtables +|可选，但建议安装 +|可选，但建议安装 + +|ipset +|可选，但建议安装 +|可选，但建议安装 +|=== + +== 容器运行时要求 + +[%header,cols="4a,4a"] +|=== +|支持的容器运行时 |版本 + +|Docker +|20.10.0+。 + +|containerd +|最新版。 + +|CRI-O（试验版，未经充分测试） +|最新版 + +|iSula（试验版，未经充分测试） +|最新版 +|=== + +== 网络要求 + +* 请确保 **/etc/resolv.conf** 中的 DNS 地址可用，否则，可能会导致集群中的 DNS 出现问题。 + +* 如果您的网络配置使用防火墙规则或安全组，请务必确保基础设施组件可以通过特定端口相互通信。建议您关闭防火墙。 + +* 支持的 CNI 插件：Calico 和 Flannel。其他插件也适用（例如 Cilium 和 Kube-OVN 等），但请注意它们未经充分测试。 + +== 端口要求 + +某些端口需要用于服务之间的通信。如果您的网络配置有防火墙规则，则需要确保基础设施组件可以通过特定端口相互通信。这些端口用作某些进程或服务的通信端点。 + +[%header,cols="2a,2a,2a,2a,2a,3a"] +|=== +|服务 +|协议 +|行为 +|起始端口 +|结束端口 +|备注 + +|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 +|离线环境需要 + +|local-apt +|TCP +|allow +|5080 +|N/A +|离线环境需要 + +|rpcbind +|TCP +|allow +|111 +|N/A +|使用 NFS 时需要 + +|ipip +|IPENCAP / IPIP +|allow +|N/A +|N/A +|Calico 需要使用 IPIP 协议 + +|metrics-server +|TCP +|allow +|8443 +|N/A +|N/A +|=== + +== 组件支持矩阵 + +{ks_product_right} v4.1.0 默认支持 Kubernetes v1.21~1.28。本节详细介绍{ks_product_both}各组件支持的 Kubernetes 版本。为避免使用过程中出现兼容性问题，请使用支持的 Kubernetes 版本。 + +[%header,cols="2a,3a,5a"] +|=== +|组件 |组件版本 |支持的 Kubernetes 版本 + +|ks-core +|4.1.x +|1.21~1.28 + +|DevOps +|4.1.0 +|1.21~1.28 + +|Storage-utils +|1.0.x +|1.21~1.28 + +|Vector +|1.0.0 +|1.21~1.28 + +|OpenSearch +|2.11.1 +|1.21~1.28 + +|Monitoring +|1.0.0 +|1.21~1.28 + +|Logging +|1.0.0 +|1.21~1.28 + +|Auditing +|1.0.0 +|1.21~1.28 + +|Events +|1.0.0 +|1.21~1.28 + +|Alerting +|1.0.0 +|1.21~1.28 + +|WhizardTelemetry 平台服务 +|1.0.0 +|1.21~1.28 + +|WhizardTelemetry 事件告警 +|1.0.0 +|1.21~1.28 + +|Notification +|2.5.1 +|1.21~1.28 + +|MetricServer +|0.7.0 +|1.21~1.28 + +|Tower +|1.0.x +|1.21~1.28 + +|OpenPitrix +|2.0.0 +|1.21~1.28 + +|KubeFed +|1.0.x +|1.21~1.28 + +|Gateway +|1.0.x +|1.22~1.25 + +|ServiceMesh +|1.0.x +|1.22~1.25 + +|KubeEdge +|1.31.1 +|1.21-1.23 + +|RadonDB DMP +|2.1.0 +| +* DMP 管理平台: 1.21~1.28 +* MySQL: 1.21~1.28 +* PostgreSQL: 1.21~1.28 +* Redis Cluster: 1.21~1.28 +* Redis Sentinel: 1.21~1.28 +* MongoDB: 1.21~1.28 +* OpenSearch: 1.21~1.28 +* Kafka: 1.21~1.28 +* RabbitMQ: 1.21~1.28 + +|SpringCloud +|1.0.x +|1.21~1.28 + +|Gatekeeper +|1.0.x +|1.21~1.28 + +|Network +|1.0.0 +|1.21~1.28 +|=== + +== 组件架构支持矩阵 + +[%header,cols="2a,3a,5a"] +|=== +|组件 |组件版本 |支持的架构 + +|ks-core +|4.1.x +|amd64、arm64 + +|DevOps +|4.1.0 +|amd64、arm64 + +|Storage-utils +|1.0.x +|amd64、arm64 + +|Vector +|1.0.0 +|amd64、arm64 + +|OpenSearch +|2.11.1 +|amd64、arm64 + +|Monitoring +|1.0.0 +|amd64、arm64 + +|Logging +|1.0.0 +|amd64、arm64 + +|Auditing +|1.0.0 +|amd64、arm64 + +|Events +|1.0.0 +|amd64、arm64 + +|Alerting +|1.0.0 +|amd64、arm64 + +|WhizardTelemetry 平台服务 +|1.0.0 +|amd64、arm64 + +|WhizardTelemetry 事件告警 +|1.0.0 +|amd64、arm64 + +|Notification +|2.5.1 +|amd64、arm64 + +|MetricServer +|0.7.0 +|amd64、arm64 + +|Tower +|1.0.x +|amd64、arm64 + +|OpenPitrix +|2.0.0 +|amd64、arm64 + +|KubeFed +|1.0.x +|amd64、arm64 + +|Gateway +|1.0.x +|amd64、arm64 + +|ServiceMesh +|1.0.x +|amd64、arm64 + +|KubeEdge +|1.31.1 +|amd64、arm64 + +|RadonDB DMP +|2.1.0 +|amd64 + +|SpringCloud +|1.0.x +|amd64、arm64 + +|Gatekeeper +|1.0.x +|amd64、arm64 + +|Network +|1.0.0 +|amd64、arm64 +|=== \ No newline at end of file diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/03-configure-high-availability.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/03-configure-high-availability.adoc new file mode 100644 index 000000000..f23e91d95 --- /dev/null +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/03-configure-high-availability.adoc @@ -0,0 +1,380 @@ +--- +title: "配置高可用性" +keywords: "Kubernetes, {ks_product}, 安装, 准备, 高可用" +description: "介绍如何在生产环境中为{ks_product_both}集群配置多个控制平面节点，以防止单个控制平面节点故障时集群服务中断，从而实现高可用性。" +weight: 03 +--- + + +本节介绍如何在生产环境中为{ks_product_both}集群配置多个控制平面节点，以防止单个控制平面节点故障时集群服务中断，从而实现高可用性。如果您的{ks_product_both}集群没有高可用性需求，您可以跳过本节。 + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +{ks_product_right}高可用性配置仅支持同时安装 Kubernetes 和{ks_product_both}的场景。如果您在现有的 Kubernetes 集群上安装{ks_product_left}，{ks_product_right}安装完成后将使用 Kubernetes 集群现有的高可用性配置。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] + +本节介绍以下高可用性配置方式： + +* 使用本地负载均衡配置。您可以在安装{ks_product_both}的过程中，设置 KubeKey 工具在工作节点上安装 HAProxy 作为各控制平面节点的反向代理，所有工作节点的 Kubernetes 组件将通过 HAProxy 连接各控制平面节点。这种方式需要额外的健康检查机制，所以相较其他方式运行效率有所降低，但可以用于没有专用负载均衡器且服务器数量有限的场景。 + +* 使用专用负载均衡器。您可以使用云环境提供的负载均衡器作为各控制平面节点的反向代理。这种方式要求{ks_product_both}集群安装在云环境中，并且云环境可以提供专用负载均衡器。 + +* 使用通用服务器作为负载均衡器。您可以在集群节点以外的 Linux 服务器上安装 Keepalived 和 HAProxy 作为负载均衡器。这种方式需要至少 2 台额外的 Linux 服务器。 + +== 使用本地负载均衡配置 + +如需使用 HAProxy 实现高可用性，只需要在安装{ks_product_both}时在安装配置文件 **config-sample.yaml** 中设置以下参数： + +// YAML +include::../../../../_ks_components/code/yaml.adoc[] + +spec: + controlPlaneEndpoint: + internalLoadbalancer: haproxy + domain: lb.kubesphere.local + address: "" + port: 6443 + +---- + +KubeKey 将自动在工作节点上安装 HAProxy 并完成高可用配置，您无需进行其他操作。有关更多信息请参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere 企业版]。 + +== 使用专用负载均衡器 +如需使用云环境提供的专用负载均衡器实现高可用性，您需要在云环境中进行以下操作： + +. 在云环境中创建一台至少包含两个副本的负载均衡器。 + +. 设置负载均衡器监听{ks_product_both}集群各控制平面节点的 6443 端口。 + +. 获取负载均衡器的 IP 地址，供后续安装{ks_product_both}时使用。 + +有关具体操作，请参阅云环境的用户指南或联系您的云服务提供商。 + +== 使用通用服务器作为负载均衡器 +以下介绍如何使用 Keepalived 和 HAProxy 将通用服务器配置成负载均衡器。 + + +=== 前提条件 + +* 您需要准备 2 台与集群节点属于同一私有网络的 Linux 服务器，用作负载均衡器。 + +* 您需要准备一个虚拟 IP 地址（VIP）用作 2 台负载均衡器服务器的浮动 IP 地址。该地址不应被其他设备或组件占用以免出现地址冲突。 + + +=== 配置高可用性 + +. 登录用作负载均衡器的服务器，执行以下命令安装 HAProxy 和 Keepalived（以下以 Ubuntu 操作系统为例，在其他操作系统中请将 **apt** 替换为操作系统对应的软件包管理工具）： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +apt install keepalived haproxy psmisc -y + +---- +-- + +. 执行以下命令编辑 HAProxy 的配置文件： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +vi /etc/haproxy/haproxy.cfg + +---- +-- + +. 在 HAProxy 的配置文件中添加以下信息并保存文件（将 替换为{ks_product_both}集群各控制平面节点的私网 IP 地址）： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +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 + +---- +-- + +. 执行以下命令重启 HAProxy： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +systemctl restart haproxy + +---- +-- + +. 执行以下命令设置 HAProxy 开机后自动运行： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +systemctl enable haproxy + +---- +-- + +. 执行以下命令编辑 Keepalived 的配置文件： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +vi /etc/keepalived/keepalived.conf + +---- +-- + +. 在 Keepalived 的配置文件中添加以下信息并保存文件： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +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 + } +} + +---- + +将以下参数替换为实际值： + +[%header,cols="1a,2a"] +|=== +|参数 |描述 + +| +|当前负载均衡器的网卡名称。 + +| +|当前负载均衡器的 IP 地址。 + +| +|另一台负载均衡器的 IP 地址。 + +| +|用作浮动 IP 地址的虚拟 IP 地址。 +|=== +-- + +. 执行以下命令重启 Keepalived： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +systemctl restart keepalived + +---- +-- + +. 执行以下命令设置 Keepalived 开机后自动运行： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +systemctl enable keepalived + +---- +-- + +. 重复以上步骤在另一台负载均衡器服务器上安装、配置 HAProxy 和 Keepalived。 + +. 记录浮动 IP 地址，供后续安装{ks_product_both}时使用。 + + +=== 验证高可用性 + +. 登录第一台负载均衡器服务器并执行以下命令查看浮动 IP 地址： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +ip a s + +---- + +如果系统高可用性正常，命令回显中将显示已配置的浮动 IP 地址。例如，在以下命令回显中，**inet 172.16.0.10/24 scope global secondary eth0** 表明浮动 IP 地址已与 eth0 网卡绑定： + +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +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 + +---- +-- + +. 执行以下命令模拟当前负载均衡器服务器故障： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +systemctl stop haproxy + +---- +-- + +. 执行以下命令再次检查浮动 IP 地址： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +ip a s + +---- + +如果系统高可用性正常，命令回显中将不再显示浮动 IP 地址，如以下命令回显所示： + +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +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 + +---- +-- + +. 登录另一台负载均衡器服务器，执行以下命令查看浮动 IP 地址： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +ip a s + +---- + +如果系统高可用性正常，命令回显中将显示已配置的浮动 IP 地址。例如，在以下命令回显中，**inet 172.16.0.10/24 scope global secondary eth0** 表明浮动 IP 地址已与 eth0 网卡绑定： + +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +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 + +---- +-- + +. 在第一台负载均衡器服务器上执行以下命令恢复运行 HAProxy： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +systemctl start haproxy + +---- +-- diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/01-configure-storage-devices-on-cloud.adoc b/content/zh/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..67ec52078 --- /dev/null +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/01-configure-storage-devices-on-cloud.adoc @@ -0,0 +1,92 @@ +--- +title: "配置云上存储设备" +keywords: "Kubernetes, {ks_product}, 安装, 准备, 持久化存储, 云上存储设备" +description: "介绍如何在生产环境中为{ks_product_both}集群配置云上存储设备。" +weight: 01 +--- + + +本节介绍如何在生产环境中为{ks_product_both}配置云上存储设备。 + +您可以在云环境中创建 API 密钥，并设置{ks_product_both}使用 API 密钥通过容器存储接口（CSI）与云环境对接。用户在{ks_product_both}平台上创建卷并将卷挂载到容器组时，{ks_product_right}将自动在云环境中创建存储设备供容器组使用。以下以青云QingCloud 为例介绍具体操作。有关其他云环境中的操作，请参阅云环境的用户指南或联系您的云服务提供商。 + + +== 前提条件 + +您需要获取一个青云QingCloud 帐户，并确保帐户余额可以创建所需的存储设备。有关更多信息，请访问link:https://www.qingcloud.com/[青云QingCloud 官网]。 + + +== 操作步骤 + +. 登录link:https://www.qingcloud.com/[青云QingCloud] 控制台，点击页面右上角的用户名，然后在下拉列表中选择 **API 密钥**。 + +. 在 **API 密钥**页面，点击**创建**。 + +. 在**创建API密钥**对话框，设置密钥的名称，然后点击**提交**。 + +. 在弹出的对话框将私钥文件下载到本地。 ++ +-- +// Warning +include::../../../../../_ks_components/admonitions/warning.adoc[] + +{ks_product_right}将使用该私钥与云上的存储设备对接。请妥善保存该私钥文件以避免用户数据泄露。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +. 在 API 密钥列表中获取 API 密钥的 ID。 + +. 登录用于执行{ks_product_both}安装操作的集群节点，执行以下命令创建存储插件配置文件： ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +vi csi-qingcloud.yaml + +---- +-- + +. 将以下信息添加到配置文件中，并保存文件供后续安装{ks_product_both}时使用： ++ +-- +// YAML +include::../../../../../_ks_components/code/yaml.adoc[] + +config: + qy_access_key_id: "" + qy_secret_access_key: "" + zone: "" +sc: + isDefaultClass: true + +---- + +将以下参数替换为实际值： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +| +|API 密钥的 ID。 + +| +|API 密钥的私钥文本。 + +| +| +云环境的可用区 ID。可用区 ID 将决定{ks_product_both}创建的存储设备所在的区域。ID 取值和可用区的对应关系如下： + +* **sh1a/sh1b**：上海 1 区-A/上海 1 区-B + +* **pek3a/pek3b/pek3c/pek3d**：北京 3 区-A/北京 3 区-B/北京 3 区-C/北京 3 区-D + +* **gd2a/gd2b**：广东 2 区-A/广东 2 区-B + +* **ap2a**：亚太 2 区-A +|=== + +以上配置文件仅包含必须设置的参数。如需设置其他参数，请参阅 link:https://github.com/kubesphere/helm-charts/tree/master/src/test/csi-qingcloud#configuration[QingCloud CSI 配置]。 +-- diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/04-configure-neosan-csi.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/04-configure-neosan-csi.adoc new file mode 100644 index 000000000..52f4b6643 --- /dev/null +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/04-configure-neosan-csi.adoc @@ -0,0 +1,331 @@ +--- +title: "配置 NeonSAN CSI" +keywords: "Kubernetes, {ks_product}, 安装, 准备, 持久化存储, 网络文件系统, NeonSAN CSI" +description: "介绍如何在生产环境中为{ks_product_both}集群配置 NeonSAN CSI。" +weight: 04 +--- + + + +NeonSAN 是青云的一款企业级分布式块存储系统，NeonSAN CSI 是 NeonSAN 团队面向 Kubernetes 提供的存储插件，具有在 Kubernetes 平台上动态创建持久存储卷的能力。 + +本节介绍如何在生产环境中为{ks_product_both}集群配置 NeonSAN CSI。 + + +== 前提条件 + +- 您已经成功部署 NeonSAN v2.2.0 及以上版本，且容器集群的每个节点都已安装 QBD 与 NeonSAN 连通。具体操作请咨询 KubeSphere 企业版技术支持人员。 +- 您已经安装 Kubernetes v1.16 及其以上版本。 +- 您已经在容器集群的 master 节点安装了 Helm。本节以 Helm 3 为例。 + + +== 操作步骤 + + +=== 在线安装 NeonSAN CSI + +在线安装适用于容器集群能够访问外网的情况。 + +. 执行以下命令添加 Helm 仓库，如 https://charts.kubesphere.io/test。 ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +$ helm repo add ks-test https://charts.kubesphere.io/test +"ks-test" has been added to your repositories + +---- +-- + +. 执行以下命令查看仓库是否添加成功。 ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +$ helm repo list +NAME        URL +ks-test     https://charts.kubesphere.io/test + +---- +-- + +. 执行以下命令更新仓库的 Chart 列表。 ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +$ helm repo update + +---- +-- + +. 执行以下命令在仓库中查找 NeonSAN CSI 的安装包。 ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +$ 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 + +---- +-- + +. 查看 Master 节点上安装的 qbd 版本。 ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +$ 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 + +---- +-- + +. 执行以下命令安装 NeonSAN CSI。根据 Master 节点操作系统上安装的 qbd 版本，设置参数 **driver.repository**，例如如果查询到的 qbd 版本为 2.2.0，则命令里的参数为 **driver.repository="csiplugin/csi-neonsan-qbd2.2.0"**。 ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +$ 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 + +---- +-- + +. 执行以下命令检查 NeonSAN CSI 是否安装成功。 ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +$ 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 + +---- +-- + +. 检查 pod 是否在 Running 状态。 ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +$ 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 + +---- +-- + +. 检查是否所有 NeonSAN CSI 组件运行正常。 ++ +==== +* 当 **READY** 取值等于 **AVAILABLE** 取值时，csi-neonsan-controller 正常。 ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +$ 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 + +---- +-- + +* 当 **DESIRED** 取值等于 **READY** 和 **AVAILABLE** 取值时，csi-neonsan-node 正常。 ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +$ 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 + +---- +-- +==== + +. 检查存储类是否安装。 ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +$ kubectl get storageclass +NAME              PROVISIONER                            RECLAIMPOLICY   VOLUMEBINDINGMODE      ALLOWVOLUMEEXPANSION   AGE +csi-neonsan       neonsan.csi.qingstor.com               Delete          Immediate              true                   2m56s + +---- +-- + +. 查看存储类所使用的存储池。此存储池必须在 NeonSAN 中存在, 否则无法使用此存储类创建存储卷。 ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +$ kubectl get storageclass csi-neonsan -o yaml | grep pool_name +pool_name: kube + +---- +-- + +. 登陆 NeonSAN 服务器, 查看存储类所使用的存储池是否存在，如不存在，请使用 **neonsan create_pool** 命令创建存储池。 ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +$ neonsan list_pool -pool kube -detail +Pool Count:  1 ++----------+------+---------------------------+ +|    ID    | NAME |       CREATED TIME        | ++----------+------+---------------------------+ +| 33554432 | kube | 2020-08-07T14:53:52+08:00 | ++----------+------+---------------------------+ + +---- +-- + + +=== 离线安装 NeonSAN CSI + +离线安装适用于容器集群无法访问外网的情况。 + +. 在本机上，下载 NeonSAN CSI 安装包，并安装包拷贝至集群 Master 节点。 + ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +$ 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 + +---- +-- + +. 执行以下命令查看 NeonSAN CSI 所需要的所有镜像文件。 ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +$ 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 + +---- +-- + +. 使用 Docker 将所有镜像下载到本地并打包，或上传至内网仓库（如 harbor）中。 ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +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 +include::../../../../../_ks_components/code/bash.adoc[] + +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 + +---- +-- + +. 执行以下命令将镜像包上传至集群所有节点的目录，如 **/tmp** 目录下，解压并安装。 ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +$ scp neonsan-csi-images.tar user@node1:/tmp/ +scp neonsan-csi-images.tar user@node2:/tmp/ +... +---- + +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +$ tar -xvf /tmp/neonsan-csi-images.tar -C / + +---- +-- + +. 执行以下命令检查安装是否完成。如果您看到所有的 NeonSAN CSI 镜像已经在列表中，那么说明安装成功。 ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +$ docker images + +---- +-- + +. 参考link:#_在线安装_neonsan_csi[在线安装]中步骤 8 - 12 执行安装后检查。 ++ +-- +NeonSAN CSI 安装成功后，您可以在 KubeSphere 企业版控制台上的**存储**区域查看。 +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/05-configure-nfs.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/05-configure-nfs.adoc new file mode 100644 index 000000000..5d19b7391 --- /dev/null +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/05-configure-nfs.adoc @@ -0,0 +1,206 @@ +--- +title: "配置 NFS" +keywords: "Kubernetes, {ks_product}, 安装, 准备, 持久化存储, 网络文件系统, NFS" +description: "介绍如何在生产环境中为{ks_product_both}集群配置网络文件系统（NFS）。" +weight: 05 +--- + + +本节介绍如何在生产环境中为{ks_product_both}集群配置网络文件系统（NFS）。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +NFS 与部分应用不兼容（例如 Prometheus），可能会导致容器组创建失败。如果确实需要在生产环境中使用 NFS，请确保您了解相关风险或咨询 KubeSphere 技术支持 support@kubesphere.cloud。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + +== 搭建 NFS 服务端 + +为{ks_product_both}配置 NFS 前，您需要先搭建 NFS 服务端。如果您已经有可用的 NFS 服务端，您可以跳过此步骤。以下以 Ubuntu 操作系统安装操作 NFS Kernel Server 为例介绍如何搭建 NFS 服务端。有关其他 NFS 服务端和其他操作系统的具体操作，请参阅 NFS 服务端和操作系统的用户指南。 + + +=== 前提条件 + +您需要准备一台 Linux 服务器（以下以 Ubuntu 操作系统为例），该服务器必须与{ks_product_both}集群节点网络连通。 + + +=== 操作步骤 + +. 登录用于搭建 NFS 服务端的服务器，执行以下命令指安装 NFS Kernel Server： ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +sudo apt update + +---- + +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +sudo apt install nfs-kernel-server + +---- +-- + +. 执行以下命令创建供{ks_product_both}使用的目录（将 替换为实际的目录路径，例如 **/mnt/demo**）： ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +sudo mkdir -p + +---- +-- + +. 执行以下命令移除目录的访问限制（将 替换为实际的目录路径，例如 **/mnt/demo**）： ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +sudo chown nobody:nogroup + +---- + +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +sudo chmod 777 + +---- +-- + +. 执行以下命令编辑 NFS Kernel Server 的配置文件： ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +sudo vi /etc/exports + +---- +-- + +. 将{ks_product_both}集群节点的信息添加到文件中从而允许服务器访问 NFS 服务端，并保存文件： ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + + (rw,sync,no_subtree_check) + +---- + +将以下参数替换为实际值： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +| +|供{ks_product_both}使用的目录，例如 **/mnt/demo**。 + +| +|{ks_product_right}集群节点的 IP 地址，例如 192.168.0.2。 +|=== + +如果存在多个{ks_product_both}集群节点，请设置多个配置条目。您也可以将 设置为一个网段从而使该网段的所有服务器都能访问 NFS 服务端，例如 **192.168.0.0/24**。 +-- + +. 执行以下命令启用目录共享： ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +sudo exportfs -a + +---- +-- + +. 执行以下命令重启 NFS 服务端使配置生效： ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +sudo systemctl restart nfs-kernel-server + +---- +-- + +== 配置{ks_product_both}集群节点 + +NFS 服务端搭建完成后，您需要在{ks_product_both}集群节点上安装客户端工具，并创建配置文件供后续安装{ks_product_both}时使用。{ks_product_right}安装完成后将使用配置文件指定的 NFS 服务端作为持久化存储。以下以 Ubuntu 操作系统安装 NFS Common 为例介绍如何安装 NFS 客户端以及创建配置文件。有关其他 NFS 客户端和其他操作系统的具体操作，请参阅 NFS 客户端和操作系统的用户指南。 + + +=== 前提条件 + +您需要搭建 NFS 服务端。有关更多信息，请参阅link:#_搭建_nfs_服务端[搭建 NFS 服务端]。 + + +=== 操作步骤 + +. 登录所有{ks_product_both}集群节点，执行以下命令安装 nfs-common： ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +sudo apt update + +---- + +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +sudo apt install nfs-common + +---- +-- + +. 登录用于执行{ks_product_both}安装操作的集群节点，执行以下命令创建 NFS 存储插件配置文件： ++ +-- +// Note +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +vi nfs-client.yaml + +---- +-- + +. 将以下信息添加到配置文件中，并保存文件供后续安装{ks_product_both}时使用： ++ +-- +// YAML +include::../../../../../_ks_components/code/yaml.adoc[] + +nfs: + server: "" + path: "" +storageClass: + defaultClass: true + +---- + +将以下参数替换为实际值： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +| +|NFS 服务端的 IP 地址。 + +| +|NFS 服务端供{ks_product_both}使用的目录。 +|=== + +以上配置文件仅包含必须设置的参数。如需设置其他参数，请参阅 link:https://github.com/kubesphere/helm-charts/blob/master/src/main/nfs-client-provisioner/values.yaml[NFS Client 配置]。 +-- diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/_index.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/_index.adoc new file mode 100644 index 000000000..fdb073b1b --- /dev/null +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/_index.adoc @@ -0,0 +1,16 @@ +--- +title: "配置外部持久化存储" +keywords: "Kubernetes, {ks_product}, 安装, 准备, 持久化存储" +description: "介绍如何在生产环境中为{ks_product_both}集群配置外部持久化存储系统。" +weight: 04 +--- + + +本节介绍如何在生产环境中为{ks_product_both}集群配置外部持久化存储系统。持久化存储系统可用于创建卷供{ks_product_both}平台上的应用存储数据。如未配置外部持久化存储系统，{ks_product_right}默认使用集群节点的本地存储系统。如果{ks_product_both}集群不需要使用外部持久化存储，您可以跳过本节。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +{ks_product_right}外部持久化存储配置仅支持同时安装 Kubernetes 和{ks_product_both}的场景。如果您在现有的 Kubernetes 集群上安装{ks_product_left}，{ks_product_right}安装完成后将使用 Kubernetes 集群现有的持久化存储配置。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/_index.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/_index.adoc new file mode 100644 index 000000000..816b00adf --- /dev/null +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/_index.adoc @@ -0,0 +1,9 @@ +--- +title: "准备工作" +keywords: "Kubernetes, {ks_product}, 安装, 准备工作" +description: "介绍安装{ks_product_both}前需要进行的准备工作。" +weight: 01 +--- + + +本节介绍安装{ks_product_both}前需要进行的准备工作。 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 new file mode 100644 index 000000000..a119d76ab --- /dev/null +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc @@ -0,0 +1,649 @@ +--- +title: "安装 Kubernetes 和 KubeSphere" +keywords: "Kubernetes, KubeSphere, 安装, 安装 KubeSphere, 安装 Kubernetes" +description: "介绍如何安装 Kubernetes 和 KubeSphere。" +weight: 02 +--- + + +本节介绍如何安装 Kubernetes 和{ks_product_left}。 + +安装过程中将用到开源工具 KubeKey。有关 KubeKey 的更多信息，请访问 link:https://github.com/kubesphere/kubekey[GitHub KubeKey 仓库]。 + + +== 前提条件 + +* 您需要联系{ks_product_both}的服务支持团队获取{ks_product_left} v4.1.0 安装包。 + +// 如实施现场条件允许在线拉取公开仓库，具备在线安装条件，可联系 KubeSphere 产品团队获取在线安装文件及相关信息。 + +* 您需要准备至少 1 台 Linux 服务器作为集群节点。在生产环境中，为确保集群具备高可用性，建议准备至少 5 台 Linux 服务器，其中 3 台作为控制平面节点，另外 2 台作为工作节点。如果您在多台 Linux 服务器上安装{ks_product_left}，请确保所有服务器属于同一子网。 + +* 集群节点的操作系统和版本须为 Ubuntu 16.04、Ubuntu 18.04、Ubuntu 20.04、Ubuntu 22.04、Debian 9、Debian 10、CentOS 7、CentOS Stream、RHEL 7、RHEL 8、SLES 15 或 openSUSE Leap 15。多台服务器的操作系统可以不同。关于其它操作系统和版本支持，请联系{ks_product_both}技术支持。 + +* 在生产环境中，为确保集群具有足够的计算和存储资源，建议每台集群节点配置至少 8 个 CPU 核心、16 GB 内存和 200 GB 磁盘空间。除此之外，建议在每台集群节点的 **/var/lib/docker**（对于 Docker）或 **/var/lib/containerd**（对于 containerd） 目录额外挂载至少 200 GB 磁盘空间用于存储容器运行时数据。 + +* 除集群节点外，您还需要准备一台 Linux 服务器用于创建私有镜像服务，该服务器必须与{ks_product_both}集群节点网络连通，并且在 **/mnt/registry** 目录挂载至少 100 GB 磁盘空间。 + +* 在生产环境中，建议提前为{ks_product_both}集群配置高可用性以避免单个控制平面节点出现故障时集群服务中断。有关更多信息，请参阅link:../../../03-installation-and-upgrade/01-preparations/03-configure-high-availability/[配置高可用性]。 ++ +-- +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +如果您规划了多个控制平面节点，请务必提前为集群配置高可用性。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +* 默认情况下，{ks_product_right}使用集群节点的本地磁盘空间作为持久化存储。在生产环境中，建议提前配置外部存储系统作为持久化存储。有关更多信息，请参阅link:../../../03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/[配置外部持久化存储]。 + +* 如果集群节点未安装容器运行时，安装工具 KubeKey 将在安装过程中自动为每个集群节点安装 Docker 作为容器运行时。您也可以提前手动安装 containerd、CRI-O 或 iSula 作为容器运行时。 ++ +-- +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +CRI-O 和 iSula 与{ks_product_both}的兼容性尚未经过充分测试，可能存在未知问题。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +* 请确保所有集群节点上 **/etc/resolv.conf** 文件中配置的 DNS 服务器地址可用。否则，{ks_product_right}集群可能会出现域名解析问题。 + +* 请确保在所有集群节点上都可以使用 **sudo**、**curl** 和 **openssl** 命令。 + +* 请确保所有集群节点时间同步。 + + +== 配置防火墙规则 + +{ks_product_right}需要特定端口和协议用于服务之间的通信。如果您的基础设施环境已启用防火墙，您需要在防火墙设置中放行所需的端口和协议。如果您的基础设施环境未启用防火墙，您可以跳过此步骤。 + +下表列出需要在防火墙中放行的端口和协议。 + +[%header,cols="1a,1a,1a,1a,2a"] +|=== +|服务 |协议 |起始端口 |结束端口 |备注 + +|ssh +|TCP +|22 +| +| + +|etcd +|TCP +|2379 +|2380 +| + +|apiserver +|TCP +|6443 +| +| + +|calico +|TCP +|9099 +|9100 +| + +|bgp +|TCP +|179 +| +| + +|nodeport +|TCP +|30000 +|32767 +| + +|master +|TCP +|10250 +|10258 +| + +|dns +|TCP +|53 +| +| + +|dns +|UDP +|53 +| +| + +|metrics-server +|TCP +|8443 +| +| + +|local-registry +|TCP +|5000 +| +|离线环境需要 + +|local-apt +|TCP +|5080 +| +|离线环境需要 + +|rpcbind +|TCP +|111 +| +|使用 NFS 作为持久化存储时需要 + +|ipip +|IPENCAP/IPIP +| +| +|使用 Calico 时需要 +|=== + +== 安装依赖项 + +您需要为所有集群节点安装 socat、conntrack、ebtables 和 ipset。如果上述依赖项在各集群节点上已存在，您可以跳过此步骤。 + +在 Ubuntu 操作系统上，执行以下命令为服务器安装依赖项： + +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +sudo apt install socat conntrack ebtables ipset -y + +---- + +如果集群节点使用其他操作系统，请将 **apt** 替换为操作系统对应的软件包管理工具。 + +== 查看安装包内容 + +了解{ks_product_left} v4.1.0 的安装包内容，以便进行后续步骤。 + +安装包包含以下文件： + +[,bash] +---- +kse-all-v4.1.0-offline-linux-amd64/ +├── charts +│   ├── ks-core # KubeSphere 企业版核心组件 +│   ├── kse-extensions-publish # 用于发布 KubeSphere 企业版扩展组件 +│   ├── csi-qingcloud # 用于对接青云云平台存储 +│   ├── csi-neonsan # 用于对接 NeonSan 存储 +│   └── nfs-client-provisioner # 用于对接 NFS 存储 +├── tools +│ ├── pre-check.sh # 用于 KubeSphere 企业版升级前的集群环境检查 +│ ├── backup.sh # 用于 KubeSphere 企业版升级前备份系统企业空间中的关键资源 +│ └── upgrade.sh # KubeSphere 企业版升级脚本，提供快速升级能力 +│ ├── oras # OCI 工具，便于镜像同步等操作 +│ └── ks-core-values.yaml # 升级配置示例文件，用于配置各组件的升级参数 +├── kse-extensions # 其中包含所有扩展组件的 installplan，可用于快速安装 KubeSphere 企业版扩展组件 +├── config-sample.yaml # 安装配置文件的模版 +├── create_project_harbor.sh # 用于快速创建 harbor 项目 +├── kk # 集群部署工具 +├── kubekey-artifact.tar.gz # KubeSphere 企业版制品，其中包含集群部署所需的二进制文件及镜像 +└── manifest-v410-amd64.yaml # KubeSphere 企业版制品清单，其中包含各组件的版本以及镜像列表 +---- + + + +== 配置安装配置文件 + +**config-sample.yaml** 是{ks_product_both}的安装配置文件，请先配置该文件，以便进行后续步骤。 + +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-note-doNotDeleteConfig_v4.adoc[] + +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[] ++ + +. 执行以下命令编辑安装配置文件 **config-sample.yaml**： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +vi config-sample.yaml + +---- + +以下为部分示例配置文件，如需了解完整示例，请参阅link:https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md[此文件]。 + +// YAML +include::../../../../_ks_components/code/yaml.adoc[] + +apiVersion: kubekey.kubesphere.io/v1alpha2 +kind: Cluster +metadata: + name: sample +spec: + hosts: + - {name: controlplane1, address: 192.168.0.2, internalAddress: 192.168.0.2, port: 23, user: ubuntu, password: Testing123, arch: arm64} # arm64 节点注意添加参数 arch: arm64 + - {name: controlplane2, address: 192.168.0.3, internalAddress: 192.168.0.3, user: ubuntu, privateKeyPath: "~/.ssh/id_rsa"} + - {name: worker1, address: 192.168.0.4, internalAddress: 192.168.0.4, user: ubuntu, password: Testing123} + - {name: worker2, address: 192.168.0.5, internalAddress: 192.168.0.5, user: ubuntu, password: Testing123} + - {name: registry, address: 192.168.0.6, internalAddress: 192.168.0.6, user: ubuntu, password: Testing123} + roleGroups: + etcd: + - controlplane1 + - controlplane2 + control-plane: + - controlplane1 + - controlplane2 + worker: + - worker1 + - worker2 + # 如需使用 kk 自动部署镜像仓库，请设置 registry（建议镜像仓库与集群节点分离部署，减少相互影响） + registry: + - registry + controlPlaneEndpoint: + internalLoadbalancer: haproxy # 如需部署⾼可⽤集群，且⽆负载均衡器可⽤，可开启该参数，做集群内部负载均衡 + domain: lb.kubesphere.local + address: "" + port: 6443 + kubernetes: + version: v1.23.15 + clusterName: cluster.local + network: + plugin: calico + kubePodsCIDR: 10.233.64.0/18 + kubeServiceCIDR: 10.233.0.0/18 + ## multus support. https://github.com/k8snetworkplumbingwg/multus-cni + enableMultusCNI: false + registry: + # 如需使用 kk 部署 harbor，可将该参数设置为 harbor，不设置该参数且需使用 kk 部署容器镜像仓库，将默认部署 docker registry。 + # harbor 不支持 arm64，arm64 环境部署时，可不配置该参数。 + type: harbor + # 如使用 kk 部署的 harbor 或其他需要登录的仓库，需设置对应仓库的 auths，如使用 kk 部署默认的 docker registry 仓库，则无需配置 auths 参数。 + # 注意：如使用 kk 部署 harbor，auths 参数请于创建 harbor 项目之后设置。 + auths: + "dockerhub.kubekey.local": + username: admin # harbor 默认用户名 + password: Harbor12345 # harbor 默认密码 + plainHTTP: false  # 如果仓库使用 http，请将该参数设置为true + privateRegistry: "dockerhub.kubekey.local/kse"   # 设置集群部署时使用的私有仓库地址 + registryMirrors: [] + insecureRegistries: [] + addons: [] + +---- +-- + +. 在 **config-sample.yaml** 配置文件的 **spec:hosts** 参数下设置各服务器的信息。 ++ +-- +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-para-hosts.adoc[] + +-- + +. 在 **config-sample.yaml** 配置文件的 **spec:roleGroups** 参数下设置服务器的角色： ++ +-- +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-para-roleGroups.adoc[] +-- + +. 如果您规划了多个控制平面节点，在 **config-sample.yaml** 配置文件的 **spec:controlPlaneEndpoint** 参数下设置高可用性信息。 ++ +-- +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-para-controlPlaneEndpoint.adoc[] +-- + +. 如果您需要使用外部持久化存储，在 **config-sample.yaml** 配置文件的 **spec:addons** 参数下设置外部持久化存储信息。 ++ +==== +* 如果使用云上存储设备，在 **spec:addons** 下设置以下参数（将 替换为存储插件配置文件的实际路径）： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + + - name: csi-qingcloud + namespace: kube-system + sources: + chart: + name: csi-qingcloud + path: charts/csi-qingcloud + valuesFile: +---- +-- + +* 如果使用 NeonSAN 存储设备，在 **spec:addons** 下设置以下参数（将 替换为存储插件配置文件的实际路径）： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + + - name: csi-neonsan + namespace: kube-system + sources: + chart: + name: csi-neonsan + path: charts/csi-neonsan + valuesFile: + +---- +-- + +* 如果使用 NFS 存储系统，在 **spec:addons** 下设置以下参数（将 替换为存储插件配置文件的实际路径）： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + + - name: nfs-client + namespace: kube-system + sources: + chart: + name: nfs-client-provisioner + repo: charts/nfs-client-provisioner + valuesFile: + +---- +-- +==== + +== 创建私有镜像仓库 + +[.admon.attention,cols="a"] +|=== +|注意 + +| +如果您已有可用的镜像仓库，可跳过此步骤。但需要把私有镜像服务的默认地址 **dockerhub.kubekey.local/kse** 替换为您的实际镜像仓库地址。 +|=== + +. 在配置文件 **config-sample.yaml** 的 **spec:hosts** 参数下设置用于创建私有镜像服务的服务器的信息。 ++ +-- +[,yaml] +---- +spec: + hosts: + - {name: registry, address: 192.168.0.6, internalAddress: 192.168.0.6, user: ubuntu, password: Testing123} +---- + +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-para-hosts.adoc[] +-- + +. 在 **spec:roleGroups:registry** 参数下设置用于创建私有镜像服务的服务器名称（将 替换为 **spec:hosts** 参数下设置的服务器实际名称）。 ++ +[,yaml] +---- +spec: + roleGroups: + registry: + - +---- + +. 将 **spec:registry:privateRegistry** 参数设置为私有镜像服务的默认地址 **dockerhub.kubekey.local/kse**，然后保存文件。 ++ +[,yaml] +---- +spec: + registry: + registryMirrors: [] + insecureRegistries: [] + privateRegistry: dockerhub.kubekey.local/kse +---- + + +. 执行以下命令初始化私有镜像服务： ++ +==== +[,bash] +---- +./kk init registry -f config-sample.yaml -a kubekey-artifact.tar.gz +---- + +如果显示如下信息，则表明镜像仓库创建成功。 + +image:/images/ks-qkcp/zh/v4.1/verify-registry.png[verify-registry, 100%] + +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-note-initializeRegistry.adoc[] + +==== + +. 若 **spec:registry:type** 参数设置为 **harbor**，执行以下命令创建 Harbor 项目。 ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +bash create_project_harbor.sh + +---- + +创建 harbor 项目后，在 **config-sample.yaml** 中配置 **spec:registry:auths** 参数。 + +[.admon.note,cols="a"] +|=== +|说明 + +| +harbor 安装文件在 /opt/harbor 目录下，可在该目录下对 harbor 进行运维。 + +|=== +-- + ++ + +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-editHosts_v4.adoc[] + +== 安装 Kubernetes + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +* 如果您已有可用的 Kubernetes 集群，可跳过此步骤。 + +* 安装包中集成了 CentOS 7、Ubuntu 18.04、Ubuntu 20.04、Ubuntu 22.04 依赖包，如使用这些操作系统需要使用 kk 自动安装系统依赖，可在安装命令后添加 --with-packages ; 如使用这些操作系统之外的操作系统或由于依赖问题导致失败，需手动安装相关依赖（conntrack）。 + +* 如需使用 openebs localpv，可在如下命令后添加参数 --with-local-storage，如需对接其他存储，可在配置文件 addons 中添加配置相关存储插件，或 Kubernetes 集群部署完成后自行安装。 + +* 如使用 kk 部署的 harbor，请确保安装 Kubernetes 之前，已创建 harbor 项目，且配置文件 config-sample.yaml 中已配置 spec:registry:auths 参数。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] + +执行以下命令创建 Kubernetes 集群： + +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-startInstallationOffline.adoc[] + +如果显示如下信息，则表明 Kubernetes 集群创建成功。 + +[,yaml] +---- +Pipeline[CreateclusterPipeline] execute successfully +Installation is complete. +---- + + +== 导入镜像到私有镜像仓库 + +执行以下命令将镜像导入到指定的私有镜像仓库中。 + +[,bash] +---- +./kk artifact images push -f config-sample.yaml -a kubekey-artifact.tar.gz +---- + +如果显示如下信息，则表明导入成功。 + +[,yaml] +---- +Pipeline[ArtifactImagesPushPipeline] execute successfully +---- + +== 安装{ks_product_left} + +=== 步骤 1：部署 ks-core + +. 在集群节点，执行以下命令安装 KubeSphere Core。 ++ +==== +[,bash] +---- +helm upgrade --install -n kubesphere-system --create-namespace ks-core charts/ks-core \ +--debug \ +--wait \ +--set cloud.enabled=false \ +--set upgrade.enabled=false \ +--set global.imageRegistry=dockerhub.kubekey.local/kse \ +--set extension.imageRegistry=dockerhub.kubekey.local/kse +---- + +[.admon.attention,cols="a"] +|=== +|注意 + +| +将 **global.imageRegistry** 和 **extension.imageRegistry** 的默认地址 **dockerhub.kubekey.local/kse** 替换为您的实际镜像仓库地址。 +|=== + +取决于您的硬件和网络环境，您可能需要配置流量转发规则并在防火墙中放行 30880 端口。如果显示如下信息，则表明 ks-core 安装成功： + +[,yaml] +---- +NOTES: +Thank you for choosing KubeSphere Helm Chart. + +Please be patient and wait for several seconds for the KubeSphere deployment to complete. + +1. Wait for Deployment Completion + + Confirm that all KubeSphere components are running by executing the following command: + + kubectl get pods -n kubesphere-system + +2. Access the KubeSphere Console + + Once the deployment is complete, you can access the KubeSphere console using the following URL: + + http://192.168.6.10:30880 + +3. Login to KubeSphere Console + + Use the following credentials to log in: + + Account: admin + Password: P@88w0rd + +NOTE: It is highly recommended to change the default password immediately after the first login. + +For additional information and details, please visit https://kubesphere.io. +---- +==== + +. 从成功信息中的 **Console**、**Account** 和 **Password** 参数分别获取{ks_product_left} Web 控制台的 IP 地址、管理员用户名和管理员密码，并使用网页浏览器登录{ks_product_left} Web 控制台。 ++ +[.admon.note,cols="a"] +|=== +|说明 + +| +此时，{ks_product_right} Web 控制台仅提供{ks_product_both}的核心功能，若要使用扩展组件，还需继续执行以下 2 个步骤以便安装扩展组件。 +|=== + +=== 步骤 2：发布扩展组件 + +执行以下命令，将{ks_product_both}提供的所有扩展组件导入到 Web 控制台的扩展中心。 + +[,bash] +---- +helm template -n kubesphere-system charts/kse-extensions-publish --set museum.enabled=true,global.imageRegistry=dockerhub.kubekey.local/kse | kubectl apply -f - +---- + +如果显示如下信息，则表明扩展组件发布成功。 + +image:/images/ks-qkcp/zh/v4.1/verify-extension-release.png[verify-extension-release, 100%] + +=== 步骤 3：部署扩展组件 + +发布扩展组件后，登录{ks_product_left} Web 控制台，可在扩展中心查看并安装扩展组件。或者，按照以下步骤快速部署扩展组件。 + +. 若要安装可观测相关扩展组件，需要先部署 vector（WhizardTelemetry 数据流水线）和 whizard-monitoring（WhizardTelemetry 监控）扩展组件。否则，可跳过此步骤。 ++ +-- +[,bash] +---- +# 安装 vector 和 whizard-monitoring +kubectl apply -f kse-extensions/vector-installplan.yaml +kubectl apply -f kse-extensions/whizard-monitoring-installplan.yaml + +# 检查 vector 和 whizard-monitoring 的安装状态，等待状态变为 Installed +kubectl get installplan vector -w +kubectl get installplan whizard-monitoring -w +---- +-- + + +. 执行以下命令，安装指定扩展组件或所有扩展组件。 ++ +-- +[,bash] +---- +# 安装指定扩展组件，请将 {EXTENSION-NAME} 替换为实际名称 +kubectl apply -f kse-extensions/{EXTENSION-NAME}-installplan.yaml + +# 安装所有扩展组件 +kubectl apply -f kse-extensions +---- + +[.admon.note,cols="a"] +|=== +|说明 + +| +* 在{ks_product_both}安装包的 kse-extensions 目录下获取各个扩展组件的 `{EXTENSION-NAME}`，也可参考下图获取。 +* 点击link:../../../03-installation-and-upgrade/03-upgrade-kubesphere/05-appendix-ks-core#_升级组件清单[此处]查看组件清单，了解更多信息。 +|=== + +[.admon.attention,cols="a"] +|=== +|注意 + +| +对于已修改扩展组件配置的扩展组件，请勿重新执行 `kubectl apply -f kse-extensions/{EXTENSION-NAME}-installplan.yaml`，避免扩展组件配置被覆盖。 +|=== +-- + +. 执行以下命令，等待扩展组件状态变更为 **Installed**，则表明部署成功。 ++ +-- +[,bash] +---- +kubectl get installplan -w +---- + +image:/images/ks-qkcp/zh/v4.1/verify-extension-installed.png[ verify-extension-installed,100%] +-- + +// . 如需安装 Spring Cloud 扩展组件，可提前安装。否则，可跳过此步骤。 +// + +// -- +// [.admon.attention,cols="a"] +// |=== +// |注意 + +// | +// Spring Cloud 启动较慢，且包含聚合 API，因此 Spring Cloud 完全启动前会导致需要连接 kube-apiserver 的 Pod 异常，建议提前安装。 + +// |=== + +// [,bash] +// ---- +// # 安装 springcloud +// kubectl apply -f kse-extensions/springcloud-installplan.yaml + +// # 检查 springcloud 运行状态，确保 spring-cloud-controller-manager 和 springcloud-agent-nacos 为 running 状态 +// kubectl get pod -n extension-springcloud +// ---- +// -- \ No newline at end of file diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/_index.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/_index.adoc new file mode 100644 index 000000000..558552796 --- /dev/null +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/_index.adoc @@ -0,0 +1,9 @@ +--- +title: "安装 KubeSphere" +keywords: "Kubernetes,  KubeSphere, 安装" +description: "介绍如何安装 KubeSphere。" +weight: 02 +--- + + +本节介绍如何安装 Kubernetes 和{ks_product_left}。 diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/03-upgrade-kubephere.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/03-upgrade-kubephere.adoc new file mode 100644 index 000000000..5f38c6905 --- /dev/null +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/03-upgrade-kubephere.adoc @@ -0,0 +1,491 @@ +--- +title: "升级 KubeSphere 企业版" +keywords: "Kubernetes, {ks_product}, 安装, 升级{ks_product_left}" +description: "介绍如何升级{ks_product_left}。" +weight: 03 +--- + +本节介绍如何在保持当前的 Kubernetes 版本不变的情况下从{ks_product_both} v3.5.0 升级到{ks_product_both} v4.1.0。 + + +== 前提条件 + +* 您需要联系{ks_product_both}的服务支持团队获取{ks_product_left} v4.1.0 安装包，以及 license。 + +// 如实施现场条件允许在线拉取公开仓库，具备在线安装条件，可联系 KubeSphere 产品团队获取在线安装文件及相关信息。 + +* 请确保当前{ks_product_both}版本为 v3.5.0。如果您的{ks_product_both}版本低于 v3.5.0，请先将{ks_product_both}版本升级到 v3.5.0。 + +* 请确保当前 Kubernetes 版本为 v1.21.x、v1.22.x、v1.23.x, v1.24.x, v1.25.x, v1.26.x, v1.27.x 或 v1.28.x。 + +// :relfileprefix: ../../../ + +// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-prer-offlineInstallation.adoc[] + +// :relfileprefix: ./ + +* {empty} +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-prer-backUpData.adoc[] + +== 准备工作 + +. 将{ks_product_both} v4.1.0 安装包传输到所有集群的节点上。 ++ +[.admon.note,cols="a"] +|=== +|说明 + +| +若想了解安装包中各个文件的作用，请参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/#_查看安装包内容[查看安装包内容]。 +|=== + +. 使用 **backup.sh** 备份系统企业空间（system-workspace）下所有项目中的关键资源，以及备份所有自定义角色及权限相关资源。 ++ +-- +执行以下命令开始备份。相关资源将备份至 **backup-$timestamp** 目录下。 + +[,bash] +---- +bash backup.sh +---- + +备份完成后，如下图所示。 + +image:/images/ks-qkcp/zh/v4.1/backup.png[ backup, 100%] +-- + +. 联系{ks_product_both}的服务支持团队，根据当前集群的 cc.yaml 中的配置和 KubeSphere 组件的 patch 情况（如 cc.yaml 外的配置），确定升级时各组件使用的参数，然后创建 **ks-core-values.yaml** 文件。可参阅安装包中的 ks-core-values.yaml 示例文件。 ++ +-- +[.admon.attention,cols="a"] +|=== +|注意 + +| +* 在 ks-core-values.yaml 文件中，可将集群中没有启用的组件设置为 enabled: false。core 和 iam 组件必须配置为 enabled: true，不可禁用。 + +* 部分扩展组件在特定情况下（比如依赖外部服务的访问地址等），升级时不能使用**默认配置**，需手动配置一些字段。请参阅**组件升级配置文档**确认您的组件是否存在此问题，并在 ks-core-values.yaml 文件中做出相应修改。 +请在{ks_product_both} v4.1.0 用户文档中的**升级配置文档**文件夹下查阅“默认配置”和“组件升级配置文档”。 + +|=== +-- + +. 将安装包中的 **charts** 文件夹、以及创建的 **ks-core-values.yaml** 文件复制到 **upgrade.sh** 所在的 tools 目录。 + +. 执行安装包中的脚本 **pre-check.sh**，检查是否满足升级条件，需确保所有检查项通过。如果检查未通过，后续升级很有可能失败。 + + +== 单集群升级 + +. 在 host 集群节点上，切换到安装包的 tools 目录（该目录需包含 **charts** 文件夹、**ks-core-values.yaml** 和 **upgrade.sh**）。 + +. 执行以下命令开始升级{ks_product_left}。 ++ +-- +[,bash] +---- +bash upgrade.sh host +---- +-- + +. 参考以下步骤，检查 host 集群是否升级成功。 + +.. 执行以下命令，upgrade job 应该是成功完成的状态，如下所示。 ++ +[,bash] +---- +root@xxx:~# kubectl -n kubesphere-system get job | grep upgrade +ks-core-post-upgrade 1/1 16s 28m +ks-core-pre-upgrade 1/1 58s 31m +prepare-upgrade 1/1 26s 32m +---- + +.. 执行以下命令，如果显示如下信息，则表明 ks-core Helm Chart 已成功部署。 ++ +[,bash] +---- +root@xxx:~# helm list -n kubesphere-system +NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION +ks-core kubesphere-system 6 2024-04-09 14:54:09.349488995 +0800 CST deployed ks-core-1.0.0 v4.1.0 +---- + +.. 执行以下命令，pod（ks-apiserver, ks-console, ks-controller-manager）应该为 running 状态，如下所示。 ++ +[,bash] +---- +root@xxx:~# kubectl -n kubesphere-system get pod +NAME READY STATUS RESTARTS AGE +ks-apiserver-594bb884db-phrlv 1/1 Running 0 28m +ks-console-7cd55dd9f9-f2jl9 1/1 Running 0 28m +ks-controller-manager-785fc676dc-9d9j2 1/1 Running 0 28m +---- + +.. 执行以下命令，如果所有扩展组件的状态为 Installed，表明扩展组件都已成功安装。 ++ +[,bash] +---- +root@xxx:~# kubectl get installplan +NAME STATE +storage-utils Installed +devops Installed +network Installed +... +---- + +.. 登录{ks_product_left} Web 控制台后，点击右上角用户名 > 关于，显示的平台版本应为 v4.1.0。 + +. 使用原有的 Web 控制台的 IP 地址、管理员用户名和管理员密码，并使用网页浏览器登录 v4.1.0 的{ks_product_left} Web 控制台。 + +. 根据激活提示点击**激活**，导入{ks_product_left}的 license。 + +. 检查 host 集群各项功能和数据是否正常。 + + +== 多集群升级 + +. 按照以上link:#_单集群升级[单集群升级]步骤完成 host 集群的升级。 + +. 在 member 集群节点上，切换到安装包的 tools 目录（该目录需包含 **charts** 文件夹、**ks-core-values.yaml** 和 **upgrade.sh**）。 + +. 执行以下命令开始升级{ks_product_left}。 ++ +[,bash] +---- +bash upgrade.sh member +---- + +. 参考以下步骤，检查 member 集群是否升级成功。 + +.. 执行以下命令，upgrade job 应该是成功完成的状态，如下所示。 ++ +[,bash] +---- +root@xxx:~# kubectl -n kubesphere-system get job | grep upgrade +ks-core-post-upgrade 1/1 16s 28m +ks-core-pre-upgrade 1/1 58s 31m +prepare-upgrade 1/1 26s 32m +---- + +.. 执行以下命令，如果显示如下信息，则表明 ks-core Helm Chart 已成功部署。 ++ +[,bash] +---- +root@xxx:~# helm list -n kubesphere-system +NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION +ks-core kubesphere-system 6 2024-04-09 14:54:09.349488995 +0800 CST deployed ks-core-1.0.0 v4.1.0 +---- + +.. 执行以下命令，ks-agent pod 应该为 running 状态，如下所示。 ++ +[,bash] +---- +root@xxx:~# kubectl -n kubesphere-system get pod +NAME READY STATUS RESTARTS AGE +ks-agent-5dc5b57977-4x6mf 2/2 Running 0 59m +---- + +. member 集群升级成功后，在 host 集群上执行以下命令，修改 member 集群的状态，以便使扩展组件 agent 调度到 member 集群上。 ++ +-- +[,bash] +---- +kubectl get clusters.cluster.kubesphere.io {member-x} -o json | jq 'del(.status.conditions[] | select(.type=="Schedulable"))' | kubectl apply -f - +---- + +[.admon.note,cols="a"] +|=== +|说明 + +| 执行 `kubectl get cluster`，替换 `{member-x}`。 + +|=== + +如果节点没有 jq 命令，可通过编辑集群资源的方式实现，编辑 member 集群的 status.conditions 中 type 为 Schedulable 的 condition，将其 status 设置为 True。 + +[,bash] +---- +kubectl edit clusters.cluster.kubesphere.io {member-x} +---- + +[,yaml] +---- +status: + conditions: + - lastTransitionTime: "2024-04-11T09:12:22Z" + lastUpdateTime: "2024-04-11T09:12:22Z" + message: Cluster has been initialized + reason: Initialized + status: "True" + type: Initialized + - lastTransitionTime: "2024-04-12T07:59:14Z" + lastUpdateTime: "2024-04-12T07:59:14Z" + message: Cluster has joined federation control plane successfully + status: "True" + type: Federated + - lastTransitionTime: "2024-04-12T08:02:56Z" + lastUpdateTime: "2024-04-12T08:02:56Z" + message: KS Core is available now + reason: KSCoreReady + status: "True" + type: KSCoreReady + - lastTransitionTime: "2024-04-12T08:02:56Z" + lastUpdateTime: "2024-04-12T08:02:56Z" + message: Not schedulable now + reason: Upgrading + status: "False" # 修改此处即可 + type: Schedulable + - lastTransitionTime: "2024-04-12T08:24:27Z" + lastUpdateTime: "2024-04-12T08:24:27Z" + message: Agent has connected to proxy successfully. + status: "True" + type: AgentAvailable + - lastTransitionTime: "2024-04-12T08:57:40Z" + lastUpdateTime: "2024-04-12T08:57:40Z" + message: Cluster is available now + reason: Ready + status: "True" + type: Ready +---- +-- + +. 登录 host 集群的{ks_product_left} Web 控制台，进入**集群管理**页面，检查此 member 集群的各项功能和数据是否正常。 + +. 对下一个 member 集群继续执行以上步骤，直至完成所有集群的升级。 + +== 升级后配置 + +部分扩展组件，如 `KubeSphere 网关`、`WhizardTelemetry 监控`、`WhizardTelemetry 告警管理`、`WhizardTelemetry 通知管理`、`RadonDB DMP` 在升级后需进行额外配置，请参阅{ks_product_both} v4.1.0 用户文档中的**升级配置文档**文件夹下的**组件升级配置文档**进行配置。 + +[.admon.attention,cols="a"] +|=== +|注意 + +| +请务必参阅**组件升级配置文档**对升级后的 `KubeSphere 网关` 扩展组件进行配置，否则无法使用网关相关功能。 +|=== + +== 常见问题 + +=== 无法操作未升级的 member 集群 + +问题描述：host 集群升级到 v4.1.0 以后，无法在{ks_product_left} Web 控制台中查看和操作未升级的 member 集群。 + +原因：v4.1.0 与 v3.5.0 有许多 API 不兼容导致。 + +解决办法： + +* 尽快升级 member 集群。 +* 可在 member 集群升级前，通过 member 集群的 Web 控制台直接访问 member 集群。 + +=== member 集群的 Web 控制台无法登录 + +问题描述：在升级 member 集群前，通过 member 集群的 Web 控制台无法登录任何用户，提示"incorrect username or password"。 + +原因：{ks_product_right} v3.x 默认禁止直接访问 member 集群的 Web 控制台。 + +解决办法： + +. 执行以下命令，增加如下配置。 ++ +-- +[,bash] +---- +kubectl -n kubesphere-system edit cm kubesphere-config +---- + +[,yaml] +---- +authentication: + oauthOptions: + accessTokenMaxAge: 0 + clients: + - name: kubesphere + secret: kubesphere + redirectURIs: + - '*' +---- +-- + +. 执行以下命令重启 ks-apiserver，即可登录 member 集群的 Web 控制台。 ++ +[,bash] +---- +kubectl -n kubesphere-system rollout restart deployment ks-apiserver +---- + +=== 升级脚本异常退出 + +问题描述：升级过程中，升级脚本异常退出，升级失败。 + +解决办法：执行以下命令，查看升级 Job 日志，排查升级失败原因。 + +[,bash] +---- +kubectl -n kubesphere-system get job/prepare-upgrade + +kubectl -n kubesphere-system get pod |grep prepare-upgrade + +# 查看升级Job日志 +kubectl -n kubesphere-system logs prepare-upgrade-gvc6p +---- + +[,bash] +---- +kubectl -n kubesphere-system get job/ks-core-pre-upgrade + +kubectl -n kubesphere-system get pod |grep ks-core-pre-upgrade + +# 查看升级Job日志 +kubectl -n kubesphere-system logs ks-core-pre-upgrade-4n7tp +---- + +[,bash] +---- +kubectl -n kubesphere-system get job/ks-core-post-upgrade + +kubectl -n kubesphere-system get pod |grep ks-core-post-upgrade + +# 查看升级Job日志 +kubectl -n kubesphere-system logs ks-core-post-upgrade-4nzhk +---- + +=== 自定义角色的权限项为空 + +问题描述：升级后，自定义角色的权限项为空，被赋予自定义角色的用户无法正常使用。 + +解决办法： + +升级脚本 backup.sh 已帮助备份好自定义角色和自定义角色绑定，但由于权限变化，在升级时无法自动转换其权限，所以在升级后需要用户自行补充角色的权限。 + +. 使用升级脚本备份后，在 `backup-$timestamp/kse35-backup-iam-xxx.yaml` 路径下查看已经备份的自定义角色。 + +. 找到 `metadata.annotations[iam.kubesphere.io/aggregation-roles]`，用取到的值对比以下表格的 **3.x** 列中的名称，然后在{ks_product_left} Web 控制台找到对应的**描述**列中的权限名称。 ++ +-- +[.admon.note,cols="a"] +|=== +|说明 + +| +平台自定义角色请查阅以下**平台**表格，企业空间自定义角色请查阅以下**企业空间**表格，项目自定义角色请查阅以下**项目**表格，确认对应关系。 +|=== +-- + +**示例：** + +已经备份好的平台自定义角色 `test` 的信息如下 + +```yaml +apiVersion: iam.kubesphere.io/v1alpha2 +kind: GlobalRole +metadata: + annotations: + iam.kubesphere.io/aggregation-roles: '["role-template-view-roles","role-template-view-users","role-template-view-basic","role-template-manage-clusters","role-template-view-clusters"]' + kubesphere.io/alias-name: test-name + kubesphere.io/creator: admin + creationTimestamp: "2024-04-11T11:59:08Z" + generation: 3 + name: test #自定义角色的名称 + resourceVersion: "529194" + uid: a3ad5e39-2959-4e14-aa8f-e0c0ad8e6889 +rules: + ... + ... +``` + +. 取到 `metadata.annotations[iam.kubesphere.io/aggregation-roles]` 的值，如下： ++ +```yaml +'["role-template-view-roles","role-template-view-users","role-template-view-basic","role-template-manage-clusters","role-template-view-clusters"]' +``` + +. 对比以下**平台**表格，`metadata.annotations[iam.kubesphere.io/aggregation-roles]` 的各个值在表格的 **3.x** 列，对应的权限项在表格的**描述**列，故应该勾选**角色查看**、**用户查看**、**基础查看**、**集群管理**、**集群查看**。但因基础查看在 **4.1** 列被标记为 `none`，所以无法勾选**基础查看**。 + +. 在{ks_product_left} Web 控制台的**平台角色**页面编辑 `test` 角色的权限。 ++ +-- +image:/images/ks-qkcp/zh/v4.1/edit-permission.png[ edit-permission, 100%] + +勾选**角色查看**、**用户查看**、**集群管理**、**集群查看**。 + +image:/images/ks-qkcp/zh/v4.1/check-permission.png[ check-permission, 100%] +-- + +[.admon.attention,cols="a"] +|=== +|注意 + +| +一些权限项在 v4.1.0 中已经移除，标记为 `none`。有些没有移除，但出于安全考虑无法再将此权限授权给自定义角色，标记为 `can not use`。标记为 `none` 或 `can not use` 的权限项，在编辑自定义角色的权限时，不能被勾选。 +|=== + + +**平台** +[%header,cols="1a,2a,2a"] +|=== +| 描述 | 3.x | 4.1 + +|企业空间创建|role-template-create-workspaces| global-create-workspaces +|应用模版管理|role-template-manage-app-templates | `none` +|集群管理|role-template-manage-clusters | global-manage-clusters +|平台设置管理| role-template-manage-platform-settings | `can not use` +|角色管理| role-template-manage-roles | `can not use` +|用户管理|role-template-manage-users | `can not use` +|企业空间管理|role-template-manage-workspaces | global-manage-workspaces +|应用查看| role-template-view-app-templates | `none` +|基础查看|role-template-view-basic | `none` +|集群查看|role-template-view-clusters | global-view-clusters +|角色查看|role-template-view-roles | global-view-roles +|用户查看| role-template-view-users | global-view-users +|企业空间查看|role-template-view-workspaces | global-view-workspaces +|=== + +**企业空间** +[%header,cols="1a,2a,2a"] +|=== +| 描述 | 3.x | 4.1 + +|DevOps 项目创建|role-template-create-devops | workspace-create-devops +|项目创建|role-template-create-projects | workspace-create-projects +|应用仓库管理|role-template-manage-app-repos | workspace-manage-app-repos +|应用模板管理|role-template-manage-app-templates | workspace-manage-app-templates +|DevOps 项目管理|role-template-manage-devops | workspace-manage-devops +|部门管理 |role-template-manage-groups | `none` +|成员管理|role-template-manage-members | `can not use` +|项目管理|role-template-manage-projects | workspace-manage-projects +|角色管理|role-template-manage-roles | `can not use` +|企业空间设置管理|role-template-manage-workspace-settings | `can not use` +|应用仓库查看|role-template-view-app-repos | workspace-view-app-repos +|应用模版查看|role-template-view-app-templates | workspace-view-app-templates +|基础查看|role-template-view-basic | `none` +|DevOps 项目查看|role-template-view-devops | workspace-view-devops +|部门查看|role-template-view-groups | `none` +|成员查看|role-template-view-members | workspace-view-members +|角色查看|role-template-view-roles | workspace-view-roles +|企业空间设置查看|role-template-view-workspace-settings | `can not use` +|=== + +**项目** + +[%header,cols="1a,2a,2a"] +|=== +| 描述 | 3.x | 4.1 + +|应用负载管理|role-template-manage-app-workloads | namespace-manage-app-workloads +|配置字典管理|role-template-manage-configmaps | namespace-manage-configmaps +|成员管理|role-template-manage-members | `can not use` +|项目设置管理|role-template-manage-project-settings | namespace-manage-project-settings +|角色管理|role-template-manage-roles | `can not use` +|保密字典管理|role-template-manage-secrets | namespace-manage-secrets +|服务账户管理|role-template-manage-serviceaccount | namespace-manage-serviceaccount +|持久卷声明管理|role-template-manage-volumes | namespace-manage-persistentvolumeclaims +|应用负载查看|role-template-view-app-workloads | namespace-manage-app-workloads +|基础查看|role-template-view-basic|`none` +|配置字典查看|role-template-view-configmaps | namespace-view-configmaps +|成员查看|role-template-view-members | namespace-view-members +|角色查看|role-template-view-roles | namespace-view-roles +|保密字典查看|role-template-view-secrets | namespace-view-secrets +|服务账户查看|role-template-view-serviceaccount | namespace-view-serviceaccount +|持久卷声明查看|role-template-view-volumes | namespace-view-persistentvolumeclaims +|=== + diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/05-appendix-ks-core.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/05-appendix-ks-core.adoc new file mode 100644 index 000000000..384b8e2e1 --- /dev/null +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/05-appendix-ks-core.adoc @@ -0,0 +1,94 @@ +--- +title: "附录 1：ks-core Helm Chart 升级参数" +weight: 05 +--- + +== 升级 Job 配置 + +[%header,cols="2a,1a,2a"] +|=== +| 选项 | 默认值 | 描述 + +| upgrade.enabled | true | bool - 是否启用升级组件 +| upgrade.image.registry | "" | string - 设置升级 Job 的镜像仓库地址 +| upgrade.image.repository | kse/ks-upgrade | string - 设置升级 Job 的镜像名称 +| upgrade.image.tag | "" | string - 设置升级 Job 的镜像标签 +| upgrade.image.pullPolicy | Always | string - 设置升级 Job 的镜像拉取策略 +| upgrade.persistenceVolume.name | ks-upgrade | string - 设置升级 Job 的存储卷 +| upgrade.persistenceVolume.storageClassName | "" | string - 设置升级 Job 的存储卷类 +| upgrade.persistenceVolume.accessMode | ReadWriteOnce | string - 设置升级 Job 的存储卷访问模式 +| upgrade.persistenceVolume.size | 5Gi | string - 设置升级 Job 的存储卷容量 +| upgrade.resources.limit.cpu | 1 | string - 设置升级 Job 的 CPU 资源配额上限 +| upgrade.resources.limit.memory | 1024Mi | string - 设置升级 Job 的 Memory 资源配额上限 +| upgrade.resources.requests.cpu | 20m | string - 设置升级 Job 的 CPU 资源申请配额 +| upgrade.resources.requests.memory | 100Mi | string - 设置升级 Job 的 Memory 资源申请配额 +|=== + +== 升级应用配置 + +[%header,cols="2a,1a,2a"] +|=== +| 选项 | 默认值 | 描述 + +| upgrade.config.storage.local.path | /tmp/ks-upgrade | string - 设置升级 Job 使用本地目录存储备份数据 +| upgrade.config.storage.s3.endpoint | "" | string - 设置升级 Job 使用支持 S3 协议的对象存储服务备份数据，存储服务地址 +| upgrade.config.storage.s3.region | "" | string - 设置 S3 服务数据存储区域 +| upgrade.config.storage.s3.disableSSL | false | bool - 设置禁用 SSL 安全协议 +| upgrade.config.storage.s3.forcePathStyle | false | bool - 设置 S3 客户端对桶使用路径式寻址 +| upgrade.config.storage.s3.accessKeyID | "" | string - 设置 S3 服务账号的访问键，不使用凭证文件时是必需的 +| upgrade.config.storage.s3.secretAccessKey | "" | string - 设置 S3 服务账号的访问密钥，不使用凭证文件时是必需的 +| upgrade.config.storage.s3.sessionToken | "" | string - 设置 S3 服务的访问凭证文件 +| upgrade.config.storage.s3.bucket | "" | string - 设置 S3 服务的存储桶 +| upgrade.config.download.globalRegistryUrl | oci://hub.kubesphere.com.cn/kse-extensions | string - 设置扩展组件的仓库地址 +| upgrade.config.download.file | - | 系统预留配置 +| upgrade.config.download.http.timeout | 20 | int64 - 设置拉取扩展组件的超时时间 +| upgrade.config.download.http.caBundle | "" | string - 设置扩展组件仓库的自签名证书的 base64 字符串，多个自签名证书合并字符串 base64 +| upgrade.config.download.http.insecureSkipVerify | true | bool - 设置跳过扩展组件仓库 TLS 认证 +| upgrade.config.download.oci | - | 系统预留配置 +| upgrade.config.skipValidator | false | bool - 设置跳过升级 Job 版本校验，当前校验 KubeSphere 版本 +|=== + +== 升级组件配置 + +[%header,cols="2a,1a,2a"] +|=== +| 选项 | 默认值 | 描述 + +|upgrade.config.jobs.$ID.enabled |false |bool - 设置启用升级组件 $ID +|upgrade.config.jobs.$ID.priority |0 |int - 设置组件升级顺序的优先级 +|upgrade.config.jobs.$ID.extensionRef.name |"" |string - 设置扩展组件名称 +|upgrade.config.jobs.$ID.extensionRef.version |"" |string - 设置扩展组件版本 + +|=== + +== 升级组件清单 + +[%header,cols="1a,2a"] +|=== +| ID | 名称/描述 + +| core | ks-core 核心组件 +| iam | 多租户管理 +| network | KubeSphere 网络，用于 IPPool 管理和 NetworkPolicy 管理 +| devops | DevOps 系统 +| storage-utils | KubeSphere 存储 +| tower | KubeSphere 多集群代理连接 +| kubefed | 联邦集群应用管理 +| whizard-monitoring | WhizardTelemetry 监控 +| whizard-notification | WhizardTelemetry 通知管理 +| whizard-alerting | WhizardTelemetry 告警管理 +| whizard-events | WhizardTelemetry 事件管理 +| whizard-auditing | WhizardTelemetry 审计管理 +| whizard-logging | WhizardTelemetry 日志管理 +| whizard-telemetry-ruler | WhizardTelemetry 事件告警 +| whizard-telemetry | WhizardTelemetry 平台服务 +| vector | WhizardTelemetry 数据流水线 +| metrics-server | Metrics Server，集群核心监控数据的聚合器 +| opensearch | 用于日志存储 +| kubeedge | KubeEdge 边缘计算框架 +| springcloud | Spring Cloud，管理微服务、微服务配置和微服务网关 +| servicemesh | KubeSphere 服务网格 +| application | KubeSphere 应用商店管理 +| dmp | RadonDB DMP，云原生数据库管理平台 +| gateway | KubeSphere 网关 +|=== \ No newline at end of file diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/_index.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/_index.adoc new file mode 100644 index 000000000..8d8a6f66a --- /dev/null +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "升级 KubeSphere" +keywords: "Kubernetes, KubeSphere, 升级" +description: "介绍如何升级 KubeSphere。" +weight: 03 +--- + + + +本节介绍如何升级{ks_product_left}。 diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/01-uninstall-kubesphere-only.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/01-uninstall-kubesphere-only.adoc new file mode 100644 index 000000000..32230014d --- /dev/null +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/01-uninstall-kubesphere-only.adoc @@ -0,0 +1,123 @@ +--- +title: "仅卸载 KubeSphere" +keywords: "Kubernetes, KubeSphere, 仅卸载 KubeSphere" +description: "介绍如何卸载 KubeSphere。" +weight: 01 +--- + +本节介绍如何卸载{ks_product_left}。当前集群中运行的 Kubernetes 将不会被卸载。 + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +* 虽然此操作不会卸载 Kubernetes，如果当前集群中运行的业务使用了{ks_product_both}提供的功能，此操作仍然可能导致业务中断。 + +* 此操作不能撤销，请谨慎执行此操作。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-prer-backUpData.adoc[] + +== 卸载扩展组件 + +. 登录任意集群节点，执行以下命令查看集群中所有的扩展组件。 ++ +[,bash] +---- +kubectl get installplan +---- + +. 卸载指定扩展组件或所有扩展组件。 + + +* 卸载指定扩展组件。 ++ +-- +[,bash] +---- +kubectl delete installplan {InstallPlan Name} +---- +[.admon.note,cols="a"] +|=== +|说明 + +| +可根据第一步的命令获取扩展组件的 `InstallPlan Name`。 +|=== + +如果显示如下信息，表明该扩展组件卸载成功。 + +[,bash] +---- +installplan.kubesphere.io "{InstallPlan Name}" deleted +---- +-- + +* 卸载全部扩展组件。 ++ +-- +[,bash] +---- +kubectl delete installplan --all +---- + +输出信息应如下所示： + +[,bash] +---- +installplan.kubesphere.io "devops" deleted +installplan.kubesphere.io "dmp" deleted +installplan.kubesphere.io "gatekeeper" deleted +installplan.kubesphere.io "gateway" deleted +installplan.kubesphere.io "kubeedge" deleted +installplan.kubesphere.io "kubefed" deleted +installplan.kubesphere.io "metrics-server" deleted +installplan.kubesphere.io "network" deleted +installplan.kubesphere.io "openpitrix" deleted +installplan.kubesphere.io "opensearch" deleted +installplan.kubesphere.io "springcloud" deleted +installplan.kubesphere.io "storage-utils" deleted +installplan.kubesphere.io "tower" deleted +installplan.kubesphere.io "vector" deleted +installplan.kubesphere.io "whizard-alerting" deleted +installplan.kubesphere.io "whizard-auditing" deleted +installplan.kubesphere.io "whizard-events" deleted +installplan.kubesphere.io "whizard-logging" deleted +installplan.kubesphere.io "whizard-monitoring" deleted +installplan.kubesphere.io "whizard-notification" deleted +installplan.kubesphere.io "whizard-telemetry" deleted +installplan.kubesphere.io "whizard-telemetry-ruler" deleted +---- + +再次执行以下命令，如果显示 No resources found，表明所有扩展组件都已卸载。 + +[,bash] +---- +kubectl get installplan +---- +-- + + +== 卸载 ks-core + +卸载 ks-core 之前，请确保集群中的扩展组件都已被卸载，即执行 `kubectl get installplan` 命令后显示 No resources found。 + +. 执行以下命令卸载 ks-core。 ++ +[,bash] +---- +helm del -n kubesphere-system ks-core +---- + +. 执行以下命令，如果返回结果为空（如下所示），表明{ks_product_both}卸载成功。 ++ +-- +[,bash] +---- +root@xxx:~# helm list -n kubesphere-system +NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION +---- +-- \ No newline at end of file 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 new file mode 100644 index 000000000..468ad07ca --- /dev/null +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/02-uninstall-kubernetes-and-kubesphere.adoc @@ -0,0 +1,75 @@ +--- +title: "卸载 Kubernetes 和 KubeSphere" +keywords: "Kubernetes, KubeSphere, 卸载 Kubernetes 和 KubeSphere" +description: "介绍如何卸载 Kubernetes 和 KubeSphere。" +weight: 02 +--- + + +本节介绍如何卸载 Kubernetes 和{ks_product_left}。 + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +本节介绍的 Kubernetes 卸载方式仅适用于 Kubernetes 通过 KubeKey 安装的场景。如果您的 Kubernetes 不是通过 KubeKey 安装，请参阅 link:https://kubernetes.io/zh/docs/reference/setup-tools/kubeadm/kubeadm-reset/[Kubernetes 官方文档]卸载 Kubernetes。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +此操作将导致{ks_product_both}集群业务中断，并且无法撤销，请谨慎执行此操作。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +* 您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅link:../../../03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere[安装 Kubernetes 和 KubeSphere 企业版]。 ++ +[.admon.note,cols="a"] +|=== +|说明 + +| +如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere 企业版] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，卸载过程可能会出现错误。 +|=== + +* {empty} +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-prer-backUpData.adoc[] + + +== 操作步骤 + +// ifeval::["{file_output_type}" == "html"] +// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[] +// endif::[] + +// ifeval::["{file_output_type}" == "pdf"] +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[] +// endif::[] + ++ +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-transferConfig.adoc[] + ++ + +. 执行以下命令开始卸载{ks_product_left}： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + + ./kk delete cluster -f config-sample.yaml + +---- + +如果显示如下信息，则表明卸载成功： + +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +Pipeline[DeleteClusterPipeline] execute successful + +---- +-- diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/_index.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/_index.adoc new file mode 100644 index 000000000..b5f4c4287 --- /dev/null +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/_index.adoc @@ -0,0 +1,9 @@ +--- +title: "卸载 KubeSphere" +keywords: "Kubernetes, KubeSphere, 卸载" +description: "介绍如何卸载 KubeSphere。" +weight: 04 +--- + + +本节介绍如何卸载{ks_product_left}。 diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/01-add-cluster-nodes.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/01-add-cluster-nodes.adoc new file mode 100644 index 000000000..57714a19c --- /dev/null +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/01-add-cluster-nodes.adoc @@ -0,0 +1,141 @@ +--- +title: "添加集群节点" +keywords: "Kubernetes, KubeSphere, 添加集群节点" +description: "介绍如何添加 KubeSphere 集群节点。" +weight: 01 +--- + + +本节介绍如何添加{ks_product_both}集群节点。 + +节点添加过程中将用到开源工具 KubeKey。有关 KubeKey 的更多信息，请访问 link:https://github.com/kubesphere/kubekey[GitHub KubeKey 仓库]。 + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +本节介绍的节点添加方式仅适用于 Kubernetes 通过 KubeKey 安装的场景。如果您的 Kubernetes 不是通过 KubeKey 安装，请参阅 link:https://kubernetes.io/zh/docs/concepts/architecture/nodes/[Kubernetes 官方文档]添加节点。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +* 您需要联系{ks_product_both}的服务支持团队获取{ks_product_left} v4.1.0 安装包。 + +// 如实施现场条件允许在线拉取公开仓库，具备在线安装条件，可联系 KubeSphere 产品团队获取在线安装文件及相关信息。 + +* 新增节点的操作系统和版本须为 Ubuntu 16.04、Ubuntu 18.04、Ubuntu 20.04、Ubuntu 22.04、Debian 9、Debian 10、CentOS 7、CentOS Stream、RHEL 7、RHEL 8、SLES 15 或 openSUSE Leap 15。多个集群节点的操作系统可以不同。关于其它操作系统和版本支持，请联系{ks_product_both}技术支持。 + +* 为确保集群具有足够的计算和存储资源，建议新增节点配置至少 8 个 CPU 核心，16 GB 内存和 200 GB 磁盘空间。除此之外，建议在每台集群节点的 **/var/lib/docker**（对于 Docker）或 **/var/lib/containerd**（对于 containerd） 目录额外挂载至少 200 GB 磁盘空间用于存储容器运行时数据。 + +* 如果添加控制平面节点，您需要提前为集群配置高可用性。如果您使用负载均衡器，请确保负载均衡器监听所有控制平面节点的 6443 端口。有关更多信息，请参阅link:../../../03-installation-and-upgrade/01-preparations/03-configure-high-availability/[配置高可用性]。 + +* 如果您的集群节点无法连接互联网，您还需要准备一台 Linux 服务器用于创建私有镜像服务，该服务器必须与{ks_product_both}集群节点网络连通并且在 **/mnt/registry** 目录挂载至少 100 GB 磁盘空间。 + + +:relfileprefix: ../../../ + +* 您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅xref:03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc[安装 Kubernetes 和 KubeSphere 企业版]。 + +:relfileprefix: ./ + +-- +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +* 添加节点过程中不支持在 **config-sample.yaml** 配置文件中修改原有的集群配置。 + +* 如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere 企业版] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，添加节点后集群可能会出现错误。 +include::../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + + +== 操作步骤 + +// ifeval::["{file_output_type}" == "html"] +// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[] +// endif::[] + +// ifeval::["{file_output_type}" == "pdf"] +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[] +// endif::[] + ++ +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-transferConfig.adoc[] + ++ + +. 执行以下命令编辑安装配置文件 **config-sample.yaml**： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +vi config-sample.yaml + +---- +-- + +. 在 **config-sample.yaml** 文件的 **hosts** 参数下设置新增节点的信息。 ++ +-- + +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-para-hosts.adoc[] + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +请勿修改原有节点的信息。否则，添加节点后集群可能会出现错误。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +. 在 **config-sample.yaml** 文件的 **roleGroups** 参数下设置新增节点在集群中的角色。 ++ +-- + +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-para-roleGroups.adoc[] + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +请勿修改原有节点的角色。否则，添加节点后集群可能会出现错误。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +. 如果新增控制平面节点并且当前集群未配置高可用性，在 **config-sample.yaml** 文件的 **controlPlaneEndpoint** 参数下设置高可用性信息。 ++ +-- + +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-para-controlPlaneEndpoint.adoc[] + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +* 如果当前集群已配置高可用性，请勿修改 **config-sample.yaml** 文件中的高可用性信息。否则，添加节点后集群可能会出现错误。 + +* 如果当前集群使用本地负载均衡实现高可用性，您不需要对集群高可用性进行任何操作；如果当前集群使用负载均衡器实现高可用性，您只需要设置负载均衡器监听所有控制平面节点的 6443 端口。有关更多信息，请参阅link:../../../03-installation-and-upgrade/01-preparations/03-configure-high-availability/[配置高可用性]。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +. 保存配置文件，执行以下命令开始添加节点： ++ +-- +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-code-addNodes.adoc[] +-- +// endif::[] + +. 执行以下命令查看当前集群的节点： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +kubectl get node + +---- + +如果显示新增节点的信息，则表明节点添加成功。 +-- diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/02-delete-cluster-nodes.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/02-delete-cluster-nodes.adoc new file mode 100644 index 000000000..5f17efd21 --- /dev/null +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/02-delete-cluster-nodes.adoc @@ -0,0 +1,112 @@ +--- +title: "删除集群节点" +keywords: "Kubernetes, {ks_product}, 删除集群节点" +description: "介绍如何删除{ks_product_both}集群节点。" +weight: 02 +--- + + +本节介绍如何删除{ks_product_both}集群节点。 + +节点删除过程中将用到开源工具 KubeKey。有关 KubeKey 的更多信息，请访问 link:https://github.com/kubesphere/kubekey[GitHub KubeKey 仓库]。 + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +本节介绍的节点删除方式仅适用于 Kubernetes 通过 KubeKey 安装的场景。如果您的 Kubernetes 不是通过 KubeKey 安装，请参阅 link:https://kubernetes.io/zh/docs/concepts/architecture/nodes/[Kubernetes 官方文档]删除节点。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] + +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +* 请勿删除控制平面节点，否则集群将出现错误。 + +* 请确保节点删除后，集群中剩余的资源仍然足够运行现有的业务。否则，节点删除后可能会出现业务中断。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +* 您需要联系{ks_product_both}的服务支持团队获取{ks_product_left} v4.1.0 安装包。 + +// 如实施现场条件允许在线拉取公开仓库，具备在线安装条件，可联系 KubeSphere 产品团队获取在线安装文件及相关信息。 + +:relfileprefix: ../../../ + +* 您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅xref:03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc[安装 Kubernetes 和 KubeSphere 企业版]。 + +:relfileprefix: ./ + +-- +// Warning +include::../../../../_ks_components/admonitions/warning.adoc[] + +如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere 企业版] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，删除节点后集群可能会出现错误。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + + +== 操作步骤 + +// ifeval::["{file_output_type}" == "html"] +// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[] +// endif::[] + +// ifeval::["{file_output_type}" == "pdf"] +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[] +// endif::[] + +. 执行以下命令查看需要删除的节点的名称： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +kubectl get node + +---- +-- + +. 执行以下命令将需要删除的节点上运行的容器组驱逐到其他节点（将 替换为需要删除的节点的名称）： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +kubectl drain + +---- +-- + ++ + +include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-transferConfig.adoc[] + ++ + +. 执行以下命令开始删除节点： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + + ./kk delete node -f config-sample.yaml + +---- +-- + +. 执行以下命令查看当前集群节点： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +kubectl get node + +---- + +如果没有显示已删除节点的信息，则表明节点删除成功。 +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/_index.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/_index.adoc new file mode 100644 index 000000000..8630edd5e --- /dev/null +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/_index.adoc @@ -0,0 +1,9 @@ +--- +title: "添加和删除集群节点" +keywords: "Kubernetes, {ks_product}, 添加集群节点, 删除集群节点" +description: "介绍如何添加和删除{ks_product_both}集群节点。" +weight: 05 +--- + + +本节介绍如何添加和删除{ks_product_both}集群节点。 diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/_index.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/_index.adoc new file mode 100644 index 000000000..3c7d61edb --- /dev/null +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/_index.adoc @@ -0,0 +1,40 @@ +--- +title: "安装指南" +keywords: "Kubernetes, {ks_product}, 安装, 升级, 卸载" +description: "介绍如何安装、升级和卸载{ks_product_left}。" +weight: 03 +--- + +// 导出说明：此文档用于离线交付 pdf 版本，不可与 03-install-and-uninstall 同时存在。 + +本节介绍如何安装、升级和卸载{ks_product_left}，以及如何添加和删除{ks_product_both}集群节点。 + +ifeval::["{file_output_type}" == "pdf"] +== 产品版本 + +本文档适用于{ks_product_left} v4.1.0 版本。 + +== 读者对象 + +本文档主要适用于以下读者： + +* {ks_product_right}用户 + +* 交付工程师 + +* 运维工程师 + +* 售后工程师 + + +== 修订记录 + +[%header,cols="1a,1a,3a"] +|=== +|文档版本 |发布日期 |修改说明 + +|01 +|{pdf_releaseDate} +|第一次正式发布。 +|=== +endif::[] \ No newline at end of file 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 new file mode 100644 index 000000000..91e437120 --- /dev/null +++ b/content/zh/docs/v4.1/04-platform-management/01-platform-features.adoc @@ -0,0 +1,44 @@ +--- +title: "平台介绍" +weight: 01 +--- + +{ks_product_right}采用细粒度权限控制机制。根据用户角色不同，{ks_product_right} Web 控制台也有所不同。 + +本节以具有 platform-admin 角色的用户视角，介绍{ks_product_both} Web 控制台的模块及功能。 + + +[%header,cols="1a,4a"] +|=== +|模块 |功能 + +|扩展市场 +|扩展组件的商店，支持订阅、安装、卸载、配置、升级扩展组件等。 + +|应用商店 +|应用商店提供了基于 Helm Chart 的应用模板，支持搜索、安装应用到某一项目。 + +.5+|工作台 +|集群管理：从基础设施视角管理资源，支持添加成员集群、编辑集群信息、更新 kubeconfig、移除成员集群等操作。 + +|企业空间管理：提供跨集群共享资源的能力，支持创建企业空间、编辑企业空间信息、删除企业空间等操作。 + +|用户和角色管理：创建用户/平台角色、编辑用户/平台角色信息、启用和禁用用户、修改用户角色、编辑平台角色信息&权限，删除用户/平台角色。 + +|扩展中心：管理已订阅的扩展组件，如安装、卸载、配置、禁用、升级扩展组件等。 + +|快捷访问：支持对集群、企业空间、项目等资源的快速访问。 + +|扩展组件 +|平台级、多集群和多租户级扩展组件的全局访问入口，支持快捷访问已安装的扩展组件。 + +|平台设置 +|查看并自定义平台信息，管理许可证。 +|=== + + +include::../../../_ks_components/admonitions/note.adoc[] + +关于各个功能的详细介绍，请参照对应的管理指南。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] \ No newline at end of file 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 new file mode 100644 index 000000000..daf43192b --- /dev/null +++ b/content/zh/docs/v4.1/04-platform-management/02-quick-access.adoc @@ -0,0 +1,17 @@ +--- +title: "快捷访问" +weight: 02 +--- + +本节介绍如何添加或移除对集群、企业空间、项目等资源的快捷访问，以便快速进入对应资源的管理页面。 + +== 前提条件 + +已获取{ks_product_left} Web 控制台的用户名和密码。 + +== 操作步骤 + +. 登录{ks_product_left} Web 控制台。 +. 在集群列表、企业空间列表、项目列表页面，点击image:/images/ks-qkcp/zh/icons/star_none.svg[star_none,18,18]，即可添加对应资源到**工作台**的**快捷访问**区域。点击image:/images/ks-qkcp/zh/icons/star.svg[star,18,18]，即可从快捷访问中移除该资源。 ++ +也可在**快捷访问**区域点击image:/images/ks-qkcp/zh/icons/star.svg[star,18,18]，移除已添加的资源。 diff --git a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/01-view-and-customize-platform-information.adoc b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/01-view-and-customize-platform-information.adoc new file mode 100644 index 000000000..0647d7564 --- /dev/null +++ b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/01-view-and-customize-platform-information.adoc @@ -0,0 +1,61 @@ +--- +title: "查看和定制平台信息" +keywords: "Kubernetes, {ks_product}, 平台设置, 平台信息, 查看和定制平台信息" +description: "介绍如何查看和定制平台信息。" +weight: 01 +--- + + +:ks_navigation: **平台信息** +:ks_permission: **平台设置管理** + + +本节介绍如何查看和定制{ks_product_left} Web 控制台的信息。 + +== 前提条件 + +:relfileprefix: ../../../ + +include::../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +== 操作步骤 + +include::../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 + ++ + +include::../../../../_ks_components/oper-navigate.adoc[] ++ +-- +**平台信息**页面显示平台的访问地址、标题、描述、标识、浏览器图标和登录页面背景图片。 +-- + +. 在页面右上角点击**自定义平台信息**。 + +. 在**自定义平台信息**对话框设置平台的信息，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|平台标题 +|平台的名称。平台标题可包含任意字符，最长 63 个字符。 + +|平台描述 +|描述可包含任意字符，最长 256 个字符。 + +|平台标识 +|Web 控制台界面上方显示的标识。图片格式可以为 SVG、PNG 或 JPG，图片文件大小不能超过 2 MB，推荐的图片分辨率为 200 x 40 像素。 + +|浏览器图标 +|浏览器页签的图标。图片格式可以为 ICO、SVG、PNG 或 JPG，图片文件大小不能超过 2 MB，推荐图片分辨率为 40 x 40 像素，推荐长宽比为 1:1。 + +|登录页面背景图片 +|平台登录页面的背景图片。图片格式可以为 SVG、PNG 或 JPG，图片文件大小不能超过 2 MB，推荐的图片分辨率为 1920 x 1080 像素。 +|=== +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/01-view-license-information.adoc b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/01-view-license-information.adoc new file mode 100644 index 000000000..e3ab522be --- /dev/null +++ b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/01-view-license-information.adoc @@ -0,0 +1,117 @@ +--- +title: "查看许可证信息" +keywords: "Kubernetes, {ks_product}, 平台设置, 许可证, 查看许可证信息" +description: "介绍如何查看许可证信息。" +weight: 01 +--- + +:ks_navigation: **许可证** +:ks_permission: **平台设置管理** + + +本节介绍如何查看许可证信息。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +. 在**许可证信息**页签，查看{ks_product_both}和已安装扩展组件的许可证。 ++ +==== +* {ks_product_both}许可 ++ +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|授权组织 +|被授权使用{ks_product_both}的组织。 + +|授权状态 +| +* **未授权**：未获得{ks_product_both}的许可证。 +* **授权已过期**：{ks_product_left}的许可证已过期。 +* **授权数量不足**：当前集群规模超出被许可使用{ks_product_both}的集群规模。 +* **已授权**：{ks_product_left}授权正常。 + +|维保状态 +| +* **无维保**：不享受维保服务。 +* **维保过期**：维保服务已过期。 +* **维保中**：在维保服务期内。 + +|集群 ID +|当前集群 ID，用于判断集群是否享有授权。 + +|授权类型 +|**未输入激活码**、**订阅**或**永久授权**。 + +|授权用量 +|显示当前集群规模以及被许可使用{ks_product_both}的集群规模，单位为**核**。 + +|生效时间 +|许可证的生效时间。 + +|截止时间 +|许可证的过期时间。 +|=== + +* 扩展组件许可 ++ +-- +显示当前平台已安装的扩展组件的许可证。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|扩展组件的名称。 + +|授权状态 +| +* **未授权**：未获得{ks_product_both}的许可证。 +* **授权已过期**：{ks_product_left}的许可证已过期。 +* **授权数量不足**：当前集群规模超出被许可使用{ks_product_both}的集群规模。 +* **已授权**：{ks_product_left}授权正常。 + +|授权类型 +|**未输入激活码**、**订阅**或**永久授权**。 + +|授权单位 +|CPU 或 vCPU。 + +|授权用量 +|显示当前集群规模以及被许可使用{ks_product_both}的集群规模，单位为**核**。 + +|生效时间 +|许可证的生效时间。 + +|截止时间 +|许可证的过期时间。 +|=== + +* 在列表上方点击搜索框并输入组件名称，可搜索组件的许可证。 + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +-- +==== \ No newline at end of file diff --git a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/03-add-a-license.adoc b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/03-add-a-license.adoc new file mode 100644 index 000000000..231f2309f --- /dev/null +++ b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/03-add-a-license.adoc @@ -0,0 +1,47 @@ +--- +title: "添加许可证" +keywords: "Kubernetes, {ks_product}, 平台设置, 许可证, 管理许可证" +description: "介绍如何管理许可证。" +weight: 03 +--- + +:ks_navigation: **许可证** +:ks_permission: **平台设置管理** + + +本节介绍如何添加许可证。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + +. 点击**许可证管理**页签，查看已添加的许可证信息。 + +. 点击**添加许可证**，输入激活码，点击**确定**完成添加。 ++ +-- +* 许可证添加完成后将显示在许可证管理列表中。 + +* 在列表上方点击搜索框并输入组件名称，可搜索组件的许可证。 + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/05-delete-a-license.adoc b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/05-delete-a-license.adoc new file mode 100644 index 000000000..c0866d282 --- /dev/null +++ b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/05-delete-a-license.adoc @@ -0,0 +1,46 @@ +--- +title: "删除许可证" +keywords: "Kubernetes, {ks_product}, 平台设置, 许可证, 管理许可证" +description: "介绍如何管理许可证。" +weight: 05 +--- + +:ks_navigation: **许可证** +:ks_permission: **平台设置管理** + + +本节介绍如何删除许可证。 + +[.admon.warning,cols="a"] +|=== +|警告 + +|许可证被删除后，您将丢失该组件的授权，请谨慎执行此操作。 + +|=== + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + +. 点击**许可证管理**页签，查看已添加的许可证信息。 + +. 在需要删除的许可证右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]。 + +. 在**删除许可证**对话框，输入组件的名称，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/07-faq.adoc b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/07-faq.adoc new file mode 100644 index 000000000..805dc3263 --- /dev/null +++ b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/07-faq.adoc @@ -0,0 +1,20 @@ +--- +title: "许可证 FAQ" +weight: 07 +--- + +== 添加 license 时报错 + +问题描述：添加许可证时报错 `admission webhook "validator.config.kubesphere.io" denied the request: license for whizard-telemetry already exist` + +原因：添加 license 或者 license bundle 时，其中的 whizard-telemetry（WhizardTelemetry 平台服务） 的 license 已在{ks_product_both}平台中存在。 + +解决办法：删除原有的 whizard-telemetry 许可证，再添加新的许可证。 + +[.admon.attention,cols="a"] +|=== +|注意 + +| +license 过期后，也要先删除过期的 license，再添加新的 license。 +|=== diff --git a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/_index.adoc b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/_index.adoc new file mode 100644 index 000000000..b09069ae2 --- /dev/null +++ b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/02-license/_index.adoc @@ -0,0 +1,14 @@ +--- +title: "许可证" +keywords: "Kubernetes, {ks_product}, 平台设置, 许可证" +description: "介绍如何管理{ks_product_both}平台和扩展组件的许可证。" +weight: 02 +--- + + +本节介绍如何查看及管理{ks_product_both}平台和扩展组件的许可证。 + +{ks_product_right}许可证，用于激活{ks_product_both}平台。如果您需要购买或更新平台许可证，请联系 KubeSphere 技术支持。 + +扩展组件许可证，用于激活某些需购买的扩展组件，此处仅展示扩展组件的授权信息。 +有关扩展组件许可的更多信息，请访问扩展中心的组件详情页，联系扩展组件供应商获取支持。 \ No newline at end of file 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 new file mode 100644 index 000000000..c735b5d0f --- /dev/null +++ b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/_index.adoc @@ -0,0 +1,7 @@ +--- +title: "平台设置" +weight: 03 +--- + + +本节介绍如何管理{ks_product_left} Web 控制台的基本信息以及许可证。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/04-platform-management/_index.adoc b/content/zh/docs/v4.1/04-platform-management/_index.adoc new file mode 100644 index 000000000..68a9a0aa2 --- /dev/null +++ b/content/zh/docs/v4.1/04-platform-management/_index.adoc @@ -0,0 +1,38 @@ +--- +title: "平台管理" +keywords: "Kubernetes, {ks_product}, 平台管理" +description: "介绍{ks_product_both}各模块的功能，以及如何对该平台进行设置。" +weight: 04 +--- + +本节介绍{ks_product_both}各模块的功能，以及如何对该平台进行设置。 + +ifeval::["{file_output_type}" == "pdf"] +== 产品版本 + +本文档适用于{ks_product_left} v4.1.0 版本。 + +== 读者对象 + +本文档主要适用于以下读者： + +* {ks_product_right}用户 + +* 交付工程师 + +* 运维工程师 + +* 售后工程师 + + +== 修订记录 + +[%header,cols="1a,1a,3a"] +|=== +|文档版本 |发布日期 |修改说明 + +|01 +|{pdf_releaseDate} +|第一次正式发布。 +|=== +endif::[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/05-users-and-roles/01-users/01-create-a-user.adoc b/content/zh/docs/v4.1/05-users-and-roles/01-users/01-create-a-user.adoc new file mode 100644 index 000000000..9e68bfa56 --- /dev/null +++ b/content/zh/docs/v4.1/05-users-and-roles/01-users/01-create-a-user.adoc @@ -0,0 +1,47 @@ +--- +title: "创建用户" +keywords: "Kubernetes, {ks_product}, 访问控制, 用户, 创建用户" +description: "介绍如何创建用户。" +weight: 01 +--- + +:ks_menu: **用户和角色管理** +:ks_navigation: **用户** +:ks_permission: **用户管理** + +本节介绍如何创建用户。 + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅link:../../01-users/[用户]和link:../../02-platform-roles/[平台角色]。 + + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 点击pass:a,q[{ks_menu}]。 +. 在左侧导航栏选择**用户**。 +. 在页面点击**创建**。 +. 在**创建用户**对话框，设置用户的信息，然后点击**确定**。 ++ +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|用户名 +|用户的名称。用户名只能包含小写字母、数字、连字符（-）和句点（.），必须以小写字母或数字开头及结尾，最长 32 个字符。 + +|邮箱 +|用户的邮箱地址。邮箱地址可用于登录{ks_product_left} Web 控制台。 + +|平台角色 +|用户在{ks_product_both}平台的角色。平台角色将决定用户在{ks_product_both}的权限。 + +|密码 +|用户的密码。密码必须包含数字、大写字母、小写字母和特殊字符，长度为 8 至 64 个字符。 + +|描述 +|用户的描述信息。描述可包含任意字符，最长 256 个字符。 +|=== + +用户创建完成后将显示在用户列表中。 diff --git a/content/zh/docs/v4.1/05-users-and-roles/01-users/02-view-a-user-list.adoc b/content/zh/docs/v4.1/05-users-and-roles/01-users/02-view-a-user-list.adoc new file mode 100644 index 000000000..b85962af6 --- /dev/null +++ b/content/zh/docs/v4.1/05-users-and-roles/01-users/02-view-a-user-list.adoc @@ -0,0 +1,59 @@ +--- +title: "查看用户列表" +keywords: "Kubernetes, {ks_product}, 访问控制, 用户, 查看用户列表" +description: "介绍如何查看用户列表。" +weight: 02 +--- + +:ks_menu: **用户和角色管理** +:ks_navigation: **用户** +:ks_permission: **用户查看** + +本节介绍如何查看用户列表。 + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅link:../../01-users/[用户]和link:../../02-platform-roles/[平台角色]。 + + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 点击pass:a,q[{ks_menu}]。 +. 在左侧导航栏选择**用户**。 + ++ +* 用户列表提供以下信息： ++ +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|用户名 +|用户的名称。 + +|状态 +|用户当前的状态。 + +* **活跃**：用户当前状态正常。 + +* **等待中**：系统正在创建用户。 + +* **已禁用**：用户被平台管理员禁用，无法登录{ks_product_left} Web 控制台。 + +* **限制登录**：用户在 10 分钟内连续 10 次登录失败，在 10 分钟内被禁止登录{ks_product_left} Web 控制台。 + +|平台角色 +|用户在{ks_product_both}平台的角色。 + +|最近登录 +|用户最后一次登录{ks_product_left}平台的时间。 + +|=== + + +* 在列表上方点击搜索框并输入关键字，可搜索用户名包含特定关键字的用户。 + +* 在列表右上角点击image:/images/ks-qkcp/zh/icons/refresh-light.svg[refresh,18,18]可刷新列表信息。 + +* 在列表右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]可定制列表中显示的信息。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/05-users-and-roles/01-users/03-view-user-details.adoc b/content/zh/docs/v4.1/05-users-and-roles/01-users/03-view-user-details.adoc new file mode 100644 index 000000000..72cadfc70 --- /dev/null +++ b/content/zh/docs/v4.1/05-users-and-roles/01-users/03-view-user-details.adoc @@ -0,0 +1,62 @@ +--- +title: "查看用户详情" +keywords: "Kubernetes, {ks_product}, 访问控制, 用户, 查看用户详情" +description: "介绍如何查看用户详情。" +weight: 03 +--- + +:ks_menu: **用户和角色管理** +:ks_navigation: **用户** +:ks_permission: **用户查看** + + +本节介绍如何查看用户详情。 + + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅link:../../01-users/[用户]和link:../../02-platform-roles/[平台角色]。 + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 点击pass:a,q[{ks_menu}]。 +. 在左侧导航栏选择**用户**。 +. 在用户列表中点击一个用户的名称打开其详情页面。 +. 在用户详情页面左侧的**属性**区域查看用户的资源属性。 + ++ +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|平台角色 +|用户的平台角色。 + +|邮箱 +|用户的邮箱地址。 + +|最近登录 +|用户最后一次登录{ks_product_left} Web 控制台的时间。 +|=== + +. 在用户详情页面右侧的**登录历史**页签查看用户的登录历史记录。 ++ + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|时间 +|用户的登录时间。 + +|状态 +|用户是否登录成功。 + +|源 IP 地址 +|用户登录{ks_product_left} Web 控制台的客户端 IP 地址。 + +|原因 +|如果用户登录失败，显示登录失败的原因。 +|=== + diff --git a/content/zh/docs/v4.1/05-users-and-roles/01-users/04-edit-user-information.adoc b/content/zh/docs/v4.1/05-users-and-roles/01-users/04-edit-user-information.adoc new file mode 100644 index 000000000..c312a7f6c --- /dev/null +++ b/content/zh/docs/v4.1/05-users-and-roles/01-users/04-edit-user-information.adoc @@ -0,0 +1,44 @@ +--- +title: "编辑用户信息" +keywords: "Kubernetes, {ks_product}, 访问控制, 用户, 编辑用户信息" +description: "介绍如何编辑用户信息。" +weight: 04 +--- + +:ks_menu: **用户和角色管理** +:ks_navigation: **用户** +:ks_permission: **用户管理** + + +本节介绍如何编辑用户信息。 + +您可以编辑用户的邮箱、平台角色和描述。{ks_product_right}不支持编辑已创建用户的用户名。 + + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅link:../../01-users/[用户]和link:../../02-platform-roles/[平台角色]。 + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 点击pass:a,q[{ks_menu}]。 +. 在左侧导航栏选择**用户**。 +. 在需要操作的用户右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑**。 +. 在**编辑用户**对话框，设置用户的信息，然后点击**确定**。 + ++ +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|邮箱 +|用户的邮箱地址。邮箱地址可用于登录{ks_product_left} Web 控制台。 + +|平台角色 +|用户在{ks_product_both}平台的角色。平台角色将决定用户在{ks_product_both}的权限。 + +|描述 +|用户的描述信息。描述可包含任意字符，最长 256 个字符。 +|=== + diff --git a/content/zh/docs/v4.1/05-users-and-roles/01-users/05-change-the-email-language-and-language.adoc b/content/zh/docs/v4.1/05-users-and-roles/01-users/05-change-the-email-language-and-language.adoc new file mode 100644 index 000000000..8fd4aa007 --- /dev/null +++ b/content/zh/docs/v4.1/05-users-and-roles/01-users/05-change-the-email-language-and-language.adoc @@ -0,0 +1,35 @@ +--- +title: "编辑当前用户信息" +keywords: "Kubernetes, {ks_product}, 集群管理, Web 控制台, 修改邮箱、语言" +description: "介绍如何修改当前用户的邮箱和语言。" +weight: 05 +--- + +本节介绍如何修改当前用户的邮箱和界面显示语言。 + + +== 前提条件 + +已获取{ks_product_left} Web 控制台的用户名和密码。 + + +== 操作步骤 + +. 登录{ks_product_left} Web 控制台。 + +. 在页面右上角点击当前用户名，然后在下拉列表中选择**用户设置**。 + +. 在**基本信息**页签设置用户的邮箱和语言。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|邮箱 +|用户的邮箱地址。邮箱地址可用于登录{ks_product_left} Web 控制台。 + +|语言 +|{ks_product_right} Web 控制台对当前用户显示的语言。 +|=== +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/05-users-and-roles/01-users/06-change-the-password-of-a-user.adoc b/content/zh/docs/v4.1/05-users-and-roles/01-users/06-change-the-password-of-a-user.adoc new file mode 100644 index 000000000..423f40a89 --- /dev/null +++ b/content/zh/docs/v4.1/05-users-and-roles/01-users/06-change-the-password-of-a-user.adoc @@ -0,0 +1,34 @@ +--- +title: "修改用户密码" +keywords: "Kubernetes, {ks_product}, 访问控制, 用户, 修改用户密码" +description: "介绍如何修改用户密码。" +weight: 06 +--- + +:ks_menu: **用户和角色管理** +:ks_navigation: **用户** +:ks_permission: **用户管理** + + +本节介绍如何修改用户密码。 + +== 修改当前用户的密码 + +. 登录{ks_product_left} Web 控制台。 + +. 在页面右上角点击当前用户名，然后在下拉列表中选择**用户设置**。 + +. 点击**密码设置**⻚签可修改当前⽤⼾的密码。 ++ +密码必须包含至少一个数字、一个小写字母、一个大写字母和一个特殊字符（~!@#$%^&*()-_=+\|[{}];:'",<.>/? 或空格），长度为 8 到 64 个字符。 + +== 修改其他用户的密码 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 点击pass:a,q[{ks_menu}]。 +. 在左侧导航栏选择**用户**。 +. 在用户列表中点击一个用户的名称打开其详情页面。 +. 在用户详情页面左上角，选择**更多操作 > 修改密码**。 +. 在**修改密码**对话框，设置新密码并重复输入新密码，然后点击**确定**。 ++ +密码必须包含至少一个数字、一个小写字母、一个大写字母和一个特殊字符（~!@#$%^&*()-_=+\|[{}];:'",<.>/? 或空格），长度为 8 到 64 个字符。 diff --git a/content/zh/docs/v4.1/05-users-and-roles/01-users/07-two-factor-authentication.adoc b/content/zh/docs/v4.1/05-users-and-roles/01-users/07-two-factor-authentication.adoc new file mode 100644 index 000000000..cd325a41a --- /dev/null +++ b/content/zh/docs/v4.1/05-users-and-roles/01-users/07-two-factor-authentication.adoc @@ -0,0 +1,56 @@ +--- +title: "开启和关闭二次认证" +weight: 07 +--- + +本节介绍如何为当前用户开启和关闭二次认证。 + +开启二次认证后，用户登录时，输入账号和密码之后，还必须输入身份认证器生成的动态认证口令。借助二次认证，用户通过密码和手机为账户提供双重保护。 + + +== 前提条件 + +已获取{ks_product_left} Web 控制台的用户名和密码。 + + +== 开启二次认证 + +. 登录{ks_product_left} Web 控制台。 + +. 在页面右上角点击当前用户名，然后在下拉列表中选择**用户设置**。 + +. 在**二次认证**页签点击**开启二次认证**。 + +. 在手机上的各大应用市场搜索关键词 “Authenticator” 或 “身份认证器”，下载身份认证器 App。推荐使用 Google Authenticator。安装完成后，在{ks_product_left} Web 控制台点击**下一步**。 + +. 打开身份认证器 App，点击“扫描二维码”扫描右侧二维码。扫描完成后，在{ks_product_left} Web 控制台点击**下一步**。 + +. 输入身份认证器 App 生成的动态认证码，点击**认证并开启**开启二次认证。 ++ +-- + +至此，二次认证开启完成。再次登录{ks_product_left} Web 控制台时，输入账号和密码之后，还必须输入身份认证器 App 生成的动态认证码。 + +image:/images/ks-qkcp/zh/v4.1/enable-two-factor-authentication.png[ enable-two-factor-authentication,50%] +-- + +== 关闭二次认证 + +. 登录{ks_product_left} Web 控制台。 + +. 在页面右上角点击当前用户名，然后在下拉列表中选择**用户设置**。 + +. 在**二次认证**页签点击**关闭二次认证**。 + +. 在**关闭二次认证**对话框，输入身份认证器 App 生成的动态认证码，然后点击**确定**。 ++ +image:/images/ks-qkcp/zh/v4.1/disable-two-factor-authentication.png[ disable-two-factor-authentication,100%] + +=== 无法获取动态口令 + +若无法获取二次认证动态口令，导致无法登录，可联系管理员执行以下命令关闭二次认证。 + +[,bash] +---- +kubectl annotate user iam.kubesphere.io/totp-auth-key-ref- +---- \ No newline at end of file diff --git a/content/zh/docs/v4.1/05-users-and-roles/01-users/09-enable-and-disable-users.adoc b/content/zh/docs/v4.1/05-users-and-roles/01-users/09-enable-and-disable-users.adoc new file mode 100644 index 000000000..496064422 --- /dev/null +++ b/content/zh/docs/v4.1/05-users-and-roles/01-users/09-enable-and-disable-users.adoc @@ -0,0 +1,33 @@ +--- +title: "启用和禁用用户" +keywords: "Kubernetes, {ks_product}, 访问控制, 用户, 启用和禁用用户" +description: "介绍如何启用和禁用用户。" +weight: 09 +--- + +:ks_menu: **用户和角色管理** +:ks_navigation: **用户** +:ks_permission: **用户管理** + +本节介绍如何启用和禁用用户。 + +用户被禁用后将无法登录{ks_product_left} Web 控制台。 + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅link:../../01-users/[用户]和link:../../02-platform-roles/[平台角色]。 + +== 启用和禁用单个用户 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 点击pass:a,q[{ks_menu}]。 +. 在左侧导航栏选择**用户**。 +. 在需要操作的用户右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**启用**或**禁用**。 + + +== 批量启用和禁用用户 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 点击pass:a,q[{ks_menu}]。 +. 在左侧导航栏选择**用户**。 +. 选择需要操作的用户左侧的复选框，然后在列表上方点击**启用**或**禁用**。 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 new file mode 100644 index 000000000..1e1cb272e --- /dev/null +++ b/content/zh/docs/v4.1/05-users-and-roles/01-users/10-delete-users.adoc @@ -0,0 +1,39 @@ +--- +title: "删除用户" +keywords: "Kubernetes, KubeSphere, 访问控制, 用户, 删除用户" +description: "介绍如何删除用户。" +weight: 10 +--- + +:ks_menu: **用户和角色管理** +:ks_navigation: **用户** +:ks_permission: **删除用户** + + +本节介绍如何删除用户。 + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅link:../../01-users/[用户]和link:../../02-platform-roles/[平台角色]。 + +== 删除单个用户 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 点击pass:a,q[{ks_menu}]。 +. 在左侧导航栏选择**用户**。 +. 在需要删除的用户右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 +. 在**删除用户**对话框输入用户的名称，然后点击**确定**。 + + +== 批量删除用户 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 点击pass:a,q[{ks_menu}]。 +. 在左侧导航栏选择**用户**。 +. 选择需要删除的用户左侧的复选框，然后在列表上方点击**删除**。 +. 在**批量删除用户**对话框，输入用户的名称，然后点击**确定**。 ++ +include::../../../../_ks_components/admonitions/note.adoc[] +请使用半角逗号（,）和空格分隔多个名称。 +include::../../../../_ks_components/admonitions/admonEnd.adoc[] + diff --git a/content/zh/docs/v4.1/05-users-and-roles/01-users/_index.adoc b/content/zh/docs/v4.1/05-users-and-roles/01-users/_index.adoc new file mode 100644 index 000000000..50d0e5d63 --- /dev/null +++ b/content/zh/docs/v4.1/05-users-and-roles/01-users/_index.adoc @@ -0,0 +1,11 @@ +--- +title: "用户" +keywords: "Kubernetes, {ks_product}, 访问控制, 用户" +description: "介绍如何管理用户。" +weight: 02 +--- + + +本节介绍如何管理用户。 + +{ks_product_right}的默认管理员用户 **admin** 在{ks_product_both}平台具有所有权限，并可以根据需要创建其他用户。用户可以受邀加入集群和企业空间，企业空间成员可以受邀加入各个项目，即用户可以是集群、企业空间、项目下的成员。 diff --git a/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/01-create-a-platform-role.adoc b/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/01-create-a-platform-role.adoc new file mode 100644 index 000000000..f0629eb16 --- /dev/null +++ b/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/01-create-a-platform-role.adoc @@ -0,0 +1,120 @@ +--- +title: "创建平台角色" +keywords: "Kubernetes, {ks_product}, 平台管理, 访问控制, 平台角色, 创建平台角色" +description: "介绍如何创建平台角色。" +weight: 01 +--- + +:ks_menu: **用户和角色管理** +:ks_navigation: **平台角色** + + +本节介绍如何创建平台角色。 + +{ks_product_right}平台提供以下预置平台角色，您也可以创建角色以自定义角色权限。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|platform-admin +|平台管理员，在{ks_product_both}平台具有所有权限，包括平台角色管理、用户管理、平台设置管理、安装和卸载扩展组件等。 + +|platform-regular +|平台普通用户，在平台级别只有应用查看权限。该角色一般授予不需要其他平台权限的企业空间成员。 + +|platform-self-provisioner +|创建企业空间并成为所创建的企业空间的管理员。 +|=== + + +== 前提条件 + +您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../01-users/[用户]和link:../../02-platform-roles/[平台角色]。 + +== 操作步骤 + +. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 +. 点击pass:a,q[{ks_menu}]。 +. 在左侧导航栏选择**平台角色**。 +. 在页面点击**创建**。 +. 在**创建平台角色**对话框，设置平台角色的名称、别名和描述，然后点击**编辑权限**。 ++ +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|平台角色的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 + +|别名 +|平台角色的别名。不同企业空间角色的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|平台角色的描述信息。描述可包含任意字符，最长 256 个字符。 +|=== + +. 在**编辑权限**对话框，设置平台角色的权限，然后点击**确定**。 ++ +-- +平台角色可设置的权限如下： + +// * 应用商店管理 +// + +// [%header,cols="1a,4a"] +// |=== +// |权限 |允许操作 + +// |应用商店管理 +// |管理{ks_product_both}平台的应用商店，如应用审核、上架、下架等。 +// |=== + +* 企业空间 ++ +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|企业空间创建 +|创建企业空间。 + +|企业空间管理 +|管理所有企业空间和企业空间下的资源。 + +|企业空间查看 +|查看所有企业空间和企业空间下的资源。 +|=== + +* 集群管理 ++ +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|集群管理 +|创建集群、删除集群和管理集群中的所有资源。 + +|集群查看 +|查看所有集群和集群资源。 +|=== + +* 访问控制 ++ +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|角色查看 +|查看平台角色列表、查看平台角色详情。 + +|用户查看 +|查看用户列表、查看用户详情。 + +// |用户管理 +// |创建用户、编辑用户信息、启用和禁用用户、修改用户角色、删除用户。 + +// |角色管理 +// |创建平台角色、编辑平台角色信息、编辑平台角色权限、删除平台角色。 +|=== +-- + diff --git a/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/02-view-a-platform-role-list.adoc b/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/02-view-a-platform-role-list.adoc new file mode 100644 index 000000000..ea600f998 --- /dev/null +++ b/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/02-view-a-platform-role-list.adoc @@ -0,0 +1,27 @@ +--- +title: "查看平台角色列表" +keywords: "Kubernetes, {ks_product}, 平台管理, 访问控制, 平台角色, 查看平台角色列表" +description: "介绍如何查看平台角色列表。" +weight: 02 +--- + +:ks_menu: **用户和角色管理** +:ks_permission: **角色查看** +:ks_navigation: **平台角色** + + +本节介绍如何查看平台角色列表。 + + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅link:../../01-users/[用户]和link:../../02-platform-roles/[平台角色]。 + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 点击pass:a,q[{ks_menu}]。 +. 在左侧导航栏选择**平台角色**。 ++ +平台角色列表提供角色的名称、描述和创建时间。 + diff --git a/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/03-view-platform-role-details.adoc b/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/03-view-platform-role-details.adoc new file mode 100644 index 000000000..0a99d3e11 --- /dev/null +++ b/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/03-view-platform-role-details.adoc @@ -0,0 +1,31 @@ +--- +title: "查看平台角色详情" +keywords: "Kubernetes, {ks_product}, 平台管理, 访问控制, 平台角色, 查看平台角色详情" +description: "介绍如何查看平台角色详情。" +weight: 03 +--- + +:ks_menu: **用户和角色管理** +:ks_permission: **角色查看** +:ks_navigation: **平台角色** + + +本节介绍如何查看平台角色详情。 + + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅link:../../01-users/[用户]和link:../../02-platform-roles/[平台角色]。 + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 点击pass:a,q[{ks_menu}]。 +. 在左侧导航栏选择**平台角色**。 +. 在平台角色列表点击一个平台角色的名称打开其详情页面。 +. 在平台角色详情页面的**权限**页签，查看当前角色拥有的权限。 +. 在平台角色详情页面点击**授权用户**页签，查看具有当前平台角色的用户。 ++ +-- +include::../../../_custom/clusterManagement/clusterRoles/clusterRoles-para-authorizedUsers.adoc[] +-- diff --git a/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/04-edit-platform-role-information.adoc b/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/04-edit-platform-role-information.adoc new file mode 100644 index 000000000..1f2111303 --- /dev/null +++ b/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/04-edit-platform-role-information.adoc @@ -0,0 +1,35 @@ +--- +title: "编辑平台角色信息" +keywords: "Kubernetes, {ks_product}, 平台管理, 访问控制, 平台角色, 编辑平台角色信息" +description: "介绍如何编辑平台角色信息。" +weight: 04 +--- + +:ks_menu: **用户和角色管理** +:ks_permission: **角色管理** +:ks_navigation: **平台角色** + + +本节介绍如何编辑平台角色信息。 + +您可以编辑由用户创建的平台角色的别名和描述。{ks_product_right}不支持编辑预置的平台角色，同时不支持编辑平台角色的名称。 + + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅link:../../01-users/[用户]和link:../../02-platform-roles/[平台角色]。 + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 点击pass:a,q[{ks_menu}]。 +. 在左侧导航栏选择**平台角色**。 +. 在需要操作的平台角色右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 +. 在**编辑信息**对话框，设置平台角色的别名和描述，然后点击**确定**。 ++ +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../_custom/platformManagement/accessControl/platformRoles/platformRoles-para-aliasDescription.adoc[] +|=== \ No newline at end of file diff --git a/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/05-edit-permissions-of-a-platform-role.adoc b/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/05-edit-permissions-of-a-platform-role.adoc new file mode 100644 index 000000000..640771769 --- /dev/null +++ b/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/05-edit-permissions-of-a-platform-role.adoc @@ -0,0 +1,90 @@ +--- +title: "编辑平台角色权限" +keywords: "Kubernetes, {ks_product}, 平台管理, 访问控制, 平台角色, 编辑平台角色权限" +description: "介绍如何编辑平台角色权限。" +weight: 05 +--- + +:ks_menu: **用户和角色管理** +:ks_permission: **角色管理** +:ks_navigation: **平台角色** + + +本节介绍如何编辑平台角色权限。 + +您只能编辑用户创建的平台角色权限。预置平台角色的权限无法编辑。 + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅link:../../01-users/[用户]和link:../../02-platform-roles/[平台角色]。 + + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 点击pass:a,q[{ks_menu}]。 +. 在左侧导航栏选择**平台角色**。 +. 在需要操作的平台角色右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑权限**。 +. 在**编辑权限**对话框，设置平台角色的权限，然后点击**确定**。 ++ +-- +平台角色可设置的权限如下： + +// * 应用商店管理 +// + +// [%header,cols="1a,4a"] +// |=== +// |权限 |允许操作 + +// |应用商店管理 +// |管理{ks_product_both}平台的应用商店，如应用审核、上架、下架等。 +// |=== + +* 企业空间 ++ +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|企业空间创建 +|创建企业空间。 + +|企业空间管理 +|管理所有企业空间和企业空间下的资源。 + +|企业空间查看 +|查看所有企业空间和企业空间下的资源。 +|=== + +* 集群管理 ++ +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|集群管理 +|创建集群、删除集群和管理集群中的所有资源。 + +|集群查看 +|查看所有集群和集群资源。 +|=== + +* 访问控制 ++ +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|角色查看 +|查看平台角色列表、查看平台角色详情。 + +|用户查看 +|查看用户列表、查看用户详情。 + +// |用户管理 +// |创建用户、编辑用户信息、启用和禁用用户、修改用户角色、删除用户。 + +// |角色管理 +// |创建平台角色、编辑平台角色信息、编辑平台角色权限、删除平台角色。 +|=== +-- diff --git a/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/06-delete-platform-roles.adoc b/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/06-delete-platform-roles.adoc new file mode 100644 index 000000000..6dadcf1cf --- /dev/null +++ b/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/06-delete-platform-roles.adoc @@ -0,0 +1,31 @@ +--- +title: "删除平台角色" +keywords: "Kubernetes, {ks_product}, 平台管理, 访问控制, 平台角色, 删除平台角色" +description: "介绍如何删除平台角色。" +weight: 06 +--- + +:ks_menu: **用户和角色管理** +:ks_permission: **角色管理** +:ks_navigation: **平台角色** + + +本节介绍如何删除平台角色。 + +您可以删除用户创建的平台角色。预置平台角色无法删除。 + + +== 前提条件 + +* 您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅link:../../01-users/[用户]和link:../../02-platform-roles/[平台角色]。 + +* 如果需要删除的平台角色已经分配给用户，您需要删除用户或修改其角色。 + + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 点击pass:a,q[{ks_menu}]。 +. 在左侧导航栏选择**平台角色**。 +. 在需要删除的平台角色右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 +. 在**删除角色**对话框点击**确定**。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/_index.adoc b/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/_index.adoc new file mode 100644 index 000000000..daefbfe07 --- /dev/null +++ b/content/zh/docs/v4.1/05-users-and-roles/02-platform-roles/_index.adoc @@ -0,0 +1,15 @@ +--- +title: "平台角色" +keywords: "Kubernetes, {ks_product}, 访问控制, 用户, 平台角色" +description: "介绍如何管理平台角色。" +weight: 03 +--- + + +本节介绍如何管理平台角色。 + +平台角色包含特定的平台管理或查看权限。您可以将包含特定权限的角色授权给用户，以控制用户的平台权限。 + +include::../../../_ks_components/admonitions/note.adoc[] +{ks_product_right}的默认管理员用户 **admin** 在{ks_product_both}平台具有所有权限。 +include::../../../../_ks_components/admonitions/admonEnd.adoc[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/05-users-and-roles/_index.adoc b/content/zh/docs/v4.1/05-users-and-roles/_index.adoc new file mode 100644 index 000000000..b0aa435e0 --- /dev/null +++ b/content/zh/docs/v4.1/05-users-and-roles/_index.adoc @@ -0,0 +1,61 @@ +--- +title: "用户和角色管理" +keywords: "Kubernetes, {ks_product}, 访问控制,用户,角色" +description: "介绍如何控制平台访问权限。" +weight: 05 +--- + + +{ks_product_right}是一个支持多租户的容器管理平台，与 Kubernetes 相同，它通过基于角色的访问控制（RBAC）对用户的权限加以控制，实现逻辑层面的资源隔离。 + +KubeSphere 中的资源被划分为平台、企业空间、集群、项目四个层级，所有的资源都会归属到这四个资源层级之中，各层级可以通过角色来控制用户的资源访问权限。每个层级默认设有多个内置角色，您也可以创建拥有自定义权限的角色。 + +企业空间作为最小的租户单元，提供跨集群的资源隔离能力。企业空间中的成员可以在授权集群中创建项目，并通过邀请用户的方式参与项目协同。 + +本节介绍如何在{ks_product_both}平台控制访问权限，包括用户和平台角色的管理。 + +ifeval::["{file_output_type}" == "html"] +有关集群角色的更多信息，请参阅link:../07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 + +有关企业空间角色的更多信息，请参阅link:../08-workspace-management/06-workspace-settings/04-workspace-roles/[企业空间角色]。 + +有关项目角色的更多信息，请参阅link:../09-project-management/06-project-settings/02-project-roles/[项目角色]。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +有关集群角色的更多信息，请参阅《{ks_product_right}集群管理指南》的“集群角色”章节。 + +有关企业空间角色的更多信息，请参阅《{ks_product_right}企业空间管理指南》的“企业空间角色”章节。 + +有关项目角色的更多信息，请参阅《{ks_product_right}项目管理指南》的“项目角色”章节。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +== 产品版本 + +本文档适用于{ks_product_left} v4.1.0 版本。 + +== 读者对象 + +本文档主要适用于以下读者： + +* {ks_product_right}用户 + +* 交付工程师 + +* 运维工程师 + +* 售后工程师 + + +== 修订记录 + +[%header,cols="1a,1a,3a"] +|=== +|文档版本 |发布日期 |修改说明 + +|01 +|{pdf_releaseDate} +|第一次正式发布。 +|=== +endif::[] \ No newline at end of file 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 new file mode 100644 index 000000000..d39408d43 --- /dev/null +++ b/content/zh/docs/v4.1/06-extension-user-guide/01-install-components-pdf.adoc @@ -0,0 +1,49 @@ +--- +title: "安装扩展组件" +keywords: "Kubernetes, KubeSphere,安装，组件，多集群" +description: "介绍如何安装扩展组件。" +weight: 01 +--- + +// 导出说明：此文档用于离线交付 pdf 版本，不可与 02-subscribe-and-install-components 同时存在。 + +本节介绍如何安装扩展组件。 + +== 前提条件 + +您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../05-users-and-roles/01-users/[用户]和link:../../05-users-and-roles/02-platform-roles/[平台角色]。 + +== 安装步骤 + +. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 + +. 点击**扩展中心**，查看扩展组件列表。 + +. 点击未安装的扩展组件右侧的**安装**按钮，进入组件安装页面。 + +. 在组件安装对话框的**版本选择**页签，选择扩展组件的版本号，并安装好所有必装组件，点击**下一步**。 + ++ + +include::../../../_ks_components/admonitions/note.adoc[] + +安装检测时，会识别扩展组件是否有依赖组件。依赖组件分为必装组件和选装组件。 + +若必装组件的状态为**未就绪**，您需要先行安装正确版本的必装组件，以确保扩展组件的正常使用。而选装组件不会影响扩展组件的安装。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] + +. 在**扩展组件安装**页签，修改扩展组件的配置后（可选），点击**开始安装**，开始安装扩展组件。 ++ +image:/images/ks-qkcp/zh/v4.0/install-extensions.png[,100%] + +. 在**集群选择**页签，根据名称，标识，标签选择集群，可选择多个集群。 + +. 在**差异化配置**页签，分别编辑选中集群的 YAML 配置，也可不修改，使用初始默认配置。点击**确定**，开始配置集群 Agent。 ++ +include::../../../_ks_components/admonitions/note.adoc[] +部分扩展组件可能需要安装集群 Agent，以便能正常使用扩展组件的功能。 + +include::../../../_ks_components/admonitions/admonEnd.adoc[] + +安装完成后，默认启用该组件。您可以在扩展中心配置、升级、禁用、卸载扩展组件，还可以点击顶部导航栏上的image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，查看使用该组件。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/01-subscribe-components.adoc b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/01-subscribe-components.adoc new file mode 100644 index 000000000..51f150d56 --- /dev/null +++ b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/01-subscribe-components.adoc @@ -0,0 +1,38 @@ +--- +title: "订阅扩展组件" +keywords: "Kubernetes, KubeSphere,订阅，组件，KubeSphere Cloud,云账号" +description: "介绍如何订阅扩展组件。" +weight: 01 +--- + +本节介绍如何订阅扩展组件。 + +在安装组件之前，您需要使用 KubeSphere 云账号在扩展市场订阅组件。 + +== 前提条件 + +* 以 platform-admin 角色登录到{ks_product_left} Web 控制台。 +* 已注册一个 https://kubesphere.cloud/login/[KubeSphere 云账号]。 + +== 操作步骤 + +. 点击{ks_product_left} Web 控制台左上角的**扩展市场**，进入扩展市场页面。 + +. 搜索您要安装的扩展组件，点击**订阅**。 ++ +-- +* 点击扩展组件名称进入组件的详情页面，查看基本信息、概览、更新日志、权限需求等。 +* 点击详情页面左侧的image:/images/ks-qkcp/zh/icons/chevron-down.svg[chevron-down,18,18]，选择扩展组件的版本。 +* 点击**订阅**安装当前版本的扩展组件。 +* 点击**查看文件**查看该扩展组件 Helm Chart 包中的所有文件。点击页面右侧的image:/images/ks-qkcp/zh/icons/copy.svg[copy,18,18]复制当前查看文件的内容，点击image:/images/ks-qkcp/zh/icons/download-dark.svg[download-dark,18,18]将当前查看的文件下载到本地。 +-- +. 如果您未绑定 https://kubesphere.cloud/login/[KubeSphere 云账号]，前往**扩展中心**绑定您的 KubeSphere 云账户，然后进入订阅流程。 +. 在订单确认与支付页面，选择**订阅方案**、**订阅时长**后，提交订单进行支付。 +. 支付完成后，在扩展市场的组件详情页面，点击**安装**，进入组件安装流程。 + ++ +include::../../../../_ks_components/admonitions/note.adoc[] + +扩展市场中部分组件可免费订阅，部分需要付费订阅。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/02-install-components.adoc b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/02-install-components.adoc new file mode 100644 index 000000000..de9697950 --- /dev/null +++ b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/02-install-components.adoc @@ -0,0 +1,55 @@ +--- +title: "安装扩展组件" +keywords: "Kubernetes, KubeSphere,安装，组件，多集群" +description: "介绍如何安装扩展组件。" +weight: 02 +--- + +本节介绍如何安装扩展组件。 + +== 前提条件 + +ifeval::["{file_output_type}" == "html"] +* 以 platform-admin 角色登录到{ks_product_left} Web 控制台。有关平台角色的更多信息，请参阅link:../../../05-users-and-roles/02-platform-roles/[平台角色]。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +* 以 platform-admin 角色登录到{ks_product_left} Web 控制台。有关平台角色的更多信息，请参阅《{ks_product_right}用户和角色管理指南》。 +endif::[] + +* 请先订阅您要安装的扩展组件。 + + +== 安装步骤 + +. 采用以下方式之一，进入安装页面，开始安装流程。 + +* 点击扩展市场中组件详情页的**安装**按钮，进入组件安装页面。 +* 在扩展中心绑定 KubeSphere 云账号后，对已订阅未安装的组件，点击右侧的**安装**按钮，进入组件安装页面。 + +. 在组件安装对话框的**版本选择**页签，选择扩展组件的版本号，并安装好所有必装组件，点击**下一步**。 + ++ + +include::../../../../_ks_components/admonitions/note.adoc[] + +安装检测时，会识别扩展组件是否有依赖组件。依赖组件分为必装组件和选装组件。 + +若必装组件的状态为**未就绪**，您需要先行安装正确版本的必装组件，以确保扩展组件的正常使用。而选装组件不会影响扩展组件的安装。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] + +. 在**扩展组件安装**页签，修改扩展组件的配置后（可选），点击**开始安装**，开始安装扩展组件。 ++ +image:/images/ks-qkcp/zh/v4.0/install-extensions.png[,100%] + +. 在**集群选择**页签，根据名称，标识，标签选择集群，可选择多个集群。 + +. 在**差异化配置**页签，分别编辑选中集群的 YAML 配置，也可不修改，使用初始默认配置。点击**确定**，开始配置集群 Agent。 ++ +include::../../../../_ks_components/admonitions/note.adoc[] +部分扩展组件可能需要安装集群 Agent，以便能正常使用扩展组件的功能。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] + +安装完成后，默认启用该组件。您可以在扩展中心配置、升级、禁用、卸载扩展组件，还可以点击顶部导航栏上的image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，查看使用该组件。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/01-sync-and-change-settings.adoc b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/01-sync-and-change-settings.adoc new file mode 100644 index 000000000..645e757af --- /dev/null +++ b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/01-sync-and-change-settings.adoc @@ -0,0 +1,27 @@ +--- +title: "同步和设置云账号" +keywords: "Kubernetes, {ks_product},同步,设置,KubeSphere Cloud,云账号" +description: "介绍如何同步和设置 KubeSphere 云账号。" +weight: 01 +--- + +本节介绍如何在扩展中心同步和设置 KubeSphere 云账号。 + +== 前提条件 + +* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../05-users-and-roles/01-users/[用户]和link:../../../../05-users-and-roles/02-platform-roles/[平台角色]。 +* 您需要在扩展中心授权登录 KubeSphere 云账号。 + +== 同步云账号 + +完成组件订阅后，若扩展中心的组件列表未更新，您可能需要手动同步订阅信息。 + +. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 +. 点击**扩展中心**。 +. 点击组件列表右上角的云账号头像，选择**同步云账户**，即可在组件列表查看您已订阅的所有组件。 + +== 设置云账号 +. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 +. 点击**扩展中心**。 +. 点击组件列表右上角的云账号头像，选择**云账户设置**。 +. 设置账号信息、安全验证、支付货币等。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/02-manage-your-subscriptions.adoc b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/02-manage-your-subscriptions.adoc new file mode 100644 index 000000000..7e496d482 --- /dev/null +++ b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/02-manage-your-subscriptions.adoc @@ -0,0 +1,22 @@ +--- +title: "管理订阅" +keywords: "Kubernetes, {ks_product},组件,订阅管理,KubeSphere Cloud,云账号" +description: "介绍如何管理 KubeSphere 云账号下已订阅的组件。" +weight: 02 + +--- + +本节介绍如何管理 KubeSphere 云账号下已订阅的组件。 + +== 前提条件 + +* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../05-users-and-roles/01-users/[用户]和link:../../../../05-users-and-roles/02-platform-roles/[平台角色]。 +* 您需要在扩展中心授权登录 KubeSphere 云账号。 + +== 操作步骤 + +. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 +. 点击**扩展中心**。 +. 点击组件列表右上角的头像，选择**订阅管理**。 +. 在订阅管理页面，查看各组件的订阅状态、订阅计划、订阅时长、到期时间等。 +. 在需要操作的组件右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**查看订单**，或**订阅**已过期的组件。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/03-manage-your-orders.adoc b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/03-manage-your-orders.adoc new file mode 100644 index 000000000..75739ca01 --- /dev/null +++ b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/03-manage-your-orders.adoc @@ -0,0 +1,21 @@ +--- +title: "管理订单" +keywords: "Kubernetes, {ks_product},组件,订单管理,KubeSphere Cloud,云账号" +description: "介绍如何管理 KubeSphere 云账号下的订单。" +weight: 03 +--- + +本节介绍如何管理 KubeSphere 云账号下的订单。 + +== 前提条件 + +* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../05-users-and-roles/01-users/[用户]和link:../../../../05-users-and-roles/02-platform-roles/[平台角色]。 +* 您需要在扩展中心授权登录 KubeSphere 云账号。 + +== 操作步骤 + +. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 +. 点击**扩展中心**。 +. 点击组件列表右上角的头像，选择**订单管理**。 +. 在订单页面，查看您账号下所有订单的详情，包括未支付完成的订单。 +. 点击未支付完成的订单，可以继续支付或取消订单。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/04-unlink-from-cloud-account.adoc b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/04-unlink-from-cloud-account.adoc new file mode 100644 index 000000000..aedaa5f7d --- /dev/null +++ b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/04-unlink-from-cloud-account.adoc @@ -0,0 +1,23 @@ +--- +title: "解绑云账号" +keywords: "Kubernetes, {ks_product},解绑,组件,KubeSphere Cloud,云账号" +description: "介绍如何解绑 KubeSphere 云账号。" +weight: 04 +--- + +本节介绍如何解绑 KubeSphere 云账号。 + +解绑后，再次授权登录可以绑定新账号。 + + +== 前提条件 + +* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../05-users-and-roles/01-users/[用户]和link:../../../../05-users-and-roles/02-platform-roles/[平台角色]。 +* 您需要在扩展中心授权登录 KubeSphere 云账号。 + +== 操作步骤 + +. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 +. 点击**扩展中心**。 +. 点击组件列表右上角的头像，选择**解绑云账号**。 + diff --git a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/_index.adoc b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/_index.adoc new file mode 100644 index 000000000..e2d3413a4 --- /dev/null +++ b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/03-manage-kubesphere-cloud-account/_index.adoc @@ -0,0 +1,8 @@ +--- +title: "管理 KubeSphere 云账号" +keywords: "Kubernetes, {ks_product},订阅,安装,组件,KubeSphere Cloud,云账号" +description: "介绍如何管理 KubeSphere 云账号的订阅订单等功能。" +weight: 03 +--- + +本节介绍如何在扩展中心管理 KubeSphere 云账号下的订阅订单等功能。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/_index.adoc b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/_index.adoc new file mode 100644 index 000000000..95033992b --- /dev/null +++ b/content/zh/docs/v4.1/06-extension-user-guide/02-subscribe-and-install-components/_index.adoc @@ -0,0 +1,11 @@ +--- +title: "订阅与安装扩展组件" +keywords: "Kubernetes, {ks_product},订阅,安装,组件, KubeSphere Cloud,云账号" +description: "介绍如何订阅、安装扩展组件，以及管理 KubeSphere 云账号的相关功能。" +draft: true +weight: 02 +--- + +// 导出说明：此文档用于在线订阅 pdf 版本，不可与 01-install-components-pdf 同时存在。 + +本节介绍如何订阅、安装扩展组件，以及管理 KubeSphere 云账号的相关功能。 diff --git a/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/01-set-configurations.adoc b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/01-set-configurations.adoc new file mode 100644 index 000000000..1277fb174 --- /dev/null +++ b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/01-set-configurations.adoc @@ -0,0 +1,32 @@ +--- +title: "配置扩展组件" +keywords: "Kubernetes, KubeSphere,设置,配置,扩展组件" +description: "介绍如何配置扩展组件。" +weight: 01 +--- + +本节介绍如何配置扩展组件。 + +除了在安装组件时配置组件，您还可以在扩展中心的组件详情页，修改扩展组件的配置。 + +== 前提条件 + +* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../05-users-and-roles/01-users/[用户]和link:../../../05-users-and-roles/02-platform-roles/[平台角色]。 +* 您已成功安装一个扩展组件。 + +== 操作步骤 + +. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 +. 点击**扩展中心**。 +. 点击已安装的组件名称，进入组件详情页。 +. 点击组件图标下的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**扩展组件配置**。 +. 编辑完成后，点击**确定**。 + + +include::../../../../_ks_components/admonitions/note.adoc[] + +点击image:/images/ks-qkcp/zh/icons/upload-dark-white.svg[upload-dark,18,18]可将扩展组件的配置文件 **config.yaml** 从本地上传。 + +点击image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download-dark,18,18]可将扩展组件的配置文件 **config.yaml** 下载到本地。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/02-set-cluster-agents.adoc b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/02-set-cluster-agents.adoc new file mode 100644 index 000000000..ce74c5a45 --- /dev/null +++ b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/02-set-cluster-agents.adoc @@ -0,0 +1,23 @@ +--- +title: "配置集群 Agent" +keywords: "Kubernetes, {ks_product},设置,配置,集群 Agent" +description: "介绍如何配置集群 Agent。" +weight: 02 +--- + +本节介绍如何配置集群 Agent。 + +除了在安装组件时配置集群 Agent，您还可以在扩展中心的组件详情页，修改集群 Agent 的配置。 + +== 前提条件 + +* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../05-users-and-roles/01-users/[用户]和link:../../../05-users-and-roles/02-platform-roles/[平台角色]。 +* 您已成功安装一个配置了集群 Agent 的扩展组件。 + +== 操作步骤 +. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 +. 点击**扩展中心**。 +. 点击已安装的组件名称，进入组件详情页。 +. 点击组件图标下的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**集群 Agent 配置**。 +. 选择一个集群，并进行差异化配置。 +. 点击**确定**。 diff --git a/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/03-upgrade-components.adoc b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/03-upgrade-components.adoc new file mode 100644 index 000000000..f1cf32dd1 --- /dev/null +++ b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/03-upgrade-components.adoc @@ -0,0 +1,22 @@ +--- +title: "升级扩展组件" +keywords: "Kubernetes, {ks_product},升级,扩展组件" +description: "介绍如何升级扩展组件。" +weight: 03 +--- + +本节介绍如何升级扩展组件。 + +在订阅期内，当组件有新版本时，您可以在扩展中心的组件详情页升级组件。 + +== 前提条件 + +您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../05-users-and-roles/01-users/[用户]和link:../../../05-users-and-roles/02-platform-roles/[平台角色]。 + +== 操作步骤 + +. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 +. 点击**扩展中心**。 +. 点击已安装的组件名称，进入组件详情页。 +. 点击组件图标下的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**更新**。 +. 在更新对话框中，参照组件安装流程，完成升级。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..7e2f6ef99 --- /dev/null +++ b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/04-disable-components.adoc @@ -0,0 +1,23 @@ +--- +title: "禁用扩展组件" +keywords: "Kubernetes, {ks_product},启用,禁用,扩展组件" +description: "介绍如何禁用扩展组件。" +weight: 04 +--- + +本节介绍如何禁用扩展组件。 + +组件安装完成后，会自动启用。您可以在扩展中心的组件列表或组件详情页中禁用扩展组件。 + +禁用后，再次启用，即可在集群、企业空间、项目中继续使用该组件。 + +== 前提条件 + +您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../05-users-and-roles/01-users/[用户]和link:../../../05-users-and-roles/02-platform-roles/[平台角色]。 + +== 操作步骤 + +. 以具有 **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]，选择**启用**即可继续使用该组件。 \ No newline at end of file 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 new file mode 100644 index 000000000..63eb5d0ec --- /dev/null +++ b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/05-uninstall-components.adoc @@ -0,0 +1,26 @@ +--- +title: "卸载扩展组件" +keywords: "Kubernetes, {ks_product},卸载,强制卸载,扩展组件" +description: "介绍如何卸载扩展组件。" +weight: 05 +--- + +本节介绍如何卸载扩展组件。 + +您可以在扩展中心的组件列表或组件详情页中卸载扩展组件。 + +对于多集群环境，卸载时会先卸载集群 Agent，再卸载组件。 + +== 前提条件 + +您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../05-users-and-roles/01-users/[用户]和link:../../../05-users-and-roles/02-platform-roles/[平台角色]。 + +== 操作步骤 + +. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 +. 点击**扩展中心**，进入扩展中心页面。 +. 点击组件右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**卸载**。 +. 输入扩展组件的名称，点击**确定**开始卸载。 + + + diff --git a/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/_index.adoc b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/_index.adoc new file mode 100644 index 000000000..c11f87191 --- /dev/null +++ b/content/zh/docs/v4.1/06-extension-user-guide/03-manage-components/_index.adoc @@ -0,0 +1,8 @@ +--- +title: "管理扩展组件" +keywords: "Kubernetes, {ks_product}, 管理, 扩展组件" +description: "介绍如何管理扩展组件。" +weight: 03 +--- + +本节介绍如何在扩展中心配置、升级、禁用、卸载扩展组件，以及如何配置集群 Agent。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/06-extension-user-guide/_index.adoc b/content/zh/docs/v4.1/06-extension-user-guide/_index.adoc new file mode 100644 index 000000000..cfdd81c8c --- /dev/null +++ b/content/zh/docs/v4.1/06-extension-user-guide/_index.adoc @@ -0,0 +1,54 @@ +--- +title: "扩展组件管理" +keywords: "Kubernetes, {ks_product}, 扩展组件管理" +description: "介绍如何订阅、安装、管理扩展组件。" +weight: 06 +--- + +ifeval::["{file_output_type}" == "html"] + +本节介绍如何订阅、安装、管理扩展组件，以及管理 KubeSphere 云账号的相关功能。 + +KubeSphere 扩展组件，是构建在 KubeSphere LuBan 之上、用以扩展并增强 KubeSphere 产品能力、进一步满足企业各类型业务需求的应用形态。{ks_product_right}安装完成后默认仅启用了核心组件。建议您在扩展市场订阅安装扩展组件以充分利用{ks_product_both}的功能特性。 + +有关如何使用各个扩展组件的更多信息，请参阅link:../11-use-extensions[扩展组件使用]章节。 + +endif::[] + +ifeval::["{file_output_type}" == "pdf"] + +本节介绍如何安装和管理扩展组件。 + +KubeSphere 扩展组件，是构建在 KubeSphere LuBan 之上、用以扩展并增强 KubeSphere 产品能力、进一步满足企业各类型业务需求的应用形态。{ks_product_right}安装完成后默认仅启用了核心组件。建议您在扩展中心安装扩展组件以充分利用{ks_product_both}的功能特性。 + +有关如何使用各个扩展组件的更多信息，请参阅《{ks_product_right}扩展组件使用指南》。 + +== 产品版本 + +本文档适用于{ks_product_left} v4.1.0 版本。 + +== 读者对象 + +本文档主要适用于以下读者： + +* {ks_product_right}用户 + +* 交付工程师 + +* 运维工程师 + +* 售后工程师 + + +== 修订记录 + +[%header,cols="1a,1a,3a"] +|=== +|文档版本 |发布日期 |修改说明 + +|01 +|{pdf_releaseDate} +|第一次正式发布。 +|=== + +endif::[] diff --git a/content/zh/docs/v4.1/07-cluster-management/01-web-console/01-log-in-and-go-to-a-cluster.adoc b/content/zh/docs/v4.1/07-cluster-management/01-web-console/01-log-in-and-go-to-a-cluster.adoc new file mode 100644 index 000000000..1f4b02630 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/01-web-console/01-log-in-and-go-to-a-cluster.adoc @@ -0,0 +1,24 @@ +--- +title: "登录并进入集群" +keywords: "Kubernetes, {ks_product}, 集群管理, Web 控制台, 登录并进入集群" +description: "本节介绍如何登录并进入集群。" +weight: 01 +--- + + +本节介绍如何登录{ks_product_left} Web 控制台并进入集群。 + + +== 前提条件 + +* 您需要获取集群成员的用户名和密码。 + +include::../../../_custom/workspaceManagement/webConsole/webConsole-prer-logIn.adoc[] + + +== 操作步骤 + +. 打开 Web 浏览器，在地址栏中输⼊{ks_product_left} Web 控制台的 IP 地址和端⼝号。 +. 在{ks_product_both}登录⻚⾯，输⼊⽤⼾信息然后点击登录。 +. 点击**集群管理**。 +. 如果已有多个集群，在**集群管理**页面点击一个集群的名称进入集群。 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 new file mode 100644 index 000000000..c84c578ec --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/01-web-console/_index.adoc @@ -0,0 +1,8 @@ +--- +title: "Web 控制台" +keywords: "Kubernetes, {ks_product}, 集群管理, Web 控制台" +description: "介绍如何登录{ks_product_left} Web 控制台并进入集群，以及修改用户的邮箱、语言和密码。" +weight: 01 +--- + +本节介绍如何登录{ks_product_left} Web 控制台并进入集群。 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 new file mode 100644 index 000000000..25dcbbdeb --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/02-overview/01-view-cluster-overall-information.adoc @@ -0,0 +1,52 @@ +--- +title: "查看集群概览信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 概览, 查看集群概览信息" +description: "介绍如何查看集群的概览信息。" +weight: 02 +--- + +:ks_permission: **集群设置查看** +:ks_menu: **概览** + + +本节介绍如何查看集群的概览信息。 + + +== 前提条件 + +:relfileprefix: ../../../ + +include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群。 +. 在左侧导航栏选择pass:a,q[{ks_menu}]。 + ++ +-- +[%header,cols="1a,4a"] +|=== +|功能区 |描述 + +|名称、标签和描述 +| +显示当前集群的名称、标签和描述。 + +* 成员集群的名称由用户添加成员集群时设置。 + +* 集群名称右侧显示当前集群的标签。 + +|基本信息 +|显示当前集群的提供商、Kubernetes 版本、{ks_product_right}版本和对企业空间的可见性。 + +|已创建资源数量 +|显示当前集群的资源数量，如项目、容器组、部署、有状态副本集、守护进程集、任务、定时任务、持久卷、服务、应用路由、成员、角色等的数量。 + +|工具 +|显示 kubectl 命令行工具，和 kubeconfig 配置文件。 + +|=== +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/07-cluster-management/02-overview/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/02-overview/_index.adoc new file mode 100644 index 000000000..cc01ff283 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/02-overview/_index.adoc @@ -0,0 +1,7 @@ +--- +title: "概览" +keywords: "Kubernetes, {ks_product}, 集群管理, 概览" +description: "介绍如何查看集群的概览信息。" +weight: 02 +--- + 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 new file mode 100644 index 000000000..9aff7bc68 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/03-nodes/01-view-a-node-list.adoc @@ -0,0 +1,75 @@ +--- +title: "查看节点列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 节点, 查看节点列表" +description: "介绍如何查看节点列表。" +weight: 01 +--- + +:ks_permission: **节点查看** + + +本节介绍如何查看节点列表。 + + +== 前提条件 + +:relfileprefix: ../../../ + +include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +== 操作步骤 + +include::../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../_custom/clusterManagement/nodes/nodes-oper-openListPage_new.adoc[] + ++ + +==== +* 节点列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|各节点的主机名称和在子网内部的 IP 地址。 +// 各节点的主机名称由用户安装集群时在安装配置文件 **config-sample.yaml** 中设置。 + +|状态 +| +include::../../../_custom/clusterManagement/nodes/nodes-para-nodeStatus_new.adoc[] + +如果节点上存在污点，**状态**列还将显示节点上污点的数量。将光标悬停在污点数字上查看污点的具体信息。有关更多信息，请参阅link:../05-edit-node-taints/[设置节点污点]。 + +|角色 +| +include::../../../_custom/clusterManagement/nodes/nodes-para-nodeRole_new.adoc[] + +// |CPU 用量 +// |各节点的 CPU 核总数、已使用 CPU 核数量和已使用 CPU 核百分比。已使用 CPU 核数量包含底层系统使用的 CPU 核数量。 + +// |内存用量 +// |各节点的内存总大小、已使用内存大小和已使用内存的百分比。已使用内存大小包含底层系统使用的内存大小。 + +// |容器组 +// |各节点上可创建容器组的总数、已创建容器组的数量和已创建容器组的百分比。 + +// |已分配 CPU/已分配内存 +// |各节点预留给容器组的 CPU 和内存资源，以及预留资源相对可分配资源的百分比。将光标悬停到数据单元格中可以查看各节点容器组资源上限，以及资源上限相对可分配资源的百分比。 + +// 节点上一部分 CPU 和内存资源已经分配给底层系统，所以可分配资源略小于节点实际资源总数。 +|=== +-- + +* 在列表上方点击搜索框并设置搜索条件，可按名称、状态或角色搜索节点。 + +include::../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../_ks_components/oper-customizeColumns.adoc[] +==== 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 new file mode 100644 index 000000000..535213aed --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/03-nodes/02-view-node-details.adoc @@ -0,0 +1,118 @@ +--- +title: "查看节点详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 节点, 查看节点详情" +description: "介绍如何查看节点详情。" +weight: 02 +--- + +:ks_permission: **节点查看** + + +本节介绍如何查看节点详情。 + + +== 前提条件 + + +:relfileprefix: ../../../ + +include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../_custom/clusterManagement/nodes/nodes-oper-openListPage_new.adoc[] + ++ + +. 在节点列表中点击一个节点的名称打开其详情页面。 + +. 在节点详情页面左侧的**属性**区域查看节点的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|状态 +| +include::../../../_custom/clusterManagement/nodes/nodes-para-nodeStatus_new.adoc[] + +|IP 地址 +|节点的 IP 地址。 + +|角色 +| +include::../../../_custom/clusterManagement/nodes/nodes-para-nodeRole_new.adoc[] + +|操作系统版本 +|节点的操作系统发行版和版本。 + +|操作系统类型 +|节点的操作系统类型。 + +|内核版本 +|节点的内核版本。 + +|容器运行时 +|节点使用的容器运行时类型和版本。 + +|kubelet 版本 +|节点上运行的 kubelet 版本。 + +|kube-proxy 版本 +|节点上运行的 kube-proxy 版本。 + +|系统架构 +|节点的 CPU 架构。 + +|创建时间 +|节点加入当前集群的时间。 +|=== +-- + +. 在节点详情页面右侧的**运行状态**页签查看节点的健康状态和污点。 ++ +-- +[%header,cols="1a,4a"] +|=== +|功能区 |描述 + +|健康状态 +|显示节点的网络、内存、磁盘、进程压力和就绪状态。如果显示image:/images/ks-qkcp/zh/icons/check-healthy.svg["healthy",15px,15px] 则表明状态正常，如果显示image:/images/ks-qkcp/zh/icons/substract-unhealthy.svg["unhealthy",15px,15px] 则表明出现告警。 + +* **网络可用性**：节点的网络配置是否正确。 + +* **内存压力**：节点剩余内存是否小于阈值，默认阈值为 100 MiB。 + +* **磁盘压力**：节点剩余磁盘空间或 inode 数量是否小于阈值，默认磁盘空间阈值为磁盘空间总量的 10%，默认 inode 数量阈值为 inode 最大数量的 5%。 + +* **进程压力**：节点上可创建的进程数量是否小于阈值。新安装的{ks_product_both}集群默认未设置进程数量阈值。 + +* **就绪状态**：节点是否已经准备好接收容器组。 + +|污点 +|当前节点上已配置的污点。有关更多信息，请参阅link:../05-edit-node-taints/[编辑节点污点]。 +|=== +-- + +. 在节点详情页面右侧点击**容器组**页签查看节点上运行的所有容器组。 ++ +-- +include::../../../_custom/clusterManagement/nodes/nodes-para-podList.adoc[] +-- + +. 在节点详情页面右侧点击**元数据**页签查看节点的标签和注解。 + +. 在节点详情页面右侧点击**事件**页签查看节点的事件记录。 ++ +-- +include::../../../_custom/clusterManagement/clusterManagement-para-eventsTab.adoc[] +-- 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 new file mode 100644 index 000000000..ee076c500 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/03-nodes/03-prevent-and-allow-pod-scheduling.adoc @@ -0,0 +1,41 @@ +--- +title: "阻止和允许容器组调度" +keywords: "Kubernetes, {ks_product}, 集群管理, 节点, 集群节点, 阻止和允许容器组调度" +description: "介绍如何阻止和允许容器组调度。" +weight: 03 +--- + +:ks_permission: **节点管理** + + +本节介绍如何阻止和允许容器组调度到节点。 + + +== 前提条件 + +:relfileprefix: ../../../ + +include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +== 操作步骤 + +include::../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../_custom/clusterManagement/nodes/nodes-oper-openListPage_new.adoc[] + ++ + +. 在需要操作的节点右侧点击image:/images/ks-qkcp/zh/icons/more.svg["more",18,18]，然后在下拉列表中选择**停止调度**。操作完成后节点状态将变为**无法调度**。 + +. 在状态为**无法调度**的节点右侧点击image:/images/ks-qkcp/zh/icons/more.svg["more",18,18]，然后在下拉列表中选择**启用调度**可以允许容器组调度到该节点。 + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +节点状态被设置为**无法调度**后，新创建的容器组将不再调度到该节点，节点上原本运行的容器组不受影响。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..b507a0202 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/03-nodes/04-access-a-node-terminal.adoc @@ -0,0 +1,43 @@ +--- +title: "使用节点终端" +keywords: "Kubernetes, {ks_product}, 集群管理, 节点, 使用节点终端" +description: "介绍如何访使用节点的终端。" +weight: 04 +--- + +:ks_permission: **节点管理** + + +本节介绍如何使用节点的终端。 + +您可以使用{ks_product_both}提供的命令行终端对节点进行操作。 + + +== 前提条件 + +:relfileprefix: ../../../ + +include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +== 操作步骤 + +include::../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../_custom/clusterManagement/nodes/nodes-oper-openListPage_new.adoc[] + ++ + +. 在需要操作的节点右侧点击image:/images/ks-qkcp/zh/icons/more.svg["more",18,18]，然后在下拉列表中选择**打开终端**。 ++ +-- + +include::../../../../_ks_components/admonitions/note.adoc[] + +初次打开节点终端时，由于相关服务尚未启动，系统可能会提示缺少相关权限。如果遇到此情况，您可以稍后重试。 + +include::../../../../_ks_components/admonitions/admonEnd.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 new file mode 100644 index 000000000..339647de9 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/03-nodes/05-edit-node-taints.adoc @@ -0,0 +1,72 @@ +--- +title: "编辑节点污点" +keywords: "Kubernetes, {ks_product}, 集群管理, 节点, 编辑节点污点" +description: "介绍如何编辑节点污点。" +weight: 05 +--- + +:ks_permission: **节点管理** + + +本节介绍如何编辑节点污点。 + +污点是用户在节点上创建的标记，与容器组上创建的容忍度配合使用。当节点存在污点时，根据设置的污点效果，所有缺少与污点匹配的容忍度的容器组都将被阻止调度到节点或被尽可能阻止调度到节点。 + +一个污点由键、值和效果三部分组成。容器组容忍度必须与污点的键、值和效果匹配，容器组才能不受污点影响。 + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +{ks_product_right} Web 控制台目前暂不支持编辑容器组容忍度，因而默认情况下节点污点对所有容器组生效。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../ + +include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +== 操作步骤 + +include::../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../_custom/clusterManagement/nodes/nodes-oper-openListPage_new.adoc[] + ++ + +. 选择需要操作的节点左侧的复选框，然后在节点列表上方点击**编辑污点**。 + +. 在**编辑污点**对话框，设置污点的键、值和效果，然后点击**确定**。 ++ +-- +您可以为一个污点选择以下效果之一： + +[%header,cols="1a,4a"] +|=== +|污点效果 |描述 + +|阻止调度 +|缺少与污点匹配的容忍度的容器组将被阻止调度到节点，节点上原本运行的容器组不受影响。 + +|尽可能阻止调度 +|缺少与污点匹配的容忍度的容器组将被尽可能阻止调度到节点，节点上原本运行的容器组不受影响。 + +|阻止调度并驱逐现有容器组 +|缺少与污点匹配的容忍度的容器组将被阻止调度到节点，节点上原本运行的容器组如果缺少与污点匹配的容忍度会被立即驱逐。 +|=== + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +* 点击**添加污点**可以为节点设置多个污点。 + +* 如果您同时编辑多个节点的污点，您可以设置多个节点的公共污点以及每个节点各自的污点。 + +include::../../../../_ks_components/admonitions/admonEnd.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 new file mode 100644 index 000000000..dc24575fe --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/03-nodes/06-edit-node-labels.adoc @@ -0,0 +1,46 @@ +--- +title: "编辑节点标签" +keywords: "Kubernetes, {ks_product}, 集群管理, 节点, 编辑节点标签" +description: "介绍如何编辑节点标签。" +weight: 06 +--- + +:ks_permission: **节点管理** + + +本节介绍如何编辑节点标签。 + +节点标签是用户在节点上设置的键值对，可用于选择节点。例如，在创建工作负载时，您可以指定容器组调度到具有特定标签的节点上。 + + +== 前提条件 + +:relfileprefix: ../../../ + +include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ +== 操作步骤 + +include::../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../_custom/clusterManagement/nodes/nodes-oper-openListPage_new.adoc[] + ++ + +. 在节点列表中，点击需要操作的节点的名称打开节点详情页面。 + +. 在节点详情页面左上角选择**更多操作 > 编辑标签**。 + +. 在**编辑标签**对话框，设置节点标签的键和值，然后点击**确定**。 ++ +-- +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +点击**添加**可以为节点设置多个标签。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] +-- diff --git a/content/zh/docs/v4.1/07-cluster-management/03-nodes/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/03-nodes/_index.adoc new file mode 100644 index 000000000..59a7cc3ac --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/03-nodes/_index.adoc @@ -0,0 +1,14 @@ +--- +title: "节点" +keywords: "Kubernetes, {ks_product}, 集群管理, 节点" +description: "介绍如何管理节点。" +weight: 03 +--- + + + + +本节介绍如何管理节点。 + +{ks_product_right}平台支持集群节点，通常所有集群节点都属于同一个私有网络。 + diff --git a/content/zh/docs/v4.1/07-cluster-management/04-projects/01-create-a-project.adoc b/content/zh/docs/v4.1/07-cluster-management/04-projects/01-create-a-project.adoc new file mode 100644 index 000000000..bd9a72c66 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/04-projects/01-create-a-project.adoc @@ -0,0 +1,71 @@ +--- +title: "创建项目" +keywords: "Kubernetes, {ks_product}, 集群管理, 项目, 创建项目" +description: "介绍如何创建项目。" +weight: 01 +--- + + +:ks_permission: **项目管理** +:ks_navigation: **项目** + + +本节介绍如何创建项目。 + + +== 前提条件 + + +:relfileprefix: ../../../ + +include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**创建项目**对话框，设置项目的参数，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../_custom/clusterManagement/projects/projects-para-name.adoc[] + +include::../../../_custom/clusterManagement/projects/projects-para-aliasDescription.adoc[] +|=== +-- + +. 在项目列表中，在新创建的项目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**分配企业空间**。 + +. 在**分配企业空间**对话框，设置项目所属的企业空间，并选择一个企业空间成员作为项目管理员，然后点击**确定**。 + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +* 项目被分配到企业空间后不允许变更项目所属的企业空间。 + +ifeval::["{file_output_type}" == "html"] +* 项目创建完成后，您可以邀请用户加入项目并在项目中部署业务。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +* 项目创建完成后，您可以邀请用户加入项目并在项目中部署业务。有关更多信息，请参阅 《{ks_product_right}项目管理指南》。 +endif::[] + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/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 new file mode 100644 index 000000000..5acaa42a3 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/04-projects/02-view-a-project-list.adoc @@ -0,0 +1,58 @@ +--- +title: "查看项目列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 项目, 查看项目列表" +description: "介绍如何查看项目列表。" +weight: 02 +--- + +:ks_permission: **项目查看** +:ks_navigation: **项目** + + +include::../../../_custom/workspaceManagement/projects/projects-desc-viewProjectList.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/projects/projects-oper-openListPage.adoc[] + ++ +==== +* 项目列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../_custom/workspaceManagement/projects/projects-para-projectList_new.adoc[] + +|企业空间 +|项目所属的企业空间。 +|=== +-- + +include::../../../_custom/workspaceManagement/projects/projects-oper-searchForProjects.adoc[] + +include::../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..58f6dabe2 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/04-projects/03-view-project-details.adoc @@ -0,0 +1,90 @@ +--- +title: "查看项目详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 项目, 查看项目详情" +description: "介绍如何查看项目详情。" +weight: 03 +--- + +:ks_permission: **项目查看** +:ks_navigation: **项目** + + +本节介绍如何查看项目详情。 + + +== 前提条件 + +: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/projects/projects-oper-openListPage.adoc[] + ++ + +include::../../../_custom/clusterManagement/projects/projects-oper-openDetailsPage.adoc[] + ++ + +. 在项目详情页面左侧的**属性**区域，查看项目的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|状态 +| +include::../../../_custom/clusterManagement/projects/projects-para-status.adoc[] + +|集群 +|项目所属的集群。 + +|企业空间 +|项目所属的企业空间。 + +|创建时间 +|项目的创建时间。 + +|创建者 +|创建项目的用户。 +|=== +-- + +. 在项目详情页面右侧的**概览**页签，查看当前项目的资源状态，如容器组、部署、有状态副本集、守护进程集、任务、定时任务、持久卷、服务和应用路由的数量。 + +. 在项目详情页面右侧的**容器组**页签，查看项目中运行的所有容器组。 ++ +-- +include::../../../_custom/clusterManagement/nodes/nodes-para-podList.adoc[] +-- + +. 在项目详情页面右侧点击**配额**，查看项目的配额信息。 ++ +-- +[%header,cols="1a,4a"] +|=== +|功能区 |描述 + +include::../../../_custom/clusterManagement/projects/projects-para-defaultContainerQuotas.adoc[] + +|项目配额 +|项目中可用资源的数量和实际使用量，包括： CPU 预留、CPU 上限、内存预留、内存上限、容器组预留和容器组上限等。 +|=== + +有关如何设置默认容器配额和项目配额，请参阅link:../07-edit-default-container-quotas/[编辑默认容器配额]和link:../06-edit-project-quotas/[编辑项目配额]。 +-- + +. 在项目详情页面右侧点击**元数据**，查看项目的标签。 \ No newline at end of file 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 new file mode 100644 index 000000000..2dbbef46b --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/04-projects/04-edit-project-information.adoc @@ -0,0 +1,53 @@ +--- +title: "编辑项目信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 项目, 编辑项目信息" +description: "介绍如何编辑项目信息。" +weight: 04 +--- + +:ks_permission: **项目管理** +:ks_navigation: **项目** + + +include::../../../_custom/clusterManagement/projects/projects-desc-editInformation.adoc[] + +include::../../../_custom/clusterManagement/projects/projects-note-editInformation.adoc[] + + +== 前提条件 + + +:relfileprefix: ../../../ + +include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的项目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑**。 + +. 在**编辑信息**对话框，设置项目的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|项目的别名。不同项目的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|项目的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|=== +-- diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..25ea829ec --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/04-projects/05-edit-project-annotations.adoc @@ -0,0 +1,45 @@ +--- +title: "编辑项目注解" +keywords: "Kubernetes, {ks_product}, 集群管理, 项目, 编辑项目注解" +description: "介绍如何编辑项目注解。" +weight: 05 +--- + +:ks_permission: **项目管理** +:ks_navigation: **项目** + + +本节介绍如何编辑项目注解。 + +项目注解是为项目添加额外的元数据或描述性信息的键值对。 + + +== 前提条件 + + +:relfileprefix: ../../../ + +include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components/oper-navigate.adoc[] + + +. 在需要操作的项目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑注解**。 + +. 在**编辑注解**对话框，设置注解键值对，然后点击**确定**。 ++ +-- +* 点击**添加**可设置多条注解。 + +* 在已创建的注解右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除注解。 +-- 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 new file mode 100644 index 000000000..9a1a1b570 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/04-projects/06-edit-project-quotas.adoc @@ -0,0 +1,44 @@ +--- +title: "编辑项目配额" +keywords: "Kubernetes, {ks_product}, 集群管理, 项目, 编辑项目配额" +description: "介绍如何编辑项目配额。" +weight: 06 +--- + +:ks_permission: **项目管理** +:ks_navigation: **项目** + + +include::../../../_custom/clusterManagement/projects/projects-desc-editQuotas.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/projects/projects-oper-openDetailsPage.adoc[] + ++ + +. 在项目详情页面左上角选择**更多操作 > 编辑项目配额**。 + ++ + +include::../../../_custom/clusterManagement/projects/projects-oper-editProjectQuotas.adoc[] 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 new file mode 100644 index 000000000..726cbb664 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/04-projects/07-edit-default-container-quotas.adoc @@ -0,0 +1,44 @@ +--- +title: "编辑默认容器配额" +keywords: "Kubernetes, {ks_product}, 集群管理, 项目, 编辑默认容器配额" +description: "介绍如何编辑默认容器配额。" +weight: 07 +--- + +:ks_permission: **项目管理** +:ks_navigation: **项目** + + +include::../../../_custom/clusterManagement/projects/projects-desc-editDefaultContainerQuotas.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/projects/projects-oper-openDetailsPage.adoc[] + ++ + +. 在项目详情页面左上角选择**更多操作 > 编辑默认容器配额**。 + ++ + +include::../../../_custom/clusterManagement/projects/projects-oper-editDefaultContainerQuotas.adoc[] 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 new file mode 100644 index 000000000..12559bf25 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/04-projects/08-delete-projects.adoc @@ -0,0 +1,49 @@ +--- +title: "删除项目" +keywords: "Kubernetes, {ks_product}, 集群管理, 项目, 删除项目" +description: "介绍如何删除项目。" +weight: 08 +--- + +:ks_permission: **项目管理** +:ks_navigation: **项目** + + +include::../../../_custom/clusterManagement/projects/projects-desc-deleteProjects.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/projects/projects-oper-deleteASingleProject.adoc[] + + +== 批量删除项目 + +include::../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../_custom/clusterManagement/projects/projects-oper-deleteMultipleProjects.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/04-projects/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/04-projects/_index.adoc new file mode 100644 index 000000000..88fd5d42a --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/04-projects/_index.adoc @@ -0,0 +1,16 @@ +--- +title: "项目" +keywords: "Kubernetes, {ks_product}, 集群管理, 项目" +description: "介绍如何管理项目。" +weight: 04 +--- + + + +本节介绍如何管理项目。 + +在{ks_product_both}平台，项目用于对资源进行分组管理。您可以在项目中创建资源，邀请用户加入项目，并为不同的用户设置不同的访问权限。{ks_product_right}平台上存在两类项目： + +* 用户项目：由用户创建的项目，用于管理用户资源。 + +* 系统项目：由{ks_product_both}系统自动创建的项目，用于管理{ks_product_both}系统资源。通常情况下，不建议将用户资源创建在系统项目中。 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 new file mode 100644 index 000000000..450dfff18 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/01-create-a-workload.adoc @@ -0,0 +1,257 @@ +--- +title: "创建工作负载" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 工作负载, 创建工作负载" +description: "介绍如何创建工作负载。" +weight: 01 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-createAWorkload.adoc[] + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +请参阅link:#_参数描述[参数描述]设置工作负载的参数。 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-createAWorkload.adoc[] + + +== 参数描述 + +以下介绍如何设置工作负载的参数。 + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-basicInformation.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podReplicas.adoc[] + +* 容器组设置 > 添加容器 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] +-- + +* 容器组设置 > 添加容器 > 容器设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] + +include::../../../../_custom/clusterManagement/projects/projects-para-containerQuotas.adoc[] +|=== +-- + +* 容器组设置 > 添加容器 > 端口设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] +-- + +* 容器组设置 > 添加容器 > 镜像拉取策略 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] +-- + +* 容器组设置 > 添加容器 > 健康检查 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] +-- + +* 容器组设置 > 添加容器 > 健康检查 > 添加探针 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc[] +-- + +* 容器组设置 > 添加容器 > 生命周期管理 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] +-- + +* 容器组设置 > 添加容器 > 生命周期管理 > 添加动作 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] +-- + +* 容器组设置 > 添加容器 > 启动命令 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] +-- + +* 容器组设置 > 添加容器 > 环境变量 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] +-- + +* 容器组设置 > 添加容器 > 容器组安全上下文 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] +-- + +* 容器组设置 > 添加容器 > 同步主机时区 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] +-- + +* 容器组设置 > 更新策略 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc[] +-- + +* 容器组设置 > 更新策略 > 滚动更新设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc[] +-- + +* 容器组设置 > 容器组安全上下文 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSecurityContext.adoc[] +-- + +* 容器组设置 > 容器组调度规则 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc[] +-- + +* 容器组设置 > 容器组调度规则 > 自定义规则 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc[] +-- + +* 容器组设置 > 容器组优雅终止 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc[] +-- + +* 容器组设置 > 添加元数据 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodMetadata.adoc[] +-- + +* 存储设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc[] + +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-enableLogCollectionCluster.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] +|=== + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume.adoc[] +-- + +* 存储设置 > 添加持久卷声明模板 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc[] +-- + +* 存储设置 > 挂载卷 > 持久卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] +-- + +* 存储设置 > 挂载卷 > 临时卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume_new.adoc[] +-- + +* 存储设置 > 挂载卷 > HostPath 卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] +-- + +* 存储设置 > 挂载配置字典或保密字典 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] +-- + +* 高级设置 ++ +-- +为工作负载管理的容器组指定节点，并设置工作负载的元数据。 + + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podIpPool.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc[] + +|添加元数据 +| +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setWorkloadMetadata.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc[] +|=== +-- 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 new file mode 100644 index 000000000..1f5ff5f1d --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/02-view-a-workload-list.adoc @@ -0,0 +1,49 @@ +--- +title: "查看工作负载列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 工作负载, 查看工作负载列表" +description: "介绍如何查看工作负载列表。" +weight: 02 +--- + +:ks_permission: **应用负载查看** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-viewAWorkloadList.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/workloads/workloads-oper-openListPage.adoc[] + ++ +==== +include::../../../../_custom/clusterManagement/workloads/workloads-para-workloadList.adoc[] + +* 在列表左上角的下拉列表中选择一个项目，可以查看特定项目中的工作负载。 + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-searchForWorkloads.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/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 new file mode 100644 index 000000000..8ae89a35c --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/03-view-workload-details.adoc @@ -0,0 +1,40 @@ +--- +title: "查看工作负载详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 工作负载, 查看工作负载详情" +description: "介绍如何查看工作负载详情。" +weight: 03 +--- + +:ks_permission: **应用负载查看** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-viewWorkloadDetails.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/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-viewWorkloadDetails_new.adoc[] 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 new file mode 100644 index 000000000..56d610407 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/04-edit-workload-information.adoc @@ -0,0 +1,41 @@ +--- +title: "编辑工作负载信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 工作负载, 编辑工作负载信息" +description: "介绍如何编辑工作负载信息。" +weight: 04 +--- + + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-editWorkloadInformation.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/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-editWorkloadInformation.adoc[] 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 new file mode 100644 index 000000000..49d14b478 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/06-adjust-the-number-of-pod-replicas.adoc @@ -0,0 +1,40 @@ +--- +title: "调整容器组副本数量" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 工作负载, 调整容器组副本数量" +description: "介绍如何调整工作负载的容器组副本数量。" +weight: 06 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-adjustTheNumberOfPodReplicas.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/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-adjustTheNumberOfPodReplicas.adoc[] 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 new file mode 100644 index 000000000..f5510ce4a --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/07-re-create-a-workload.adoc @@ -0,0 +1,40 @@ +--- +title: "重新创建工作负载" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 工作负载, 重新创建工作负载" +description: "介绍如何重新创建工作负载。" +weight: 07 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-recreateAWorkload.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/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-recreateAWorkload.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/08-roll-back-workload-settings.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/08-roll-back-workload-settings.adoc new file mode 100644 index 000000000..616fb2fc7 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/08-roll-back-workload-settings.adoc @@ -0,0 +1,40 @@ +--- +title: "回退工作负载设置" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 工作负载, 回退工作负载设置" +description: "介绍如何回退工作负载设置。" +weight: 08 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-rollBackWorkloadSettings.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../ +* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 + +:relfileprefix: ./ + + +include::../../../../_custom/clusterManagement/workloads/workloads-prer-workloadEdited.adoc[] + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-rollBackWorkloadSettings.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 new file mode 100644 index 000000000..9f63a1640 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/09-edit-auto-scaling-settings.adoc @@ -0,0 +1,40 @@ +--- +title: "编辑自动扩缩设置" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 工作负载, 编辑自动扩缩" +description: "介绍如何编辑工作负载的自动扩缩设置。" +weight: 09 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-editAutoScaling.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/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-editAutoScalingSettings.adoc[] 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 new file mode 100644 index 000000000..66a53e16b --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/10-edit-workload-settings.adoc @@ -0,0 +1,205 @@ +--- +title: "编辑工作负载设置" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 工作负载, 编辑工作负载设置" +description: "介绍如何编辑已创建的工作负载的设置。" +weight: 10 +--- + + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-editWorkloadSettings.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/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-editWorkloadSettings.adoc[] + ++ + +. 在**编辑设置**对话框，分别设置工作负载的更新策略、容器、存储、容器组调度规则（对守护进程集不可用）、容器组优雅终止，然后点击**确定**。有关具体的参数设置方法，请参阅link:#_参数描述[参数描述]。 + + +== 参数描述 + +* 更新策略 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc[] +-- + +* 更新策略 > 滚动更新设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc[] +-- + +* 容器 > 添加容器 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] +-- + +* 容器 > 容器设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] + +include::../../../../_custom/clusterManagement/projects/projects-para-containerQuotas.adoc[] +|=== +-- + +* 容器 > 容器设置 > 端口设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] +-- + +* 容器 > 容器设置 > 镜像拉取策略 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] +-- + +* 容器 > 容器设置 > 健康检查 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] +-- + +* 容器 > 容器设置 > 生命周期管理 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] +-- + +* 容器 > 容器设置 > 启动命令 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] +-- + +* 容器 > 容器设置 > 环境变量 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] +-- + +* 容器 > 容器设置 > 容器安全上下文 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] +-- + +* 容器 > 容器设置 > 同步主机时区 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] +-- + +* 存储 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc[] + +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-enableLogCollectionCluster.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] +|=== + +* 将光标悬停在已添加的卷上，然后在右侧点击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-para-volumeTemplate.adoc[] +-- + +* 存储 > 挂载卷 > 持久卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] +-- + +* 存储 > 挂载卷 > 临时卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume_new.adoc[] +-- + +* 存储 > 挂载卷 > HostPath 卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] +-- + +* 存储 > 挂载配置字典或保密字典 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] +-- + +* 容器组调度规则 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc[] +-- + +* 容器组调度规则 > 自定义规则 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc[] +-- + +* 容器组优雅终止 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc[] +-- \ No newline at end of file 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 new file mode 100644 index 000000000..8a09c56eb --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/11-stop-workloads.adoc @@ -0,0 +1,40 @@ +--- +title: "停止工作负载" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 工作负载, 停止工作负载" +description: "介绍如何编辑工作负载信息。" +weight: 11 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-stopWorkloads.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/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-stopWorkloads.adoc[] 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 new file mode 100644 index 000000000..4e76da479 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/12-delete-workloads.adoc @@ -0,0 +1,62 @@ +--- +title: "删除工作负载" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 工作负载, 删除工作负载" +description: "介绍如何删除任务。" +weight: 12 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-deleteWorkloads.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/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-deleteASingleWorkload.adoc[] + ++ + +. 在**删除工作负载**对话框，确认并选择要删除的相关资源，然后点击**确定**。 + + +== 批量删除工作负载 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-deleteMultipleWorkloads.adoc[] + diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/_index.adoc new file mode 100644 index 000000000..27c32a4ae --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "工作负载" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 工作负载" +description: "介绍如何管理工作负载。" +weight: 01 +--- + + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-workloads.adoc[] 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 new file mode 100644 index 000000000..370966a7e --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/01-create-a-job.adoc @@ -0,0 +1,208 @@ +--- +title: "创建任务" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 任务, 创建任务" +description: "介绍如何创建任务。" +weight: 01 +--- + + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 任务** + + +include::../../../../_custom/clusterManagement/jobs/jobs-desc-createAJob.adoc[] + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +请参阅link:#_参数描述[参数描述]设置任务的参数。 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/jobs/jobs-oper-openListPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/jobs/jobs-oper-createAJob.adoc[] + + +== 参数描述 +以下介绍如何设置任务的参数。 + +include::../../../../_custom/clusterManagement/jobs/jobs-para-basicInformation.adoc[] + +include::../../../../_custom/clusterManagement/jobs/jobs-para-strategySettings.adoc[] + +include::../../../../_custom/clusterManagement/jobs/jobs-para-restartPolicy.adoc[] + +* 容器组设置 > 添加容器 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] +-- + +* 容器组设置 > 添加容器 > 容器设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] + +include::../../../../_custom/clusterManagement/projects/projects-para-containerQuotas.adoc[] +|=== +-- + +* 容器组设置 > 添加容器 > 端口设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] +-- + +* 容器组设置 > 添加容器 > 镜像拉取策略 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] +-- + +* 容器组设置 > 添加容器 > 健康检查 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] +-- + +* 容器组设置 > 添加容器 > 健康检查 > 添加探针 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc[] +-- + +* 容器组设置 > 添加容器 > 生命周期管理 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] +-- + +* 容器组设置 > 添加容器 > 生命周期管理 > 添加动作 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] +-- + +* 容器组设置 > 添加容器 > 启动命令 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] +-- + +* 容器组设置 > 添加容器 > 环境变量 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] +-- + +* 容器组设置 > 添加容器 > 容器组安全上下文 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] +-- + +* 容器组设置 > 添加容器 > 同步主机时区 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] +-- + +* 存储设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc[] + +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-enableLogCollectionCluster.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] +|=== + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume_new.adoc[] +-- + +* 存储设置 > 挂载卷 > 持久卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] +-- + +* 存储设置 > 挂载卷 > 临时卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume_new.adoc[] +-- + +* 存储设置 > 挂载卷 > HostPath 卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] +-- + +* 存储设置 > 挂载配置字典或保密字典 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] +-- + +* 高级设置 ++ +-- +为任务管理的容器组指定节点，并设置任务的元数据。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podIpPool.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc[] + +|添加元数据 +| +include::../../../../_custom/clusterManagement/jobs/jobs-desc-setJobMetadata.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc[] +|=== +-- 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 new file mode 100644 index 000000000..292abc69b --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/02-view-a-job-list.adoc @@ -0,0 +1,47 @@ +--- +title: "查看任务列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 任务, 查看任务列表" +description: "介绍如何查看任务列表。" +weight: 02 +--- + +:ks_permission: **应用负载查看** +:ks_navigation: **应用负载 > 任务** + + +include::../../../../_custom/clusterManagement/jobs/jobs-desc-viewAJobList.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/jobs/jobs-oper-openListPage.adoc[] ++ +==== +include::../../../../_custom/clusterManagement/jobs/jobs-para-jobList.adoc[] + +* 在列表左上角的下拉列表中选择一个项目，可以查看特定项目中的任务。 + +include::../../../../_custom/clusterManagement/jobs/jobs-oper-searchForJobs.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/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 new file mode 100644 index 000000000..aaa367704 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/03-view-job-details.adoc @@ -0,0 +1,40 @@ +--- +title: "查看任务详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 任务, 查看任务详情" +description: "介绍如何查看任务详情。" +weight: 03 +--- + +:ks_permission: **应用负载查看** +:ks_navigation: **应用负载 > 任务** + + +include::../../../../_custom/clusterManagement/jobs/jobs-desc-viewJobDetails.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/jobs/jobs-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/jobs/jobs-oper-viewJobDetails_new.adoc[] 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 new file mode 100644 index 000000000..0c5946146 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/04-edit-job-information.adoc @@ -0,0 +1,41 @@ +--- +title: "编辑任务信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 任务, 编辑任务信息" +description: "介绍如何编辑任务信息。" +weight: 04 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 任务** + + +include::../../../../_custom/clusterManagement/jobs/jobs-desc-editJobInformation.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/jobs/jobs-oper-openListPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/jobs/jobs-oper-editJobInformation.adoc[] + 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 new file mode 100644 index 000000000..d343db792 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/05-delete-jobs.adoc @@ -0,0 +1,57 @@ +--- +title: "删除任务" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 任务, 删除任务" +description: "介绍如何删除任务。" +weight: 05 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 任务** + + +include::../../../../_custom/clusterManagement/jobs/jobs-desc-deleteJobs.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/jobs/jobs-oper-openListPage.adoc[] + ++ +include::../../../../_custom/clusterManagement/jobs/jobs-oper-deleteASingleJob.adoc[] + + + +== 批量删除任务 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/jobs/jobs-oper-openListPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/jobs/jobs-oper-deleteMultipleJobs.adoc[] 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 new file mode 100644 index 000000000..21ac6346d --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/06-re-run-a-job.adoc @@ -0,0 +1,36 @@ +--- +title: "重新运行任务" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 任务, 重新运行任务" +description: "介绍如何重新运行任务。" +weight: 06 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 任务** + + +include::../../../../_custom/clusterManagement/jobs/jobs-desc-rerunAJob.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/jobs/jobs-oper-rerunAJob.adoc[] 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 new file mode 100644 index 000000000..b888b2ac7 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/07-pause-a-cronjob.adoc @@ -0,0 +1,36 @@ +--- +title: "暂停定时任务" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 任务, 暂停定时任务" +description: "介绍如何暂停定时任务。" +weight: 07 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 任务** + + +include::../../../../_custom/clusterManagement/jobs/jobs-desc-pauseACronjob.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/jobs/jobs-oper-pauseACronjob.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/_index.adoc new file mode 100644 index 000000000..2d0d4ef62 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/02-jobs/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "任务" +keywords: "Kubernetes, {ks_product}, 集群管理, 任务" +description: "介绍如何管理任务。" +weight: 02 +--- + + + +include::../../../../_custom/clusterManagement/jobs/jobs-desc-jobs.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 new file mode 100644 index 000000000..a948a7936 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/01-view-a-pod-list.adoc @@ -0,0 +1,44 @@ +--- +title: "查看容器组列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 容器组, 查看容器组列表" +description: "介绍如何查看容器组列表。" +weight: 01 +--- + +:ks_permission: **应用负载查看** +:ks_navigation: **应用负载 > 容器组** + + +include::../../../../_custom/clusterManagement/pods/pods-desc-viewAPodList.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/pods/pods-para-podList.adoc[] + +* 在列表左上角的下拉列表中选择一个项目，可以查看特定项目中的容器组。 + +include::../../../../_custom/clusterManagement/pods/pods-oper-searchForPods.adoc[] + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== \ No newline at end of file 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 new file mode 100644 index 000000000..e033c4575 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/02-view-pod-details.adoc @@ -0,0 +1,40 @@ +--- +title: "查看容器组详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 容器组, 查看容器组详情" +description: "介绍如何查看容器组详情。" +weight: 02 +--- + +:ks_permission: **应用负载查看** +:ks_navigation: **应用负载 > 容器组** + + +include::../../../../_custom/clusterManagement/pods/pods-desc-viewPodDetails.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/pods/pods-oper-openDetails.adoc[] + ++ + +include::../../../../_custom/clusterManagement/pods/pods-oper-viewPodDetails_new.adoc[] 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 new file mode 100644 index 000000000..3975dc8e5 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/03-view-container-details.adoc @@ -0,0 +1,40 @@ +--- +title: "查看容器详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 容器组, 查看容器详情" +description: "介绍如何查看容器详情。" +weight: 03 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 容器组** + + +include::../../../../_custom/clusterManagement/pods/pods-desc-viewContainerDetails.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/pods/pods-oper-openDetails.adoc[] + ++ + +include::../../../../_custom/clusterManagement/pods/pods-oper-viewContainerDetails_new.adoc[] 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 new file mode 100644 index 000000000..f5a4fa1f5 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/04-access-a-container-terminal.adoc @@ -0,0 +1,40 @@ +--- +title: "访问容器终端" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 容器组, 访问容器终端" +description: "介绍如何访问容器终端。" +weight: 04 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 容器组** + + +include::../../../../_custom/clusterManagement/pods/pods-desc-accessAContainerTerminal.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/pods/pods-oper-openDetails.adoc[] + ++ + +include::../../../../_custom/clusterManagement/pods/pods-oper-accessAContainerTerminal.adoc[] 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 new file mode 100644 index 000000000..4e13e4ce4 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/05-delete-pods.adoc @@ -0,0 +1,49 @@ +--- +title: "删除容器组" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 容器组, 删除容器组" +description: "介绍如何删除容器组。" +weight: 05 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 容器组** + + +include::../../../../_custom/clusterManagement/pods/pods-desc-deletePods.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/pods/pods-oper-deleteASinglePod.adoc[] + + +== 批量删除容器组 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/pods/pods-oper-deleteMultiplePods.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/_index.adoc new file mode 100644 index 000000000..c4c50704d --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/03-pods/_index.adoc @@ -0,0 +1,9 @@ +--- +title: "容器组" +keywords: "Kubernetes, {ks_product}, 集群管理, 容器组" +description: "介绍如何管理容器组。" +weight: 03 +--- + + +include::../../../../_custom/clusterManagement/pods/pods-desc-pods.adoc[] 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 new file mode 100644 index 000000000..c6030ffe2 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/01-create-a-service.adoc @@ -0,0 +1,61 @@ +--- +title: "创建服务" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 服务, 创建服务" +description: "介绍如何创建服务。" +weight: 01 +--- + + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 服务** + + +include::../../../../_custom/clusterManagement/services/services-desc-createAService.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::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom/projectManagement/services/services-oper-setBasicInformation.adoc[] ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../_custom/clusterManagement/services/services-para-serviceName.adoc[] + +include::../../../../_custom/clusterManagement/services/services-para-serviceAlias.adoc[] + +|项目 +|服务所属的项目。系统项目通常用于管理系统资源，建议选择用户项目。 + +include::../../../../_custom/clusterManagement/services/services-para-serviceDescription.adoc[] +|=== +-- + ++ + +include::../../../../_custom/clusterManagement/services/services-oper-createAService.adoc[] 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 new file mode 100644 index 000000000..e7ad517f5 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/02-view-a-service-list.adoc @@ -0,0 +1,69 @@ +--- +title: "查看服务列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 服务, 查看服务列表" +description: "介绍如何查看服务列表。" +weight: 02 +--- + +:ks_permission: **应用负载查看** +:ks_navigation: **应用负载 > 服务** + + +include::../../../../_custom/clusterManagement/services/services-desc-viewServiceList.adoc[] + + +== 前提条件 + + + +:relfileprefix: ../../../../ + +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +==== +* 服务列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../_custom/clusterManagement/services/services-para-name.adoc[] + +|项目 +|服务所属的项目。 + +|内部访问 +| +include::../../../../_custom/clusterManagement/services/services-para-internalAccess.adoc[] + +include::../../../../_custom/clusterManagement/services/services-para-virtualip-headless.adoc[] + +include::../../../../_custom/clusterManagement/services/services-para-externalName.adoc[] + +include::../../../../_custom/clusterManagement/services/services-para-externalAccess.adoc[] + +include::../../../../_custom/clusterManagement/services/services-para-creationTime.adoc[] +|=== +-- + +* 在列表左上角的下拉列表中选择一个项目，可以查看特定项目中的服务。 + +include::../../../../_custom/clusterManagement/services/services-oper-searchForServices.adoc[] + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..63e0ad9c7 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/03-view-service-details.adoc @@ -0,0 +1,41 @@ +--- +title: "查看服务详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 服务, 查看服务详情" +description: "介绍如何查看服务详情。" +weight: 03 +--- + + +:ks_permission: **应用负载查看** +:ks_navigation: **应用负载 > 服务** + + +include::../../../../_custom/clusterManagement/services/services-desc-viewServiceDetails.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/services/services-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/services/services-oper-viewServiceDetails.adoc[] 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 new file mode 100644 index 000000000..884ff3507 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/04-edit-service-information.adoc @@ -0,0 +1,37 @@ +--- +title: "编辑服务信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 服务, 编辑服务信息" +description: "介绍如何编辑服务信息。" +weight: 04 +--- + + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 服务** + + +include::../../../../_custom/clusterManagement/services/services-desc-editServiceInformation.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/services/services-oper-editServiceInformation.adoc[] 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 new file mode 100644 index 000000000..ec7595ce9 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/05-edit-service-settings.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑服务设置" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 服务, 编辑服务设置" +description: "介绍如何编辑服务信息。" +weight: 05 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 服务** + + +include::../../../../_custom/clusterManagement/services/services-desc-editServiceSettings.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/services/services-oper-editServiceSettings.adoc[] 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 new file mode 100644 index 000000000..013ddb9ae --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/06-edit-service-external-access-settings.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑服务外部访问设置" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 服务, 编辑服务外部访问设置" +description: "介绍如何编辑服务外部访问设置。" +weight: 06 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 服务** + + +include::../../../../_custom/clusterManagement/services/services-desc-editServiceExternalAccessSettings.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/services/services-oper-editServiceExternalAccessSettings.adoc[] 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 new file mode 100644 index 000000000..318ad5d24 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/08-delete-services.adoc @@ -0,0 +1,53 @@ +--- +title: "删除服务" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 服务, 删除服务" +description: "介绍如何删除服务。" +weight: 08 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 服务** + + +include::../../../../_custom/clusterManagement/services/services-desc-deleteServices.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/services/services-oper-deleteASingleService.adoc[] + ++ + +. 在**删除服务**对话框，确认并选择要删除的相关资源，然后点击**确定**。 + + +== 批量删除服务 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/services/services-oper-deleteMultipleServices.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/_index.adoc new file mode 100644 index 000000000..4e734289c --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/04-services/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "服务" +keywords: "Kubernetes, {ks_product}, 集群管理, 服务" +description: "介绍如何管理服务。" +weight: 04 +--- + + + +include::../../../../_custom/clusterManagement/services/services-desc-services.adoc[] 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 new file mode 100644 index 000000000..f0e04be96 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/01-create-a-route.adoc @@ -0,0 +1,44 @@ +--- +title: "创建应用路由" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 应用路由, 创建应用路由" +description: "介绍如何创建应用路由。" +weight: 01 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 应用路由** + + +include::../../../../_custom/clusterManagement/routes/routes-desc-createARoute.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../ +* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 + +: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 new file mode 100644 index 000000000..6a24eebea --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/02-view-a-route-list.adoc @@ -0,0 +1,45 @@ +--- +title: "查看应用路由列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 应用路由, 查看应用路由列表" +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 new file mode 100644 index 000000000..7ab514545 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/03-view-route-details.adoc @@ -0,0 +1,41 @@ +--- +title: "查看应用路由详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 应用路由, 查看应用路由列表" +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 new file mode 100644 index 000000000..885632118 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/04-access-a-backend-service-of-a-route.adoc @@ -0,0 +1,43 @@ +--- +title: "访问应用路由的后端服务" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 应用路由, 访问应用路由的后端服务" +description: "介绍如何访问应用路由的后端服务。" +weight: 04 +--- + + +:ks_permission: **应用负载查看** +:ks_navigation: **应用负载 > 应用路由** + + +include::../../../../_custom/clusterManagement/routes/routes-desc-accessABackendServiceOfARoute.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../ +* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 + +: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 new file mode 100644 index 000000000..608872b00 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/05-edit-route-information.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑应用路由信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 应用路由, 编辑应用路由信息" +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 new file mode 100644 index 000000000..ada5f0db6 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/06-edit-routing-rules.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑路由规则" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 应用路由, 编辑路由规则" +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 new file mode 100644 index 000000000..823d2de63 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/07-edit-route-annotations.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑应用路由注解" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 应用路由, 编辑应用路由注解" +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 new file mode 100644 index 000000000..b751b333b --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/08-delete-routes.adoc @@ -0,0 +1,49 @@ +--- +title: "删除应用路由" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载, 应用路由, 删除应用路由" +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 new file mode 100644 index 000000000..ac0c1befc --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "应用路由" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用路由" +description: "介绍如何管理应用路由。" +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 new file mode 100644 index 000000000..95e6970df --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "应用负载" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用负载" +description: "介绍如何管理工作负载、任务、容器组、服务和应用路由。" +weight: 05 +--- + + + +本节介绍如何管理工作负载、任务、容器组、服务和应用路由。 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 new file mode 100644 index 000000000..9abb1f223 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/01-create-a-secret.adoc @@ -0,0 +1,40 @@ +--- +title: "创建保密字典" +keywords: "Kubernetes, {ks_product}, 集群管理, 保密字典" +description: "介绍如何创建保密字典。" +weight: 01 +--- + +:ks_permission: **项目资源管理** +:ks_navigation: **配置 > 保密字典** + + +include::../../../../_custom/clusterManagement/secrets/secrets-desc-createASecret.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::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/secrets/secrets-oper-createASecret.adoc[] 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 new file mode 100644 index 000000000..5ad706269 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/02-view-a-secret-list.adoc @@ -0,0 +1,44 @@ +--- +title: "查看保密字典列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 保密字典" +description: "介绍如何查看保密字典列表。" +weight: 02 +--- + +:ks_permission: **项目资源查看** +:ks_navigation: **配置 > 保密字典** + + +include::../../../../_custom/clusterManagement/secrets/secrets-desc-viewASecretList.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/secrets/secrets-para-secretList.adoc[] + +* 在列表左上角的下拉列表中选择一个项目，可查看特定项目中的保密字典。 + +include::../../../../_custom/clusterManagement/secrets/secrets-oper-searchForSecrets.adoc[] + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..92bf04f5f --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/03-view-secret-details.adoc @@ -0,0 +1,40 @@ +--- +title: "查看保密字典详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 保密字典" +description: "介绍如何查看保密字典详情。" +weight: 03 +--- + +:ks_permission: **项目资源查看** +:ks_navigation: **配置 > 保密字典** + + +include::../../../../_custom/clusterManagement/secrets/secrets-desc-viewSecretDetails.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/secrets/secrets-oper-openSecretDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/secrets/secrets-oper-viewSecretDetails.adoc[] 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 new file mode 100644 index 000000000..efd1bfb7a --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/04-edit-secret-information.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑保密字典信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 保密字典, 编辑保密字典信息" +description: "介绍如何编辑保密字典的键值对数据。" +weight: 04 +--- + +:ks_permission: **项目资源管理** +:ks_navigation: **配置 > 保密字典** + + +include::../../../../_custom/clusterManagement/secrets/secrets-desc-editSecretInformation.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/secrets/secrets-oper-editSecretInformation.adoc[] 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 new file mode 100644 index 000000000..e42e1ea18 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/05-edit-secret-settings.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑保密字典设置" +keywords: "Kubernetes, {ks_product}, 集群管理, 保密字典, 编辑保密字典设置" +description: "介绍如何编辑保密字典的设置。" +weight: 05 +--- + +:ks_permission: **项目资源管理** +:ks_navigation: **配置 > 保密字典** + + +include::../../../../_custom/clusterManagement/secrets/secrets-desc-editSecretSettings.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/secrets/secrets-oper-editSecretSettings.adoc[] 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 new file mode 100644 index 000000000..1de8a5216 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/06-delete-secrets.adoc @@ -0,0 +1,49 @@ +--- +title: "删除保密字典" +keywords: "Kubernetes, {ks_product}, 集群管理, 保密字典, 删除保密字典" +description: "介绍如何删除保密字典。" +weight: 06 +--- + +:ks_permission: **项目资源管理** +:ks_navigation: **配置 > 保密字典** + + +include::../../../../_custom/clusterManagement/secrets/secrets-desc-deleteSecrets.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/secrets/secrets-oper-deleteASingleSecret.adoc[] + + +== 批量删除保密字典 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/secrets/secrets-oper-deleteMultipleSecrets.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/_index.adoc new file mode 100644 index 000000000..6bee59f7b --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/01-secrets/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "保密字典" +keywords: "Kubernetes, {ks_product}, 集群管理, 配置, 保密字典" +description: "介绍如何管理保密字典。" +weight: 01 +--- + + + +include::../../../../_custom/clusterManagement/secrets/secrets-desc-secrets.adoc[] 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 new file mode 100644 index 000000000..c5d12834c --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/01-create-a-configmap.adoc @@ -0,0 +1,40 @@ +--- +title: "创建配置字典" +keywords: "Kubernetes, {ks_product}, 集群管理, 配置字典, 创建配置字典" +description: "介绍如何创建配置字典。" +weight: 01 +--- + +:ks_permission: **项目资源管理** +:ks_navigation: **配置 > 配置字典** + + +include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-createAConfigmap.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::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/configmaps/configmaps-oper-createAConfigmap.adoc[] 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 new file mode 100644 index 000000000..a005cadcf --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/02-view-a-configmap-list.adoc @@ -0,0 +1,44 @@ +--- +title: "查看配置字典列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 配置字典, 查看配置字典列表" +description: "介绍如何查看配置字典列表。" +weight: 02 +--- + +:ks_permission: **项目资源查看** +:ks_navigation: **配置 > 配置字典** + + +include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-viewAConfigmapList.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/configmaps/configmaps-para-configmapList.adoc[] + +* 在列表左上角的下拉列表中选择一个项目，可查看特定项目中的配置字典。 + +include::../../../../_custom/clusterManagement/configmaps/configmaps-oper-searchForConfigmaps.adoc[] + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..082bc67a5 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/03-view-configmap-details.adoc @@ -0,0 +1,40 @@ +--- +title: "查看配置字典详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 配置字典, 查看配置字典详情" +description: "介绍如何查看配置字典详情。" +weight: 03 +--- + +:ks_permission: **项目资源查看** +:ks_navigation: **配置 > 配置字典** + + +include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-viewConfigmapDetails.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/configmaps/configmaps-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/configmaps/configmaps-oper-viewConfigmapDetails.adoc[] 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 new file mode 100644 index 000000000..352959ada --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/04-edit-configmap-information.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑配置字典信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 配置字典, 编辑配置字典信息" +description: "介绍如何编辑配置字典信息。" +weight: 04 +--- + +:ks_permission: **项目资源管理** +:ks_navigation: **配置 > 配置字典** + + +include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-editConfigmapInformation.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/configmaps/configmaps-oper-editConfigmapInformation.adoc[] 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 new file mode 100644 index 000000000..52012841e --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/05-edit-configmap-settings.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑配置字典设置" +keywords: "Kubernetes, {ks_product}, 集群管理, 配置字典, 编辑配置字典设置" +description: "介绍如何编辑配置字典数据设置。" +weight: 05 +--- + +:ks_permission: **项目资源管理** +:ks_navigation: **配置 > 配置字典** + + +include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-editConfigmapSettings.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/configmaps/configmaps-oper-editConfigmapSettings.adoc[] 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 new file mode 100644 index 000000000..d7ffc6923 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/06-delete-configmaps.adoc @@ -0,0 +1,49 @@ +--- +title: "删除配置字典" +keywords: "Kubernetes, {ks_product}, 集群管理, 配置字典, 删除配置字典" +description: "介绍如何删除配置字典。" +weight: 06 +--- + +:ks_permission: **项目资源管理** +:ks_navigation: **配置 > 配置字典** + + + + + +== 前提条件 + + +: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/configmaps/configmaps-oper-deleteASingleConfigmap.adoc[] + + +== 批量删除配置字典 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/configmaps/configmaps-oper-deleteMultipleConfigmaps.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/_index.adoc new file mode 100644 index 000000000..2021eb9ba --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/02-configmaps/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "配置字典" +keywords: "Kubernetes, {ks_product}, 集群管理, 配置字典" +description: "介绍如何管理配置字典。" +weight: 02 +--- + + + +include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-configmaps.adoc[] + +配置字典仅用于存储非保密数据。如需存储保密数据，请使用link:../01-secrets/[保密字典]。 \ No newline at end of file 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 new file mode 100644 index 000000000..3c69e1bc4 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/01-create-a-service-account.adoc @@ -0,0 +1,36 @@ +--- +title: "创建服务帐户" +keywords: "Kubernetes, {ks_product}, 集群管理, 服务帐户" +description: "介绍如何创建服务帐户。" +weight: 01 +--- + +:ks_permission: **项目资源管理** +:ks_navigation: **配置 > 服务帐户** + + +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-createAServiceAccount.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/serviceAccounts/serviceAccounts-oper-createAServiceAccount.adoc[] 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 new file mode 100644 index 000000000..5854e8b88 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/02-view-a-service-account-list.adoc @@ -0,0 +1,44 @@ +--- +title: "查看服务帐户列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 服务帐户" +description: "介绍如何查看集群中服务帐户的列表。" +weight: 02 +--- + +:ks_permission: **项目资源查看** +:ks_navigation: **配置 > 服务帐户** + + +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-viewAServiceAccountList.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/serviceAccounts/serviceAccounts-para-serviceAccountList.adoc[] + +* 在列表左上角的下拉列表中选择一个项目，可以查看特定项目中的服务帐户。 + +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-searchForServiceAccounts.adoc[] + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== 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 new file mode 100644 index 000000000..b965c12ce --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/03-view-service-account-details.adoc @@ -0,0 +1,40 @@ +--- +title: "查看服务帐户详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 服务帐户, 查看服务帐户详情" +description: "介绍如何查看服务帐户详情。" +weight: 03 +--- + +:ks_permission: **项目资源查看** +:ks_navigation: **配置 > 服务帐户** + + +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-viewServiceAccountDetails.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/serviceAccounts/serviceAccounts-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-viewServiceAccountDetails.adoc[] 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 new file mode 100644 index 000000000..ed23b20cb --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/04-edit-service-account-information.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑服务帐户信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 服务帐户" +description: "介绍如何编辑服务帐户的别名、描述和项目角色。" +weight: 04 +--- + +:ks_permission: **项目资源管理** +:ks_navigation: **配置 > 服务帐户** + + +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-editServiceAccountInformation.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/serviceAccounts/serviceAccounts-oper-editServiceAccountInformation.adoc[] 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 new file mode 100644 index 000000000..752c4f0f9 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/05-change-the-role-of-a-service-account.adoc @@ -0,0 +1,36 @@ +--- +title: "修改服务帐户角色" +keywords: "Kubernetes, {ks_product}, 集群管理, 服务帐户, 修改服务帐户角色" +description: "介绍如何修改服务帐户角色。" +weight: 05 +--- + +:ks_permission: **项目资源管理** +:ks_navigation: **配置 > 服务帐户** + + +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-changeTheRoleOfAServiceAccount.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/serviceAccounts/serviceAccounts-oper-changeTheRoleOfAServiceAccount.adoc[] 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 new file mode 100644 index 000000000..f2b77bf81 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/06-delete-service-accounts.adoc @@ -0,0 +1,49 @@ +--- +title: "删除服务帐户" +keywords: "Kubernetes, {ks_product}, 集群管理, 服务帐户, 删除服务帐户" +description: "介绍如何删除服务帐户。" +weight: 06 +--- + +:ks_permission: **项目资源管理** +:ks_navigation: **配置 > 服务帐户** + + +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-deleteServiceAccounts.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/serviceAccounts/serviceAccounts-oper-deleteASingleServiceAccount.adoc[] + + +== 批量删除服务帐户 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-deleteMultipleServiceAccounts.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/_index.adoc new file mode 100644 index 000000000..d3f508408 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/03-service-accounts/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "服务帐户" +keywords: "Kubernetes, {ks_product}, 集群管理, 服务帐户" +description: "介绍如何管理服务帐户。" +weight: 03 +--- + + + +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-serviceAccounts.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/06-configuration/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/06-configuration/_index.adoc new file mode 100644 index 000000000..779d58f06 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/06-configuration/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "配置" +keywords: "Kubernetes, {ks_product}, 集群管理, 配置" +description: "介绍如何管理保密字典、配置字典和服务帐户。" +weight: 06 +--- + + + +include::../../../_custom/clusterManagement/clusterManagement-desc-configuration.adoc[] 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 new file mode 100644 index 000000000..b740ce632 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/07-crds/01-view-a-crd-list.adoc @@ -0,0 +1,63 @@ +--- +title: "查看定制资源定义列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 定制资源定义, 查看定制资源定义列表" +description: "介绍如何查看定制资源定义列表。" +weight: 01 +--- + +:ks_permission: **定制资源定义查看** +:ks_navigation: **定制资源定义** + + +本节介绍如何查看定制资源定义列表。 + + +== 前提条件 + + +:relfileprefix: ../../../ + +include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components/oper-navigate.adoc[] + ++ +==== +* 定制资源定义列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|类别 +|定制资源定义的类别和 API 版本。 + +|名称 +|定制资源定义的名称。 + +|作用域 +| +include::../../../_custom/clusterManagement/crds/crds-para-scope.adoc[] + +|创建时间 +|定制资源定义的创建时间。 +|=== +-- + +* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的定制资源定义。 + +include::../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../_ks_components/oper-customizeColumns.adoc[] +==== 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 new file mode 100644 index 000000000..d12eea32f --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/07-crds/02-view-crd-details.adoc @@ -0,0 +1,78 @@ +--- +title: "查看定制资源定义详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 定制资源定义, 查看定制资源定义列表" +description: "介绍如何查看定制资源定义详情。" +weight: 02 +--- + +:ks_permission: **定制资源定义查看** +:ks_navigation: **定制资源定义** + + +本节介绍如何查看定制资源定义详情。 + + +== 前提条件 + + +: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/crds/crds-oper-openDetailsPage.adoc[] + ++ + +. 在定制资源定义详情页面左侧的**属性**区域查看任务的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群 +|定制资源定义所属的集群。 + +|作用域 +| +include::../../../_custom/clusterManagement/crds/crds-para-scope.adoc[] + +|创建时间 +|定制资源定义的创建时间。 + +|创建者 +|创建定制资源定义的用户。 +|=== +-- + +. 在定制资源定义详情页面右侧的**定制资源定义**页签查看使用定制资源定义创建的定制资源。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|定制资源的名称。 + +|项目/DevOps 项目 +|定制资源所属的项目或 DevOps 项目。 + +|创建时间 +|定制资源的创建时间。 +|=== +-- 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 new file mode 100644 index 000000000..7db0dc266 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/07-crds/03-edit-a-custom-resource.adoc @@ -0,0 +1,55 @@ +--- +title: "编辑定制资源" +keywords: "Kubernetes, {ks_product}, 集群管理, 定制资源定义, 编辑定制资源" +description: "介绍如何编辑定制资源。" +weight: 03 +--- + +:ks_permission: **定制资源定义管理** +:ks_navigation: **定制资源定义** + + +本节介绍如何编辑定制资源。 + + +== 前提条件 + + +: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/crds/crds-oper-openDetailsPage.adoc[] + ++ + +. 在**定制资源定义**页签，在需要编辑的定制资源右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑 YAML**。 + +. 在**编辑 YAML** 对话框修改定制资源的 YAML 设置，然后点击**确定**。 ++ +-- +* 在对话框右上角点击image:/images/ks-qkcp/zh/icons/upload-dark-white.svg[upload-dark-white,18,18]可上传本地的 YAML 配置文件。 + +* 在对话框右上角点击image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download-dark-white,18,18]可将 YAML 配置文件下载到本地。 + +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +您需要根据定制资源定义规范和控制器提供的 API 修改定制资源的设置。有关更多信息，请参阅 link:https://kubernetes.io/zh/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/[Kubernetes 官方文档]。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] +-- 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 new file mode 100644 index 000000000..8044746a5 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/07-crds/04-delete-a-custom-resource.adoc @@ -0,0 +1,53 @@ +--- +title: "删除定制资源" +keywords: "Kubernetes, {ks_product}, 集群管理, 定制资源定义, 删除定制资源" +description: "介绍如何删除定制资源。" +weight: 04 +--- + +:ks_permission: **定制资源定义管理** +:ks_navigation: **定制资源定义** + + +本节介绍如何删除定制资源。 + +//warning +[.admon.warning,cols="a"] +|=== +|警告 + +| +删除自定义资源可能会导致相关业务中断，请谨慎执行此操作。 + +|=== + + +== 前提条件 + + +: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/crds/crds-oper-openDetailsPage.adoc[] + ++ + +. 在**定制资源定义**页签，在需要删除的定制资源右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除定制资源定义**对话框，输入自定义资源的名称，然后点击**确定**。 + diff --git a/content/zh/docs/v4.1/07-cluster-management/07-crds/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/07-crds/_index.adoc new file mode 100644 index 000000000..decfc2ac6 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/07-crds/_index.adoc @@ -0,0 +1,14 @@ +--- +title: "定制资源定义" +keywords: "Kubernetes, {ks_product}, 集群管理, 定制资源定义" +description: "介绍如何管理集群定制资源定义。" +weight: 07 +--- + + + +本节介绍如何管理定制资源定义。 + +定制资源定义用于对 Kubernetes 现有的 API 进行扩展。您可以使用定制资源定义创建定制资源，并通过额外的控制器监听定制资源的各种事件来实现自定义的业务逻辑。 + +{ks_product_right} Web 控制台目前仅支持查看定制资源定义和定制资源，以及编辑现有的定制资源，不支持直接创建定制资源定义和定制资源。您可以参阅 link:https://kubernetes.io/zh/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/[Kubernetes 官方文档]通过命令行创建定制资源定义和定制资源。 \ No newline at end of file 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 new file mode 100644 index 000000000..e6e378eca --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/01-create-a-persistent-volume-claim.adoc @@ -0,0 +1,40 @@ +--- +title: "创建持久卷声明" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 持久卷声明, 持久卷, 创建持久卷声明" +description: "介绍如何创建持久卷声明。" +weight: 01 +--- + +:ks_permission: **持久卷声明管理** +:ks_navigation: **存储 > 持久卷声明** + + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAPersistentVolumeClaim.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::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim_new.adoc[] 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 new file mode 100644 index 000000000..33389ed84 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/02-view-a-persistent-volume-claim-list.adoc @@ -0,0 +1,44 @@ +--- +title: "查看持久卷声明列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 持久卷声明, 持久卷, 查看持久卷声明列表" +description: "介绍如何查看持久卷声明列表。" +weight: 02 +--- + +:ks_permission: **持久卷声明查看** +:ks_navigation: **存储 > 持久卷声明** + + +include::../../../../_custom/clusterManagement/pods/pods-desc-viewAPersistentVolumeList.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/persistentVolumeClaims/persistentVolumeClaims-para-persistentVolumeClaimList.adoc[] + +* 在列表左上角的下拉列表中选择一个项目，可以查看特定项目中的持久卷声明。 + +* 在列表上方点击搜索框并输入关键字，可按名称和状态搜索持久卷声明。 + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.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 new file mode 100644 index 000000000..2db3d0f29 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/03-view-persistent-volume-claim-details.adoc @@ -0,0 +1,40 @@ +--- +title: "查看持久卷声明详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 持久卷声明, 持久卷, 查看持久卷声明详情" +description: "介绍如何查看持久卷声明的详情。" +weight: 03 +--- + +:ks_permission: **持久卷声明查看** +:ks_navigation: **存储 > 持久卷声明** + + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-viewPersistentVolumeClaimDetails.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/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails_new.adoc[] 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 new file mode 100644 index 000000000..056c6256e --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/04-clone-a-persistent-volume.adoc @@ -0,0 +1,42 @@ +--- +title: "克隆持久卷" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 持久卷声明, 持久卷, 克隆持久卷" +description: "介绍如何克隆持久卷。" +weight: 04 +--- + +:ks_permission: **持久卷声明管理** +:ks_navigation: **存储 > 持久卷声明** + + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-cloneAPersistentVolume.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../ +* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 + +:relfileprefix: ./ + + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc[] + +* 请确保后端存储系统支持卷克隆功能，并且持久卷声明对应的存储类已启用卷克隆功能。有关更多信息，请参阅link:../../02-storage-classes/05-enable-and-disable-volume-operations/[启用和禁用卷操作]。 + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-cloneAPersistentVolume.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 new file mode 100644 index 000000000..624f9d94c --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/05-expand-a-persistent-volume.adoc @@ -0,0 +1,42 @@ +--- +title: "扩展持久卷" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 持久卷声明, 持久卷, 扩展持久卷" +description: "介绍如何扩展持久卷容量。" +weight: 05 +--- + +:ks_permission: **持久卷声明管理** +:ks_navigation: **存储 > 持久卷声明** + + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-expandAPersistentVolumeClaim.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../ +* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 + +:relfileprefix: ./ + + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc[] + +* 请确保后端存储系统支持卷扩展功能，并已在持久卷声明对应的存储类上启用卷扩展功能。有关更多信息，请参阅link:../../02-storage-classes/05-enable-and-disable-volume-operations/[启用和禁用卷操作]。 + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-expandAPersistentVolume.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/07-set-auto-expansion.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/07-set-auto-expansion.adoc new file mode 100644 index 000000000..f544239b3 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/07-set-auto-expansion.adoc @@ -0,0 +1,59 @@ +--- +title: "设置存储卷自动扩展" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 持久卷声明, 持久卷,自动扩展" +description: "介绍如何设置存储卷自动扩展。" +weight: 07 +draft: true +--- + +:ks_permission: **持久卷声明管理** +:ks_navigation: **存储 > 持久卷声明** + + +卷容量自动扩展指系统在卷剩余空间低于阈值时自动扩展卷容量。本节介绍如何设置存储卷自动扩展。 + + +== 前提条件 + +:relfileprefix: ../../../../ +* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 + +:relfileprefix: ./ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc[] + +* 请确保后端存储系统支持卷扩展功能，并已在持久卷声明对应的存储类上启用卷扩展功能。有关更多信息，请参阅link:../../02-storage-classes/05-enable-and-disable-volume-operations/[启用和禁用卷操作]。 + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc[] + ++ + +. 在持久卷声明详情页面的左上角，选择**更多操作 > 设置自动扩展**。 + +. 在**设置自动扩展**对话框，点击页面右侧的**已禁用**按钮启用自动扩展功能。 ++ +-- +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +如果您需要禁用自动扩展功能，在页面右侧点击**已启用**。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +. 在**自动扩展**设置区域，设置扩展的最大容量、阈值、以及增量。 + +. （可选）如果您需要系统自动检查卷状态并重启工作负载，请勾选**自动重启工作负载**。 + +. 设置完成后，点击**确定**以开启自动扩展。 \ No newline at end of file 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 new file mode 100644 index 000000000..793fa0496 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/08-edit-persistent-volume-claim-information.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑持久卷声明信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 持久卷声明, 持久卷, 编辑持久卷声明信息" +description: "介绍如何编辑持久卷声明的基本信息。" +weight: 08 +--- + +:ks_permission: **持久卷声明管理** +:ks_navigation: **存储 > 持久卷声明** + + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-editPersistentVolumeClaimInformation.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/persistentVolumeClaims/persistentVolumeClaims-oper-editPersistentVolumeClaimInformation.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/09-delete-persistent-volume-claim.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/09-delete-persistent-volume-claim.adoc new file mode 100644 index 000000000..6aec41c2b --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/09-delete-persistent-volume-claim.adoc @@ -0,0 +1,49 @@ +--- +title: "删除持久卷声明" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 持久卷声明, 持久卷, 删除持久卷声明" +description: "介绍如何删除持久卷声明。" +weight: 09 +--- + +:ks_permission: **持久卷声明管理** +:ks_navigation: **存储 > 持久卷声明** + + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-deletePersistentVolumeClaims.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../ +* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 + +:relfileprefix: ./ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-backData.adoc[] + + +== 删除单个持久卷声明 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteASinglePersistentVolumeClaim.adoc[] + + +== 批量删除持久卷声明 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteMultiplePersistentVolumeClaims.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 new file mode 100644 index 000000000..ba5ae87c2 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/10-view-a-persistent-volume-list.adoc @@ -0,0 +1,76 @@ +--- +title: "查看持久卷列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 持久卷声明, 持久卷, 查看持久卷列表" +description: "介绍如何查看持久卷列表。" +weight: 10 +--- + +:ks_permission: **持久卷声明查看** +:ks_navigation: **存储 > 持久卷声明** + + +本节介绍如何查看持久卷列表。 + + +== 前提条件 + + +: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/persistentVolumes/persistentVolumes-oper-openListPage.adoc[] + ++ +==== +* 持久卷列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|持久卷的名称、别名和存储类。自动供应的持久卷的名称由系统自动生成。有关存储类的更多信息，请参阅link:../../02-storage-classes/[存储类]。 + +|状态 +| +include::../../../../_custom/clusterManagement/persistentVolumes/persistent-volume-status.adoc[] + +|容量 +| +include::../../../../_custom/clusterManagement/persistentVolumes/persistentVolumes-para-volumeSize.adoc[] + +|访问模式 +| +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-accessMode.adoc[] + +|回收策略 +| +include::../../../../_custom/clusterManagement/persistentVolumes/persistentVolumes-para-reclaimPolicy.adoc[] + +|创建时间 +|持久卷的创建时间。 +|=== +-- + +* 在列表上方点击搜索框可按名称或状态搜索持久卷。 + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== 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 new file mode 100644 index 000000000..131f44a58 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/11-view-persistent-volume-details.adoc @@ -0,0 +1,92 @@ +--- +title: "查看持久卷详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 持久卷声明, 持久卷, 查看持久卷详情" +description: "介绍如何查看集群中持久卷的详情。" +weight: 11 +--- + +:ks_permission: **持久卷声明查看** +:ks_navigation: **存储 > 持久卷声明** + + +本节介绍如何查看集群中持久卷的详情。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**持久卷声明**页面点击**持久卷**打开持久卷列表，然后点击一个持久卷的名称打开其详情页面。 + +. 在持久卷详情页面左侧的**属性**区域查看持久卷的资源属性。 ++ +-- + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|状态 +| +include::../../../../_custom/clusterManagement/persistentVolumes/persistent-volume-status.adoc[] + +|容量 +| +include::../../../../_custom/clusterManagement/persistentVolumes/persistentVolumes-para-volumeSize.adoc[] + +|访问模式 +| +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-accessMode.adoc[] + +|存储类 +|持久卷声明对应的存储类。有关存储类的更多信息，请参阅link:../../02-storage-classes/[存储类]。 + +|卷句柄 +|持久卷在后端存储系统中的唯一标识符。 + +|回收策略 +| +include::../../../../_custom/clusterManagement/persistentVolumes/persistentVolumes-para-reclaimPolicy.adoc[] + +|卷模式 +|持久卷的设备类型。 + +* **文件系统**：持久卷以文件系统的形式挂载到容器上供容器使用。 + +* **块设备**：持久卷以块设备的形式提供给容器。 + +|创建时间 +|持久卷的创建时间。 +|=== +-- + +. 在持久卷详情页面右侧的**资源状态**页签查看持久卷对应的持久卷声明的信息。 ++ +-- +include::../../../../_custom/clusterManagement/persistentVolumes/persistentVolumes-para-pvcInformation.adoc[] +-- + +. 在持久卷详情页面右侧的**元数据**页签查看持久卷的标签和注解。 + +. 在持久卷详情页面右侧点击**事件**页签查看持久卷的事件。 ++ +-- +include::../../../../_custom/clusterManagement/clusterManagement-para-eventsTab.adoc[] +-- 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 new file mode 100644 index 000000000..c9d316663 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/12-edit-persistent-volume-information.adoc @@ -0,0 +1,57 @@ +--- +title: "编辑持久卷信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 持久卷声明, 持久卷, 编辑持久卷信息" +description: "介绍如何编辑持久卷的信息。" +weight: 12 +--- + +:ks_permission: **持久卷声明管理** +:ks_navigation: **存储 > 持久卷声明** + + +本节介绍如何编辑持久卷的信息。 + +您可以编辑持久卷的别名和描述。{ks_product_right}不支持编辑持久卷的名称。 + + +== 前提条件 + + +: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/persistentVolumes/persistentVolumes-oper-openListPage.adoc[] + ++ + +. 在需要操作的持久卷右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置持久卷的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|持久卷的别名。不同持久卷的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|持久卷的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|=== +-- diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..08565886c --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/13-delete-a-persistent-volume.adoc @@ -0,0 +1,53 @@ +--- +title: "删除持久卷" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 持久卷声明, 持久卷, 删除持久卷" +description: "介绍如何删除持久卷。" +weight: 13 +--- + +:ks_permission: **持久卷声明管理** +:ks_navigation: **存储 > 持久卷声明** + + +本节介绍如何删除持久卷。 + +{ks_product_right}平台的存储类的默认回收策略为 **Delete**，即默认情况下持久卷声明删除后系统会自动删除持久卷。如果您通过后台命令行创建回收策略为 **Retain** 的存储类，可能会存在持久卷声明被删除而持久卷未被删除的情况。有关更多信息，请参阅 link:https://kubernetes.io/zh/docs/concepts/storage/storage-classes/[Kubernetes 官方文档]。 + +// Warning +include::../../../../../_ks_components/admonitions/warning.adoc[] + +持久卷删除后不能恢复，并且持久卷对应的后端存储区域也将被删除，请谨慎执行此操作以避免数据丢失。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../ +* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 + +:relfileprefix: ./ + + +* 持久卷的状态为**可用**、**已释放**或**失败**。 + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-backData.adoc[] + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumes/persistentVolumes-oper-openListPage.adoc[] + ++ + +. 在需要删除的持久卷右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除持久卷**对话框，输入持久卷的名称，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/_index.adoc new file mode 100644 index 000000000..d89ed17dd --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "持久卷声明" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 持久卷声明, 持久卷" +description: "介绍如何管理卷。" +weight: 01 +--- + + + +本节介绍如何管理持久卷声明和持久卷。 + +持久卷声明定义了对存储资源的需求，系统将根据持久卷声明在后端存储系统中创建存储区域供容器使用，每个存储区域对应{ks_product_both}平台上的一个持久卷。 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 new file mode 100644 index 000000000..6f648d16b --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/01-create-a-storage-class.adoc @@ -0,0 +1,109 @@ +--- +title: "创建存储类" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 存储类, 创建存储类" +description: "介绍如何创建存储类。" +weight: 01 +--- + +:ks_permission: **存储类管理** +:ks_navigation: **存储 > 存储类** + + +本节介绍如何创建存储类。 + + +== 前提条件 + +:relfileprefix: ../../../../ +* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 + +:relfileprefix: ./ + + +* 为使存储类可以正常提供存储资源，您需要提前配置存储系统并安装与存储系统对应的存储插件。更多相关信息，请联系您的存储系统提供商。 + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**基本信息**页签，设置存储类的基本信息，然后点击**下一步**。 ++ +-- +[%header,cols="1,4"] +|=== +|参数 |描述 + +|名称 +|存储类的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 + +|别名 +|存储类的别名。不同存储类的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|存储类的描述信息。描述可包含任意字符，最长 256 个字符。 +|=== +-- + +. 在**存储系统**页签，选择一个系统或**自定义**，然后点击**下一步**。 + +. 在**存储类设置**页签，设置存储类的参数，然后点击**创建**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|卷扩展 +| +include::../../../../_custom/clusterManagement/storageClasses/systemClasses-para-allowVolumeExpansion.adoc[] + +|回收策略 +| +include::../../../../_custom/clusterManagement/persistentVolumes/persistentVolumes-para-reclaimPolicy.adoc[] + +|访问模式 +| +允许卷使用的读写模式。 + +* **ReadWriteOnce**：允许单个节点读取卷中的数据并向卷写入数据。 + +* **ReadOnlyMany**：允许多个节点读取卷中的数据。 + +* **ReadWriteMany**：允许多个节点读取卷中的数据并向卷写入数据。 + +您可以在下拉列表中选择一种或多种访问模式。部分存储系统可能不支持某些访问模式。 + +|供应者 +| +include::../../../../_custom/clusterManagement/persistentVolumes/persistentVolumes-para-provisioner.adoc[] + +|卷绑定模式 +|持久卷声明创建后是否立即创建持久卷并将持久卷和持久卷声明绑定，支持以下模式： + +* **立即绑定**：持久卷声明创建后立即创建持久卷并将持久卷和持久卷声明绑定。 + +* **延迟绑定**：挂载持久卷的容器创建后创建持久卷并将持久卷和持久卷声明绑定。 + +|参数 +|与后端存储系统和存储插件匹配的参数键值对。 + +* 点击**添加**可设置多个参数。 + +* 在已创建的参数右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除参数。 + +更多相关信息，请联系您的存储系统提供商。 +|=== + +存储类创建完成后将显示在存储类列表中。 +-- 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 new file mode 100644 index 000000000..b7cd37576 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/02-view-a-storage-class-list.adoc @@ -0,0 +1,84 @@ +--- +title: "查看存储类列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 存储类, 查看存储类列表" +description: "介绍如何查看存储类列表。" +weight: 02 +--- + +:ks_permission: **存储类查看** +:ks_navigation: **存储 > 存储类** + + +本节介绍如何查看存储类列表。 + + +== 前提条件 + + + +:relfileprefix: ../../../../ + +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ +==== +* 存储类列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|存储类的名称、别名和描述信息。 + +|持久卷声明数量 +|通过存储类创建的持久卷声明的数量。 + +|默认存储类 +| +include::../../../../_custom/clusterManagement/storageClasses/systemClasses-para-defaultStorageClass.adoc[] + +|允许卷克隆 +| +include::../../../../_custom/clusterManagement/storageClasses/systemClasses-para-allowVolumeCloning.adoc[] + +|允许卷快照 +| +include::../../../../_custom/clusterManagement/storageClasses/systemClasses-para-allowVolumeSnapshot.adoc[] + +|允许卷扩展 +| +include::../../../../_custom/clusterManagement/storageClasses/systemClasses-para-allowVolumeExpansion.adoc[] + +|供应者 +| +include::../../../../_custom/clusterManagement/persistentVolumes/persistentVolumes-para-provisioner.adoc[] +|=== + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +**允许卷克隆**、**允许卷快照**和**允许卷扩展**仅表明是否允许用户在{ks_product_left} Web 控制台上执行操作，持久卷声明是否实际支持这些操作取决于后端存储系统。有关更多信息，请参阅link:../05-enable-and-disable-volume-operations/[设置卷操作]。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的存储类。 + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== 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 new file mode 100644 index 000000000..af1118669 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/03-view-storage-class-details.adoc @@ -0,0 +1,101 @@ +--- +title: "查看存储类详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 存储类, 查看存储类详情" +description: "介绍如何查看存储类详情。" +weight: 03 +--- + +:ks_permission: **存储类查看** +:ks_navigation: **存储 > 存储类** + + +本节介绍如何查看存储类详情。 + + +== 前提条件 + + +: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/storageClasses/systemClasses-oper-openDetailsPage.adoc[] + ++ + +. 在存储类详情页面左侧的**属性**区域查看存储类的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|供应者 +| +include::../../../../_custom/clusterManagement/persistentVolumes/persistentVolumes-para-provisioner.adoc[] + +|默认存储类 +| +include::../../../../_custom/clusterManagement/storageClasses/systemClasses-para-defaultStorageClass.adoc[] + +|允许卷扩展 +| +include::../../../../_custom/clusterManagement/storageClasses/systemClasses-para-allowVolumeExpansion.adoc[] + +|回收策略 +| +include::../../../../_custom/clusterManagement/persistentVolumes/persistentVolumes-para-reclaimPolicy.adoc[] + +|允许卷快照 +| +include::../../../../_custom/clusterManagement/storageClasses/systemClasses-para-allowVolumeSnapshot.adoc[] +|=== +-- + +. 在存储类详情页面右侧的**持久卷声明**页签查看使用该存储类创建的持久卷声明。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|卷的名称和别名。 + +|状态 +| +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-status.adoc[] + +|容量 +|卷请求的存储容量大小。 + +|挂载状态 +|卷是否已经挂载到容器组。 + +|项目 +|卷所属的项目。 + +|创建时间 +|卷的创建时间。 +|=== + +* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的卷。 + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +-- 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 new file mode 100644 index 000000000..41444745e --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/04-set-a-default-storage-class.adoc @@ -0,0 +1,42 @@ +--- +title: "设置默认存储类" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 存储类, 设置默认存储类" +description: "介绍如何设置默认存储类。" +weight: 04 +--- + +:ks_permission: **存储类管理** +:ks_navigation: **存储 > 存储类** + + +本节介绍如何设置默认存储类。设置默认存储类后，如果没有特殊指定，系统将使用默认存储类创建持久卷声明。每个{ks_product_both}集群中仅允许设置一个默认存储类。 + + +== 前提条件 + + +: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/storageClasses/systemClasses-oper-openDetailsPage.adoc[] + ++ + +. 在存储类详情页面的左上角，选择**更多操作 > 设为默认存储类**。 + +. 在**设为默认存储类**对话框点击**确定**。 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 new file mode 100644 index 000000000..b846269ae --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/05-enable-and-disable-volume-operations.adoc @@ -0,0 +1,71 @@ +--- +title: "启用和禁用卷操作" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 存储类, 启用和禁用卷操作" +description: "介绍如何启用和禁用卷操作。" +weight: 05 +--- + +:ks_permission: **存储类管理** +:ks_navigation: **存储 > 存储类** + + +本节介绍如何启用和禁用卷操作。 + +您可以设置是否允许用户在{ks_product_left} Web 控制台对特定存储类创建的持久卷声明进行克隆和扩展操作。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +本节介绍的步骤仅控制是否允许用户在{ks_product_left} Web 控制台使用相关操作，持久卷是否实际支持这些操作取决于后端存储系统。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../ +* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。 + +:relfileprefix: ./ + + +* 如需启用某个功能，请确保后端存储系统实际支持该功能。 + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/storageClasses/systemClasses-oper-openDetailsPage.adoc[] + ++ + +. 在存储类详情页面的左上角，选择**更多操作 > 设置卷操作**。 + +. 在**设置卷操作**对话框，启用或禁用卷克隆和卷扩展操作，然后点击**确定**。 ++ +-- + +[%header,cols="1,4"] +|=== +|功能 |描述 + +|卷克隆 +| +include::../../../../_custom/clusterManagement/storageClasses/systemClasses-para-allowVolumeCloning.adoc[] + +// |卷快照 +// | +// include::../../../../_custom/clusterManagement/storageClasses/systemClasses-para-allowVolumeSnapshot.adoc[] + +|卷扩展 +| +include::../../../../_custom/clusterManagement/storageClasses/systemClasses-para-allowVolumeExpansion.adoc[] +|=== +-- 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 new file mode 100644 index 000000000..54f34f478 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/06-edit-storage-class-information.adoc @@ -0,0 +1,53 @@ +--- +title: "编辑存储类信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储类" +description: "介绍如何编辑存储类的别名和描述。" +weight: 06 +--- + +:ks_permission: **存储类管理** +:ks_navigation: **存储 > 存储类** + + +本节介绍如何编辑存储类的别名和描述。 + +您可以编辑存储类的别名和描述。{ks_product_right}不支持编辑存储类的名称。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的存储类右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置存储类的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|存储类的别名。不同存储类的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|存储类的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|=== +-- diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..5ba503d7e --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/07-delete-a-storage-class.adoc @@ -0,0 +1,64 @@ +--- +title: "删除存储类" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储类" +description: "介绍如何删除存储类。" +weight: 07 +--- + +:ks_permission: **存储类管理** +:ks_navigation: **存储 > 存储类** + + +本节介绍如何删除存储类。 + +// Warning +include::../../../../../_ks_components/admonitions/warning.adoc[] + +存储类删除后，基于存储类创建持久卷声明和持久卷不会被删除，容器仍然可以使用已挂载的持久卷，但将用户将无法使用卷克隆、卷快照和卷扩展功能，并且无法再通过该存储类在后端存储系统中创建存储区域。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 删除单个存储类 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要删除的存储类右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除存储类**对话框，输入存储类的名称，然后点击**确定**。 + + +== 批量删除存储类 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 选择需要删除的存储类左侧的复选框，然后在存储类列表上方点击**删除**。 + +. 在**批量删除存储类**对话框，输入存储类的名称，然后点击**确定**。 ++ +-- +include::../../../../_custom/note-separateNamesByComma.adoc[] +-- diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/_index.adoc new file mode 100644 index 000000000..0c99a15f9 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "存储类" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 存储类" +description: "介绍如何管理存储类。" +weight: 02 +--- + + + +本节介绍如何管理存储类。 + +存储类定义了可供容器使用的一类存储卷。如果您在安装{ks_product_both}时未设置外部持久化存储系统，{ks_product_right}将使用集群节点的本地存储系统作为持久化存储系统，并自动创建对应的 **local** 存储类。如果使用外部持久化存储系统，您需要为{ks_product_both}集群安装存储插件，并创建存储类以定义可供使用的存储卷类型。有关如何安装存储插件，请联系您的存储系统提供商。 diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/_index.adoc new file mode 100644 index 000000000..77c71be71 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/_index.adoc @@ -0,0 +1,24 @@ +--- +title: "存储" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储" +description: "介绍如何管理存储资源。" +weight: 08 +--- + + + +本节介绍如何管理存储资源。 + +{ks_product_right}支持管理以下存储资源： + +* 存储类：定义可供容器使用的一类持久卷声明。 + +* 持久卷声明：定义持久卷的存储空间需求。 + +* 持久卷：代表后端存储系统中的存储区域。系统根据持久卷声明中的参数，在后端存储系统中创建可供容器使用的存储区域，每个存储区域与{ks_product_both}平台上的一个持久卷对应。 + +// * 卷快照类：定义可保存快照数据的一类卷快照。 + +// * 卷快照：定义快照数据的存储需求。 + +// * 卷快照内容：代表后端存储系统中的快照数据。系统根据卷快照中的参数，在后端存储系统中保存快照数据，每个快照数据单元与{ks_product_both}平台上的一个卷快照内容对应。 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 new file mode 100644 index 000000000..a3252e6ba --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/01-view-cluster-basic-information.adoc @@ -0,0 +1,35 @@ +--- +title: "查看集群基本信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 基本信息, 查看集群基本信息" +description: "介绍如何查看集群基本信息。" +weight: 01 +--- + +:ks_permission: **集群设置查看** +:ks_navigation: **集群设置 > 基本信息** + + +本节介绍如何查看集群基本信息。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +// . 在**基本信息**页签，查看集群的名称、提供商、Kubernetes 版本、节点数量、CPU 数量、内存容量和磁盘容量。 + +. 在**基本信息**页签，查看集群的名称、提供商、Kubernetes 版本。 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 new file mode 100644 index 000000000..59d547ffa --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/02-edit-cluster-basic-information.adoc @@ -0,0 +1,61 @@ +--- +title: "编辑集群基本信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 基本信息, 编辑集群基本信息" +description: "介绍如何查看集群基本信息。" +weight: 02 +--- + +:ks_permission: **集群设置管理** +:ks_navigation: **集群设置 > 基本信息** + + +本节介绍如何编辑集群基本信息。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +{ks_product_right}不支持修改已添加的集群的名称。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**基本信息**页面右侧点击**编辑信息**。 + +. 在**编辑信息**对话框，设置集群的标签、提供商和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|标签 +|用于标识集群的用途，取值可以为**生产环境**、**开发环境**、**测试环境**或**演示环境**。 + +|提供商 +|集群的提供商。 + +|描述 +|集群的描述信息。描述可包含任意字符，最长 256 个字符。 +|=== +-- diff --git a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/_index.adoc new file mode 100644 index 000000000..5182640b0 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "基本信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 基本信息" +description: "介绍如何查看和编辑集群基本信息。" +weight: 01 +--- + + + +本节介绍如何查看和编辑集群基本信息。 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 new file mode 100644 index 000000000..2bc68ffeb --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/01-view-cluster-visibility.adoc @@ -0,0 +1,52 @@ +--- +title: "查看集群可见性" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群可见性, 查看集群可见性" +description: "介绍如何查看集群已授权给哪些企业空间。" +weight: 01 +--- + +:ks_permission: **集群设置查看** +:ks_navigation: **集群设置 > 集群可见性** + + +本节介绍如何查看集群已授权给哪些企业空间。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群可见性 +|集群是否对所有企业空间可见。 + +|企业空间 +|已获得授权的企业空间。 + +|管理员 +|企业空间的管理员。 + +|授权时间 +|企业空间获得授权的时间。 +|=== +-- 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 new file mode 100644 index 000000000..98ef95b53 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/02-edit-cluster-visibility.adoc @@ -0,0 +1,56 @@ +--- +title: "编辑集群可见性" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群可见性, 编辑集群可见性" +description: "介绍如何编辑集群可见性。" +weight: 02 +--- + +:ks_permission: **集群设置管理** +:ks_navigation: **集群设置 > 集群可见性** + + + +本节介绍如何编辑集群可见性。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在页面右侧点击**编辑可见性**。 + +. 在**编辑可见性**对话框对企业空间进行授权或取消授权，然后点击**确定**。 ++ +-- +* 点击**未授权**列表中的企业空间可将集群授权给企业空间。 + +* 点击**已授权**列表中的企业空间可取消对企业空间的授权。 + +* 打开**设置为公开集群**开关可将集群授权给{ks_product_both}平台上的所有企业空间。 + +// Warning +include::../../../../../_ks_components/admonitions/warning.adoc[] + +* 请尽可能避免将主集群授权给企业空间，主集群负载过高会导致多集群系统稳定性下降。 + +* 移除集群对企业空间的授权后，企业空间在当前集群中的所有资源将被删除。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- diff --git a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/_index.adoc new file mode 100644 index 000000000..65cde5ff5 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/02-cluster-visibility/_index.adoc @@ -0,0 +1,20 @@ +--- +title: "集群可见性" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群可见性" +description: "介绍如何管理集群可见性。" +weight: 02 +--- + + + +本节介绍如何管理集群可见性。集群可见性用于控制集群授权给哪些企业空间。 + +* 您可以将一个集群授权给多个企业空间，从而允许企业空间中的资源运行在该集群上。 + +ifeval::["{file_output_type}" == "html"] +* 您也可以将多个集群授权给同一个企业空间，从而在企业空间中创建联邦项目。有关联邦项目的更多信息，请参阅link:../../../11-use-extensions/04-kubefed[联邦项目]。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +* 您也可以将多个集群授权给同一个企业空间，从而在企业空间中创建联邦项目。有关联邦项目的更多信息，请参阅《{ks_product_right}扩展组件使用指南》的“联邦集群应用管理”章节。 +endif::[] \ No newline at end of file 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 new file mode 100644 index 000000000..ec0f54a6f --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/01-invite-a-user-to-a-cluster.adoc @@ -0,0 +1,46 @@ +--- +title: "邀请用户加入集群" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 集群成员, 邀请用户加入集群" +description: "介绍如何邀请用户加入集群。" +weight: 01 +--- + +:ks_permission: **成员管理** +:ks_navigation: **集群设置 > 集群成员** + + +本节介绍如何邀请用户加入集群。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickInvite.adoc[] + ++ + +. 在**邀请成员**对话框，在需要邀请的用户右侧点击image:/images/ks-qkcp/zh/icons/add-dark.svg[add-dark,18,18]，在下拉列表中选择用户在集群中的角色，然后点击**确定**。 ++ +-- +include::../../../../_custom/clusterManagement/clusterMembers/clusterMembers-para-presetClusterRoles.adoc[] + +用户被邀请加入集群后将显示在集群成员列表中。 +-- 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 new file mode 100644 index 000000000..a27025777 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/02-view-a-cluster-member-list.adoc @@ -0,0 +1,68 @@ +--- +title: "查看集群成员列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 集群成员, 查看集群成员列表" +description: "介绍如何查看集群成员列表。" +weight: 02 +--- + +:ks_permission: **成员查看** +:ks_navigation: **集群设置 > 集群成员** + + +本节介绍如何查看集群成员列表。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +==== +* 集群成员列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|用户名 +|集群成员的用户名。 + +|状态 +| +集群成员当前的状态。 + +include::../../../../_custom/clusterManagement/clusterMembers/clusterMembers-para-userStatus.adoc[] + +|角色 +|集群成员在集群中的角色。 + +* **cluster-admin**：集群管理员，在集群内具有除创建和删除集群以外的所有权限。 + +* **cluster-viewer**：集群观察员，在集群内具有所有资源的查看权限。 + +|最近登录 +|集群成员最近一次登录{ks_product_left} Web 控制台的时间。 +|=== +-- + +* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的集群成员。 + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== 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 new file mode 100644 index 000000000..daf4a22d1 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/03-change-the-role-of-a-cluster-member.adoc @@ -0,0 +1,42 @@ +--- +title: "修改集群成员的角色" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 集群成员, 修改集群成员的角色" +description: "介绍如何修改集群成员的角色。" +weight: 03 +--- + +:ks_permission: **成员管理** +:ks_navigation: **集群设置 > 集群成员** + + +本节介绍如何修改集群成员的角色。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要移除的集群成员右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后选择**修改角色**。 + +. 在**修改角色**对话框，设置集群成员的角色，然后点击**确定**。 ++ +-- +include::../../../../_custom/clusterManagement/clusterMembers/clusterMembers-para-presetClusterRoles.adoc[] +-- 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 new file mode 100644 index 000000000..eca6558ea --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/04-remove-a-cluster-member.adoc @@ -0,0 +1,49 @@ +--- +title: "移除集群成员" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 集群成员, 移除集群成员" +description: "介绍如何将用户邀请到集群。" +weight: 04 +--- + +:ks_permission: **成员管理** +:ks_navigation: **集群设置 > 集群成员** + + +本节介绍如何移除集群成员。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +从集群中移除用户后，用户将失去集群角色提供的权限。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要移除的集群成员右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后选择**移除**。 + +. 在**移除成员**对话框输出集群成员的用户名，然后点击**确定**。 ++ +-- +集群成员被移除后将不再显示在集群成员列表中。 +-- diff --git a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc new file mode 100644 index 000000000..2d8ae1b38 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc @@ -0,0 +1,19 @@ +--- +title: "集群成员" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群成员" +description: "介绍如何管理集群成员。" +weight: 03 +--- + + + +本节介绍如何管理集群成员。 + +集群成员是在集群中具有资源查看或管理权限的用户，集群成员的权限由成员在集群中的角色决定。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +include::../../../../_custom/clusterManagement/clusterMembers/clusterMembers-desc-initialClusterAdmin.adoc[] + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] 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 new file mode 100644 index 000000000..62e20e6ae --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/01-view-a-cluster-role-list.adoc @@ -0,0 +1,36 @@ +--- +title: "查看集群角色列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 集群成员, 查看集群角色列表" +description: "介绍如何查看集群成员列表。" +weight: 01 +--- + +:ks_permission: **角色查看** +:ks_navigation: **集群设置 > 集群角色** + + +本节介绍如何查看集群角色列表。 + + +== 前提条件 + + +: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/clusterMembers/clusterMembers-para-presetClusterRoles.adoc[] +-- 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 new file mode 100644 index 000000000..001a760bd --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/02-view-cluster-role-details.adoc @@ -0,0 +1,227 @@ +--- +title: "查看集群角色详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 集群成员, 查看集群角色详情" +description: "介绍如何查看集群成员详情。" +weight: 02 +--- + +:ks_permission: **角色查看** +:ks_navigation: **集群设置 > 集群角色** + + +本节介绍如何查看集群角色详情。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在集群角色列表中点击一个集群角色的名称打开其详情页面。 + +. 在集群角色详情页面右侧的**权限**页签查看集群角色具有的权限。 ++ +==== +所有集群成员都可以查看集群的基本信息。其他操作所需的权限如下： + +// * 集群网络资源 +// + +// -- +// [%header,cols="1a,4a"] +// |=== +// |权限 |允许操作 + +// |集群网络资源查看 +// |查看容器组 IP 池列表。查看容器组 IP 池详情、查看网络策略列表、查看网络策略详情。 + +// |集群网络资源管理 +// |创建容器组 IP 池、将容器组 IP 池分配给企业空间、编辑容器组 IP 池信息、删除容器组 IP 池、创建网络策略、编辑网络策略信息、删除网络策略。 +// |=== +// -- + +* 存储 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|持久卷声明查看 +|查看持久卷声明列表、查看持久卷声明详情、查看持久卷列表、查看持久卷详情。 + +|持久卷声明管理 +|创建持久卷声明、克隆持久卷、扩展持久卷、编辑持久卷声明信息、编辑持久卷信息、删除持久卷声明、删除持久卷。 + +|存储类查看 +|查看存储类列表、查看存储类详情。 + +|存储类管理 +|创建存储类、设置默认存储类、启用和禁用卷操作、编辑存储类信息、删除存储类。 + +// |卷快照查看 +// |查看卷快照列表、查看卷快照详情、查看卷快照内容列表、查看卷快照内容详情。 + +// |卷快照管理 +// |创建卷快照、使用卷快照创建持久卷、删除卷快照、编辑卷快照内容信息、删除卷快照内容。 + +// |卷快照类查看 +// |查看卷快照类列表、查看卷快照类详情。 + +// |卷快照类管理 +// |创建卷快照类、编辑卷快照类信息、删除卷快照类。 +|=== +-- + +* 访问控制 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|角色查看 +|查看集群角色列表、查年集群角色详情。 + +|成员查看 +|查看集群成员列表。 + +|成员管理 +|邀请用户加入集群、修改集群成员的角色、移除集群成员。 +|=== +-- + +* 项目 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +// |项目资源查看 +// | +// * 工作负载查看：查看工作负载列表、查看工作负载详情。 + +// * 任务查看：查看任务列表、查看任务详情。 + +// * 容器组查看：查看容器组列表、查看容器组详情。 + +// * 服务查看：查看服务列表、查看服务详情。 + +// * 应用路由查看：查看应用路由列表、查看应用路由详情、通过{ks_product_left} Web 控制台访问应用路由后端服务。 + +// * 保密字典查看：查看保密字典列表、查看保密字典详情。 + +// * 配置字典查看：查看配置字典列表、查看配置字典详情。 + +// * 服务帐户查看：查看服务帐户列表、查看服务帐户详情。 + +// |项目资源管理 +// | +// * 工作负载管理：创建工作负载、编辑工作负载信息、重新创建工作负载、删除工作负载、调整容器组副本数量、停止工作负载、回退工作负载设置、编辑自动伸缩设置、编辑工作负载设置。 + +// * 任务管理：创建任务、编辑任务信息、删除任务、重新运行任务、停止任务。 + +// * 容器组管理：访问容器终端、删除容器组。 + +// * 服务管理：创建服务、编辑服务信息、编辑服务设置、编辑监控导出器、删除服务。 + +// * 应用路由管理：创建应用路由、编辑应用路由信息、编辑路由规则、编辑应用路由注解、删除应用路由。 + +// * 保密字典管理：创建保密字典、编辑保密字典信息、编辑保密字典设置、删除保密字典。 + +// * 配置字典管理：创建配置字典、编辑配置字典信息、编辑配置字典设置、删除配置字典；创建服务帐户、编辑服务帐户信息、为服务帐户分配角色、删除服务帐户。 + +|项目查看 +|查看项目列表、查看项目详情。 + +|项目管理 +|创建项目、编辑项目信息、编辑项目注解、编辑项目配额、编辑默认容器配额、删除项目。 +|=== +-- + +* 集群资源 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|节点查看 +|查看节点列表、查看节点详情。 + +|节点管理 +|阻止和允许容器组调度到节点、访问节点终端、编辑节点污点、编辑节点标签。 + +// |系统组件查看 +// |查看系统组件列表、查看系统组件详情。 + +|定制资源定义查看 +|查看定制资源定义列表、查看定制资源定义详情。 + +|定制资源定义管理 +|编辑定制资源、删除定制资源。 +|=== +-- + +* 集群设置 ++ +-- +[%header,cols="1a,4a"] +|=== +|权限 |允许操作 + +|集群设置查看 +|查看集群概览信息、查看集群基本信息、查看集群可见性。 + +|集群设置管理 +|使用集群管理功能、编辑集群基本信息、编辑集群可见性。 +|=== +-- + +// * 监控告警 +// + +// -- +// [%header,cols="1a,4a"] +// |=== +// |权限 |允许操作 + +// |监控查看 +// |查看集群状态概览、查看物理资源状态、查看 etcd 状态、查看 API 服务器状态、查看调度器监控数据、查看节点资源用量排行、查看自定义监控面板、查看日志接收器列表。 + +// |监控管理 +// |查看资源用量、查看项目资源用量排行、创建自定义监控面板、编辑自定义监控面板信息、编辑自定义监控面板、删除自定义监控面板、添加日志接收器、编辑日志接收器设置、删除日志接收器。 + +// |规则组查看 +// |查看规则组列表、查看规则组详情。 + +// |规则组管理 +// |创建规则组、编辑规则组、删除规则组。 + +// |告警查看 +// |查看告警列表。 +// |=== +// -- + +==== + +. 在集群角色详情页面右侧点击**授权用户**页签，查看具有当前集群角色的用户。 ++ +-- +include::../../../../_custom/clusterManagement/clusterRoles/clusterRoles-para-authorizedUsers.adoc[] +-- diff --git a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc new file mode 100644 index 000000000..ccdb8d1bd --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc @@ -0,0 +1,22 @@ +--- +title: "集群角色" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群角色" +description: "介绍如何管理集群角色。" +weight: 04 +--- + + + +本节介绍如何管理集群角色。 + +每个集群角色都包含特定的集群管理或查看权限。您可以将包含特定权限的角色授予集群成员，以控制集群成员在集群中的权限。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +* {empty} +include::../../../../_custom/clusterManagement/clusterMembers/clusterMembers-desc-initialClusterAdmin.adoc[] + +* {ks_product_right}目前不支持创建自定义集群角色，您可以在{ks_product_left} Web 控制台查看预置集群角色的相关信息。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/_index.adoc new file mode 100644 index 000000000..3545059e9 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "集群设置" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置" +description: "介绍如何管理集群设置。" +weight: 09 +--- + + + +本节介绍如何管理集群设置。 \ No newline at end of file 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 new file mode 100644 index 000000000..692f57e67 --- /dev/null +++ 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 @@ -0,0 +1,61 @@ +--- +title: "通过直接连接添加成员集群" +keywords: "Kubernetes, {ks_product}, 多集群管理, 集群, 添加成员集群" +description: "介绍如何通过直接连接添加成员集群。" +weight: 01 +--- + + + +本节介绍如何通过直接连接添加成员集群。 + + +== 前提条件 + +* 您需要在主集群中具有 **platform-admin** 角色。 + +* 主集群所有节点必须能访问成员集群的 Kubernetes API 服务（默认为成员集群主节点的 6443 端口）。取决于您的网络环境，您可能需要配置防火墙和流量转发规则。 + +== 获取成员集群 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[] + + + +== 添加成员集群 + +include::../../../../../_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToHost.adoc[] + ++ + +. 点击**集群管理**。 + ++ + +include::../../../../../_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterBasicInfo.adoc[] ++ +在**高级设置**下，设置集群的用途标识。 ++ + +. 在**连接设置**页签，将**连接方式**设置为**直接连接**，在 **kubeconfig** 区域输入成员集群的 kubeconfig 信息，然后点击**下一步**。 + +. 在**集群配置**页签，设置集群配置，然后点击**创建**。 ++ +-- +成员集群添加完成后将显示在**集群管理**页面的集群列表中。 +-- diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/_index.adoc new file mode 100644 index 000000000..128a3bdc2 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/01-add-a-member-cluster/_index.adoc @@ -0,0 +1,27 @@ +--- +title: "添加成员集群" +keywords: "Kubernetes, {ks_product}, 多集群管理, 集群, 添加成员集群" +description: "介绍如何添加成员集群。" +weight: 01 +--- + + + +本节介绍如何添加成员集群。 + +取决于您的网络环境，主集群和成员集群可以采用以下连接方式： + +* 直接连接：如果主集群可以访问成员集群的 Kubernetes API 服务，您可以在主集群上添加成员集群的 kubeconfig 信息，直接连接主集群和成员集群。 + +* 代理连接：如果主集群无法访问成员集群的 Kubernetes API 服务，您可以设置成员集群连接到主集群暴露的代理服务 tower，通过代理服务 tower 连接主集群和成员集群。 ++ +[.admon.note,cols="a"] +|=== +|说明 + +| +若要使用代理连接，{ks_product_both}平台需要安装并启用 **KubeSphere 多集群代理连接**扩展组件。有关更多信息，请参阅link:../../../../11-use-extensions/19-tower/02-add-a-member-cluster-using-proxy-connection/[通过代理连接添加成员集群]。 +|=== + + +无论采用直接连接还是代理连接，主集群和成员集群必须至少一方可以访问另一方暴露的服务。 diff --git a/content/zh/docs/v4.1/07-cluster-management/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 new file mode 100644 index 000000000..23b20d10f --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/02-view-a-cluster-list.adoc @@ -0,0 +1,63 @@ +--- +title: "查看集群列表" +keywords: "Kubernetes, {ks_product}, 多集群管理, 集群, 查看集群列表" +description: "介绍如何查看集群列表。" +weight: 02 +--- + +:ks_menu: **集群管理** +:ks_permission: **集群查看** + + +本节介绍如何查看集群列表。 + + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 + + +== 操作步骤 + +include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 点击**集群管理**。 + +==== +* 集群列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称、标识和描述 +|集群的名称、标识和描述信息。 + +|节点数量 +|集群中服务器节点的数量。 + +|Kubernetes 版本 +|集群中运行的 Kubernetes 版本。 + +|提供商 +|集群环境的提供商。 + +|标签 +|集群的标签，用于对集群进行分类管理。 + +|创建时间 +|集群加入{ks_product_left} Web 控制台的时间。 +|=== +-- + +* 在列表上方点击搜索框并设置搜索条件，可按名称、类型或标签搜索集群。 + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.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 new file mode 100644 index 000000000..e87221abc --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/03-edit-cluster-information.adoc @@ -0,0 +1,48 @@ +--- +title: "编辑集群信息" +keywords: "Kubernetes, {ks_product}, 多集群管理, 集群, 编辑集群信息" +description: "介绍如何编辑集群信息。" +weight: 03 +--- + + +:ks_menu: **集群管理** +:ks_permission: **集群管理** + + +本节介绍编辑集群信息。 + +您可以编辑集群的标识、提供商和描述。{ks_product_right}不支持编辑已添加集群的名称。 + + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 + + + +== 操作步骤 + +include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 点击**集群管理**。 + +. 在需要操作的集群右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置集群的标识、提供商和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|标识 +|集群的用途标识。 + +|提供商 +|集群的提供商。在下拉列表中选择提供商。 + +|描述 +|集群的描述信息。描述可包含任意字符，最长 256 个字符。 +|=== +-- 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 new file mode 100644 index 000000000..64030cc3c --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/04-add-cluster-tags.adoc @@ -0,0 +1,52 @@ +--- +title: "添加集群标签" +keywords: "Kubernetes, {ks_product}, 多集群管理, 集群, 添加集群标签" +description: "介绍如何添加集群标签。" +weight: 04 +--- + +:ks_menu: **平台管理 > 集群管理** +:ks_permission: **集群管理** + + +本节介绍如何添加集群标签。 + +您可以使用标签对集群进行分类管理。 + + +== 前提条件 + + +* 您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 + +* 您需要提前创建集群标签。有关更多信息，请参阅link:../../02-cluster-tags/01-create-a-cluster-tag/[创建集群标签]。 + + +== 对单个集群添加标签 + +include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 点击**集群管理**。 + ++ + +include::../../../../_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterTags.adoc[] + + +== 对多个集群添加标签 + +include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 点击**集群管理**。 + ++ + +. 在集群列表右上角点击**批量管理**。 + +. 选择需要添加标签的集群左侧的复选框，然后在列表上方点击**添加标签**。 + +. 在**添加标签**对话框，选择标签的键和值，点击**添加**，然后点击**确定**。 ++ +-- +标签添加后，您可以集群列表上方点击搜索框按标签搜索集群。 +-- 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 new file mode 100644 index 000000000..4839262f6 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/05-update-kubeconfig.adoc @@ -0,0 +1,51 @@ +--- +title: "更新 kubeconfig" +keywords: "Kubernetes, {ks_product}, 多集群管理, 集群, 更新 kubeconfig" +description: "介绍如何更新成员集群 kubeconfig 信息。" +weight: 05 +--- + + +:ks_menu: **集群管理** +:ks_permission: **集群管理** + + +本节介绍如何更新成员集群 kubeconfig 信息。 + +成员集群添加在主集群的{ks_product_both}平台后，如果成员集群的访问信息发生变化，您需要更新成员集群的 kubeconfig 信息。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +{ks_product_right}仅支持编辑通过直接连接添加的集群的 kubeconfig 信息，不支持编辑通过代理连接添加的集群的 kubeconfig 信息。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 + + + + +== 操作步骤 + +include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 点击**集群管理**。 + +. 在需要操作的集群右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**更新 kubeconfig**。 + +. 在**更新 kubeconfig** 对话框输入 kubeconfig 信息，然后点击**更新**。 ++ +-- +// Tip +include::../../../../../_ks_components/admonitions/tip.adoc[] + +您可以点击image:/images/ks-qkcp/zh/icons/upload-dark-white.svg[upload-dark-white,18,18]从本地上传 kubeconfig 配置文件。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + +主集群的{ks_product_left} Web 控制台将使用新的 kubeconfig 信息连接成员集群。 +-- 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 new file mode 100644 index 000000000..8a0f63589 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/06-remove-a-member-cluster.adoc @@ -0,0 +1,99 @@ +--- +title: "移除成员集群" +keywords: "Kubernetes, {ks_product}, 多集群管理, 集群, 移除成员集群" +description: "介绍如何移除成员集群。" +weight: 06 +--- + +:ks_menu: **集群管理** + + +本节介绍如何移除成员集群。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +* 主集群无法移除。 + +* 成员集群移除后，{ks_product_right}将无法管理该集群。集群中原有的 Kubernetes 资源将不会被删除。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + +// Warning +include::../../../../../_ks_components/admonitions/warning.adoc[] + +集群被移除后，集群中原有的多集群配置数据不会被自动清除，卸载{ks_product_both}或删除关联资源时可能会导致用户数据丢失。请务必在被移除的集群上执行link:#_清理多集群配置数据[清理多集群配置数据]步骤。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +您需要在主集群和需要移除的成员集群都具有 **platform-admin** 角色。 + + + +== 通过 Web 控制台移除集群 + +include::../../../../_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToHost.adoc[] + +. 点击**集群管理**。 + +. 在需要操作的集群右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**移除集群**。 + +. 在**移除集群**对话框，确认需要移除的集群的信息，将滑块拖动到右侧，输入需要移除的集群的名称，根据需要选择或取消选择**删除集群中的所有通知配置数据**，然后点击**确定**。 ++ +-- +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +在多集群系统中，主集群上的通知渠道、静默规则、通知语言等配置数据会自动同步到成员集群。如果移除集群时未选择**删除集群中的所有通知配置数据**，集群被移除后仍将按照原有的配置发送通知。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + + +== 通过命令行移除集群 + +某些情况下可能无法从 Web 控制台移除成员集群。例如，成员集群的凭证存在错误。在此情况下，您可以执行以下步骤通过命令行移除不健康的成员集群： + +include::../../../../_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToHost.adoc[] + ++ + +include::../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-openKubectl.adoc[] + ++ + +. 在 **kubectl** 对话框，执行以下命令移除成员集群（将 替换为成员集群的名称）： ++ +-- +// Bash +include::../../../../../_ks_components/code/bash.adoc[] + +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 + +---- +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/_index.adoc new file mode 100644 index 000000000..bdf251600 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/01-clusters/_index.adoc @@ -0,0 +1,9 @@ +--- +title: "多集群管理" +keywords: "Kubernetes, {ks_product}, 多集群管理, 集群" +description: "介绍如何使用主集群的 Web 控制台管理多个集群。" +weight: 01 +--- + + +本节介绍如何使用主集群的 Web 控制台管理多个集群。 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 new file mode 100644 index 000000000..474c5fc55 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/01-create-a-cluster-tag.adoc @@ -0,0 +1,46 @@ +--- +title: "创建集群标签" +keywords: "Kubernetes, {ks_product}, 多集群管理, 集群标签, 创建集群标签" +description: "介绍如何创建集群标签。" +weight: 01 +--- + +:ks_menu: **平台管理 > 集群管理** +:ks_permission: **集群管理** + + +本节介绍如何创建集群标签。 + + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 + + +== 操作步骤 + +include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + ++ + +. 点击**集群管理**。 + ++ + +include::../../../../_custom/platformManagement/multiclusterManagement/clusterTags/clusterTags-openListPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**创建标签**对话框，设置标签的键和值，然后点击**确定**。 ++ +-- +* 点击**添加**可同时创建多个标签。 + +* 在已添加的标签右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] 可删除标签。 + +标签创建完成后将显示在标签列表中。 +-- 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 new file mode 100644 index 000000000..9e3934285 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/02-edit-a-cluster-tag.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑集群标签" +keywords: "Kubernetes, {ks_product}, 多集群管理, 集群标签, 编辑集群标签" +description: "介绍如何编辑集群标签。" +weight: 02 +--- + +:ks_menu: **平台管理 > 集群管理** +:ks_permission: **集群管理** + + +本节介绍如何编辑集群标签。 + + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 + + +== 操作步骤 + +include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + ++ + +. 点击**集群管理**。 + ++ + +include::../../../../_custom/platformManagement/multiclusterManagement/clusterTags/clusterTags-openListPage.adoc[] + ++ + +. 在需要编辑的标签右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑**。 + +. 在**编辑标签**对话框，设置标签的键和值，然后点击**确定**。 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 new file mode 100644 index 000000000..8908edabc --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/03-add-a-tag-to-clusters.adoc @@ -0,0 +1,36 @@ +--- +title: "将标签添加到集群" +keywords: "Kubernetes, {ks_product}, 多集群管理, 集群标签, 将标签添加到集群" +description: "介绍如何将标签添加到集群。" +weight: 03 +--- + +:ks_menu: **平台管理 > 集群管理** +:ks_permission: **集群管理** + + +本节介绍如何将标签添加到集群。 + + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 + + +== 操作步骤 + +include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + ++ + +. 点击**集群管理**。 + ++ + +include::../../../../_custom/platformManagement/multiclusterManagement/clusterTags/clusterTags-openListPage.adoc[] + ++ + +. 在需要添加到集群的标签右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**添加到集群**。 + +. 在**添加标签到集群**对话框，选择需要添加标签的集群，然后点击**确定**。 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 new file mode 100644 index 000000000..211289ca9 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/04-remove-a-tag-from-clusters.adoc @@ -0,0 +1,36 @@ +--- +title: "从集群上移除标签" +keywords: "Kubernetes, {ks_product}, 多集群管理, 集群标签, 从集群上移除标签" +description: "介绍如何从集群上移除标签。" +weight: 04 +--- + +:ks_menu: **平台管理 > 集群管理** +:ks_permission: **集群管理** + + +本节介绍如何从集群上移除标签。 + + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 + + +== 操作步骤 + +include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + ++ + +. 点击**集群管理**。 + ++ + +include::../../../../_custom/platformManagement/multiclusterManagement/clusterTags/clusterTags-openListPage.adoc[] + ++ + +. 在需要从集群上移除的标签右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**从集群上移除**。 + +. 在**从集群上移除标签**对话框，在需要移除标签的集群右侧点击image:/images/ks-qkcp/zh/icons/chain-off-duotone.svg[chain-off-duotone,18,18]，然后点击**确定**。 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 new file mode 100644 index 000000000..83a97b522 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/05-delete-cluster-tags.adoc @@ -0,0 +1,71 @@ +--- +title: "删除集群标签" +keywords: "Kubernetes, {ks_product}, 多集群管理, 集群标签, 删除标签" +description: "介绍如何删除集群标签。" +weight: 05 +--- + +:ks_menu: **平台管理 > 集群管理** +:ks_permission: **集群管理** + + +本节介绍如何删除集群标签。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +如果标签已添加到集群，标签删除后将被从集群上移除。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 + + +== 删除单个标签 + +include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + ++ + +. 点击**集群管理**。 + ++ + +include::../../../../_custom/platformManagement/multiclusterManagement/clusterTags/clusterTags-openListPage.adoc[] + ++ + +. 在需要从集群上移除的标签右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除标签**对话框，输入标签的键和值，然后点击**确定**。 + + +== 批量删除标签 + +include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + ++ + +. 点击**集群管理**。 + ++ + +include::../../../../_custom/platformManagement/multiclusterManagement/clusterTags/clusterTags-openListPage.adoc[] + ++ + +. 选择需要删除的标签左侧的复选框，然后在列表上方点击**删除**。 + +. 在**删除标签**对话框，输入标签的键和值，然后点击**确定**。 ++ +-- +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +请使用半角逗号（,）和空格分隔多个标签键值对。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/_index.adoc new file mode 100644 index 000000000..c2bb909f9 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/02-cluster-tags/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "集群标签" +keywords: "Kubernetes, {ks_product}, 多集群管理, 集群标签" +description: "介绍如何使用主集群的 Web 控制台管理集群标签。" +weight: 02 +--- + + + +本节介绍如何使用主集群的 Web 控制台管理集群标签。 + +当集群数量较多时，您可以创建标签并将标签添加到集群上，从而对集群进行分类管理。 diff --git a/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/_index.adoc new file mode 100644 index 000000000..464bde251 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/10-multi-cluster-management/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "多集群管理" +keywords: "Kubernetes, {ks_product}, 多集群管理" +description: "介绍如何使用主集群的 Web 控制台管理多个集群。" +weight: 10 +--- + + + +本节介绍如何使用主集群的 Web 控制台管理多个集群和集群标签。 diff --git a/content/zh/docs/v4.1/07-cluster-management/_index.adoc b/content/zh/docs/v4.1/07-cluster-management/_index.adoc new file mode 100644 index 000000000..6bd79b3e4 --- /dev/null +++ b/content/zh/docs/v4.1/07-cluster-management/_index.adoc @@ -0,0 +1,40 @@ +--- +title: "集群管理" +keywords: "Kubernetes, {ks_product}, 集群管理" +description: "介绍如何管理集群中的资源。" +weight: 07 +--- + +本文档介绍如何以集群成员身份在{ks_product_both}管理单个或多个集群中的所有资源。 + +{ks_product_right}支持对多个集群进行管理，每个集群可授权给多个企业空间，每个企业空间可包含多个项目。作为多租户系统，{ks_product_right}支持在平台、集群、企业空间和项目级别基于角色对用户的权限进行控制。 + +ifeval::["{file_output_type}" == "pdf"] +== 产品版本 + +本文档适用于{ks_product_left} v4.1.0 版本。 + +== 读者对象 + +本文档主要适用于以下读者： + +* {ks_product_right}用户 + +* 交付工程师 + +* 运维工程师 + +* 售后工程师 + + +== 修订记录 + +[%header,cols="1a,1a,3a"] +|=== +|文档版本 |发布日期 |修改说明 + +|01 +|{pdf_releaseDate} +|第一次正式发布。 +|=== +endif::[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/08-workspace-management/01-web-console/01-log-in-and-go-to-a-workspace.adoc b/content/zh/docs/v4.1/08-workspace-management/01-web-console/01-log-in-and-go-to-a-workspace.adoc new file mode 100644 index 000000000..8308bd531 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/01-web-console/01-log-in-and-go-to-a-workspace.adoc @@ -0,0 +1,34 @@ +--- +title: "登录并进入企业空间" +keywords: "Kubernetes, {ks_product}, 企业空间管理, Web 控制台, 登录并进入企业空间" +description: "介绍如何登录{ks_product_left} Web 控制台并进入企业空间。" +weight: 01 +--- + + + +本节介绍如何登录{ks_product_left} Web 控制台并进入企业空间。 + + +== 前提条件 + +* 您需要获取企业空间成员用户名和密码。 + +include::../../../_custom/workspaceManagement/webConsole/webConsole-prer-logIn.adoc[] + + +== 操作步骤 + +include::../../../_custom/workspaceManagement/webConsole/webConsole-oper-logIn.adoc[] ++ + +include::../../../../_ks_components/admonitions/note.adoc[] + +* {empty} +include::../../../_custom/workspaceManagement/webConsole/webConsole-note-firstLogin.adoc[] + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] + +. 点击**企业空间管理**。 + +. 在**企业空间管理**页面点击一个企业空间的名称进入企业空间。 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 new file mode 100644 index 000000000..0bd294593 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/01-web-console/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Web 控制台" +keywords: "Kubernetes, {ks_product}, 企业空间管理, Web 控制台" +description: "介绍如何登录{ks_product_left} Web 控制台并进入企业空间，以及修改用户的邮箱、语言和密码。" +weight: 01 +--- + + + +本节介绍如何登录{ks_product_left} Web 控制台并进入企业空间。 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 new file mode 100644 index 000000000..2c6fc90e8 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/02-workspaces/01-create-a-workspace.adoc @@ -0,0 +1,48 @@ +--- +title: "创建企业空间" +keywords: "Kubernetes, {ks_product}, 访问控制, 企业空间, 创建企业空间" +description: "介绍如何创建企业空间。" +weight: 01 +--- + +:ks_permission: **企业空间管理** + + +本节介绍如何创建企业空间。 + + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 点击**企业空间管理**。 +. 在页面点击**创建**。 +. 在**创建企业空间**页面，设置企业空间的基本信息，然后点击**下一步**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|企业空间的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符 + +|别名 +|企业空间的别名。别名可包含任意字符，最长 63 个字符。 + +|管理员 +|企业空间的管理员。 + +|描述 +|企业空间的描述信息。描述可包含任意字符，最长 256 个字符。 + +|=== +-- + +. 在**集群设置**页签选择授权给该企业空间的集群（可同时选择多个集群），企业空间中的资源将创建在该集群上。点击**确定**。 ++ +企业空间创建完成后将显示在企业空间列表中。 + 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 new file mode 100644 index 000000000..1b0723355 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/02-workspaces/02-view-a-workspace-list.adoc @@ -0,0 +1,27 @@ +--- +title: "查看企业空间列表" +keywords: "Kubernetes, {ks_product}, 访问控制, 企业空间, 查看企业空间列表" +description: "介绍如何查看企业空间列表。" +weight: 02 +--- + +:ks_permission: **企业空间查看** + +本节介绍如何查看企业空间列表。 + + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 点击**企业空间管理**。 ++ +-- +* 企业空间列表显示当前{ks_product}平台的所有企业空间。 + +* 在企业空间列表中，点击企业空间的名称可进入企业空间，查看和管理企业空间中的资源。 +-- + 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 new file mode 100644 index 000000000..a8b8eefe6 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/02-workspaces/03-edit-workspace-information.adoc @@ -0,0 +1,40 @@ +--- +title: "编辑企业空间信息" +keywords: "Kubernetes, {ks_product}, 访问控制, 企业空间, 编辑企业空间信息" +description: "介绍如何编辑企业空间信息。" +weight: 03 +--- + +:ks_permission: **企业空间管理** + + +本节介绍如何编辑企业空间信息。 + +您可以编辑企业空间的别名和描述。{ks_product_right}不支持编辑已创建企业空间的名称。 + + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 点击**企业空间管理**。 +. 在需要操作的企业空间右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 +. 在**编辑信息**对话框设置企业空间的别名和描述，然后点击**确定**。 + ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|企业空间的别名。别名可包含任意字符，最长 63 个字符。 + +|描述 +|企业空间的描述信息。描述可包含任意字符，最长 256 个字符。 + +|=== +-- diff --git a/content/zh/docs/v4.1/08-workspace-management/02-workspaces/04-delete-workspaces.adoc b/content/zh/docs/v4.1/08-workspace-management/02-workspaces/04-delete-workspaces.adoc new file mode 100644 index 000000000..f5d870bc8 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/02-workspaces/04-delete-workspaces.adoc @@ -0,0 +1,50 @@ +--- +title: "删除企业空间" +keywords: "Kubernetes, {ks_product}, 访问控制, 企业空间, 删除企业空间" +description: "介绍如何删除企业空间。" +weight: 04 +--- + +:ks_permission: **企业空间管理** + + +本节介绍如何删除企业空间。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +系统企业空间 **system-workspace** 无法删除。 + +|=== + + +== 前提条件 + +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。 + + +== 删除单个企业空间 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 点击**企业空间管理**。 +. 在需要操作的企业空间右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 +. 在**删除企业空间**对话框，输入企业空间的名称，然后点击**确定**。 + + +== 批量删除企业空间 +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 点击**企业空间管理**。 +. 选择需要删除的企业空间左侧的复选框，然后在项目列表上方点击**删除**。 +. 在**批量删除企业空间**对话框，输入企业空间的名称，然后点击**确定**。 ++ +[.admon.note,cols="a"] +|=== +|说明 + +| +请使⽤半⻆逗号（,）和空格分隔多个名称。 + +|=== \ No newline at end of file diff --git a/content/zh/docs/v4.1/08-workspace-management/02-workspaces/_index.adoc b/content/zh/docs/v4.1/08-workspace-management/02-workspaces/_index.adoc new file mode 100644 index 000000000..32ca7acc2 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/02-workspaces/_index.adoc @@ -0,0 +1,8 @@ +--- +title: "管理企业空间" +keywords: "Kubernetes, {ks_product}, 访问控制, 企业空间" +description: "介绍如何管理企业空间。" +weight: 02 +--- + +本节介绍如何创建和管理多个企业空间。 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 new file mode 100644 index 000000000..f5b13966b --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/03-overview/01-view-workspace-resource-usage.adoc @@ -0,0 +1,59 @@ +--- +title: "查看资源用量" +keywords: "Kubernetes, {ks_product}, 企业空间管理, 概览, 查看企业空间资源用量" +description: "介绍如何查看企业空间资源用量。" +weight: 01 +--- + +:ks_permission: **企业空间设置查看** +:ks_navigation: **概览** + + +本节介绍如何查看企业空间资源用量。 + + +== 前提条件 + + +:relfileprefix: ../../../ + +include::../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../_ks_components/oper-navigate.adoc[] ++ +**概览**页面的**资源用量**页签提供项目、角色、企业空间成员的数量信息。 + +// ==== +// * **概览**页面的**资源用量**页签提供以下信息： +// + +// -- +// [%header,cols="1a,4a"] +// |=== +// |参数 |描述 + +// |物理资源 +// |企业空间在指定集群中的 CPU 和内存使用情况。 + +// |应用资源 +// |企业空间在指定集群中创建的部署、有状态副本集、守护进程集、任务、定时任务和持久卷声明的数量。 +// |=== +// -- + +// include::../../../../_ks_components/oper-selectTimeRange.adoc[] + +// include::../../../../_ks_components/oper-Autorefresh.adoc[] + +// include::../../../../_ks_components/oper-refreshData.adoc[] + +// * 在右上角点击**集群**下拉列表可查看特定集群中的数据。 +// ==== diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..59ac97e85 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/03-overview/03-view-cluster-resource-usage.adoc @@ -0,0 +1,49 @@ +--- +title: "查看集群信息" +keywords: "Kubernetes, {ks_product}, 企业空间管理, 概览, 查看集群信息" +description: "介绍如何查看集群信息。" +weight: 03 +--- + + +:ks_permission: **企业空间设置查看** +:ks_navigation: **概览** + + +介绍如何查看授权给企业空间的集群的基本信息。 + + +== 前提条件 + + +:relfileprefix: ../../../ + +include::../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**概览**页面点击**集群信息**页签查看授权给企业空间的集群的基本信息。 + +// . 在**概览**页面点击**集群信息**页签查看授权给企业空间的集群的 CPU、内存、磁盘总量和已使用量，以及集群上可创建容器组的总数和已创建容器组的数量。 +// + +// -- +// // Note +// include::../../../../_ks_components/admonitions/note.adoc[] + +// 默认情况下每个集群节点最多可以创建 110 个容器组。 + +// include::../../../../_ks_components/admonitions/admonEnd.adoc[] +// -- + diff --git a/content/zh/docs/v4.1/08-workspace-management/03-overview/_index.adoc b/content/zh/docs/v4.1/08-workspace-management/03-overview/_index.adoc new file mode 100644 index 000000000..6d8afff56 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/03-overview/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "概览" +keywords: "Kubernetes, {ks_product}, 企业空间管理, 概览" +description: "介绍如何查看企业空间概览信息。" +weight: 03 +--- + + + +本节介绍如何查看企业空间概览信息。 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 new file mode 100644 index 000000000..996d6bbc3 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/04-projects/01-create-a-project.adoc @@ -0,0 +1,56 @@ +--- +title: "创建项目" +keywords: "Kuberentes, {ks_product}, 企业空间管理, 项目, 如何创建项目" +description: "介绍如何创建项目。" +weight: 01 +--- + + +:ks_permission: **项目创建** +:ks_navigation: **项目** + + +本节介绍如何创建项目。 + + +== 前提条件 + +:relfileprefix: ../../../ + +include::../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在弹出的对话框，设置项目的参数，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../_custom/clusterManagement/projects/projects-para-name.adoc[] + +include::../../../_custom/clusterManagement/projects/projects-para-aliasDescription.adoc[] + +|集群 +|可供项目使用的集群。项目中的资源运行在此处选择的集群中。 +|=== + +项目创建完成后，您可以邀请用户加入项目并在项目中部署业务。 + +-- diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..d867fc221 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/04-projects/02-view-a-project-list.adoc @@ -0,0 +1,64 @@ +--- +title: "查看项目列表" +keywords: "Kuberentes, {ks_product}, 企业空间管理, 项目, 介绍如何查看项目列表" +description: "介绍如何查看项目列表。" +weight: 02 +--- + +:ks_permission: **项目查看** +:ks_navigation: **项目** + + +include::../../../_custom/workspaceManagement/projects/projects-desc-viewProjectList.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../ + +include::../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../_ks_components/oper-navigate.adoc[] + ++ +==== +* 项目列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|项目的名称和描述信息。 + +|状态 +|项目当前所处的状态。 + +* **活跃**：项目状态正常。 +* **删除中**：项目正在删除中。 + +|创建时间 +|项目的创建时间。 +|=== +-- + +include::../../../_custom/workspaceManagement/projects/projects-oper-searchForProjects.adoc[] + +include::../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../_ks_components/oper-customizeColumns.adoc[] + + +* 在列表中点击一个项目的名称可打开项目管理页面。您可以在项目管理页面查看和管理项目中的资源。 + +==== diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..a4476ac17 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/04-projects/03-edit-project-information.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑项目信息" +keywords: "Kuberentes, {ks_product}, 企业空间管理, 项目, 编辑项目信息" +description: "介绍如何编辑项目信息。" +weight: 03 +--- + +:ks_permission: **项目管理** +:ks_navigation: **项目** + + +include::../../../_custom/clusterManagement/projects/projects-desc-editInformation.adoc[] + +include::../../../_custom/clusterManagement/projects/projects-note-editInformation.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../ + +include::../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../_custom/clusterManagement/projects/projects-oper-editInformation.adoc[] diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..8c0687d5e --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/04-projects/04-edit-project-annotations.adoc @@ -0,0 +1,46 @@ +--- +title: "编辑项目注解" +keywords: "Kuberentes, {ks_product}, 企业空间管理, 项目, 编辑项目注解" +description: "介绍如何编辑项目注解。" +weight: 04 +--- + +:ks_permission: **项目管理** +:ks_navigation: **项目** + + +本节介绍如何编辑项目注解。 + +项目注解是为项目添加额外的元数据或描述性信息的键值对。 + + + +== 前提条件 + +:relfileprefix: ../../../ + +include::../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../_ks_components/oper-navigate.adoc[] + + +. 在需要操作的项目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑注解**。 + +. 在**编辑注解**对话框，设置注解键值对，然后点击**确定**。 ++ +-- +* 点击**添加**可设置多条注解。 + +* 在已创建的注解右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除注解。 +-- + diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..7c41f08c9 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/04-projects/05-edit-project-quotas.adoc @@ -0,0 +1,37 @@ +--- +title: "编辑项目配额" +keywords: "Kuberentes, {ks_product}, 企业空间管理, 项目, 编辑项目配额" +description: "介绍如何编辑项目配额。" +weight: 05 +--- + +:ks_permission: **项目管理** +:ks_navigation: **项目** + + +include::../../../_custom/clusterManagement/projects/projects-desc-editQuotas.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../ + +include::../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../_ks_components/oper-navigate.adoc[] + +. 在需要操作的项目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑配额**。 + ++ + +include::../../../_custom/clusterManagement/projects/projects-oper-editProjectQuotas.adoc[] + 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 new file mode 100644 index 000000000..d76fc4dbe --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/04-projects/06-delete-projects.adoc @@ -0,0 +1,47 @@ +--- +title: "删除项目" +keywords: "Kuberentes, {ks_product}, 企业空间管理, 项目, 删除项目" +description: "介绍如何编辑删除项目。" +weight: 06 +--- + +:ks_permission: **项目管理** +:ks_navigation: **项目** + + +include::../../../_custom/clusterManagement/projects/projects-desc-deleteProjects.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../ + +include::../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + +== 删除单个项目 + +include::../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../_custom/clusterManagement/projects/projects-oper-deleteASingleProject.adoc[] + + +== 批量删除项目 + +include::../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../_custom/clusterManagement/projects/projects-oper-deleteMultipleProjects.adoc[] diff --git a/content/zh/docs/v4.1/08-workspace-management/04-projects/_index.adoc b/content/zh/docs/v4.1/08-workspace-management/04-projects/_index.adoc new file mode 100644 index 000000000..4e692c06e --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/04-projects/_index.adoc @@ -0,0 +1,18 @@ +--- +title: "项目" +keywords: "Kuberentes, {ks_product}, 企业空间管理, 项目" +description: "介绍如何查看项目信息以及管理项目。" +weight: 04 +--- + + + +本节介绍如何管理企业空间中的项目。 + +在{ks_product_both}平台，企业空间和项目都用于对资源进行分组管理。每个企业空间可包含多个项目。 + +// {ks_product_right}支持两类项目： + +// * 普通项目：基于单个集群创建的项目。普通项目中的所有资源都运行在同一个集群上。 + +// * 联邦项目：基于多个集群创建的项目。联邦项目中的资源可运行在不同集群上。 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 new file mode 100644 index 000000000..1e549de11 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/01-add-an-app-repository.adoc @@ -0,0 +1,46 @@ +--- +title: "添加应用仓库" +keywords: "Kubernetes, {ks_product}, 企业空间, 应用仓库, 添加应用仓库" +description: "介绍如何添加应用仓库。" +weight: 01 +--- + +:ks_permission: **应用仓库管理** +:ks_navigation: **应用管理 > 应用仓库** + + +本节介绍如何在企业空间中添加应用仓库。 + + +== 前提条件 + +: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 官方文档]。 + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**添加应用仓库**对话框，设置应用仓库的参数，然后点击**确定**。 ++ +-- +include::../../../../_custom/workspaceManagement/appRepositories/appRepositories-para-createAppRepository_v4.adoc[] + +应用仓库创建完成后将显示在应用仓库列表中。 +-- 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 new file mode 100644 index 000000000..30ee53b53 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/02-view-an-app-repository-list.adoc @@ -0,0 +1,65 @@ +--- +title: "查看应用仓库列表" +keywords: "Kubernetes, {ks_product}, 企业空间, 应用仓库, 查看应用仓库列表" +description: "介绍如何查看应用模板列表。" +weight: 02 +--- + + +:ks_permission: **应用仓库查看** +:ks_navigation: **应用管理 > 应用仓库** + + +本节介绍如何查看应用仓库列表。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +==== +* 应用仓库列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|应用仓库的名称、别名和描述信息。 + +|状态 +|应用仓库当前的状态。 + +* **成功**：应用仓库已添加并同步成功。 + +* **同步中**：应用仓库正在与 Helm Chart 仓库同步中。 + +* **不同步**：同步间隔时间设置为 0 时，应用仓库不与 Helm Chart 仓库同步。 + +* **失败**：应用仓库与 Helm Chart 仓库同步失败。 + +|URL +|Helm Chart 仓库的 URL。 + +|=== +-- + +* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的应用仓库。 + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..2825faf25 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/03-edit-an-app-repository.adoc @@ -0,0 +1,40 @@ +--- +title: "编辑应用仓库" +keywords: "Kubernetes, {ks_product}, 企业空间, 应用仓库, 编辑应用仓库" +description: "介绍如何编辑应用仓库。" +weight: 03 +--- + +:ks_permission: **应用仓库管理** +:ks_navigation: **应用管理 > 应用仓库** + + +本节介绍如何编辑应用仓库。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要编辑的应用仓库右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑**。 + +. 在**编辑应用仓库**对话框，设置应用仓库的参数，然后点击**确定**。 ++ +-- +include::../../../../_custom/workspaceManagement/appRepositories/appRepositories-para-createAppRepository_v4.adoc[] +-- 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 new file mode 100644 index 000000000..401a1582e --- /dev/null +++ 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 @@ -0,0 +1,42 @@ +--- +title: "使应用仓库和 Helm Chart 仓库同步" +keywords: "Kubernetes, {ks_product}, 企业空间, 应用仓库, 使应用仓库和 Helm Chart 仓库同步" +description: "介绍如何同步应用仓库和 Helm Chart 仓库。" +draft: true +weight: 04 +--- + + +:ks_permission: **应用仓库管理** +:ks_navigation: **应用管理 > 应用仓库** + + +本节介绍如何使应用仓库和 Helm Chart 仓库同步。 + +如果您在添加应用仓库时已设置同步周期，系统将根据同步周期自动同步应用仓库和 Helm Chart 仓库。您也可以按照本节介绍的步骤手动使应用仓库和 Helm Chart 仓库同步。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 选择需要同步的应用仓库左侧的复选框，然后在列表上方点击**同步**。 ++ +-- +系统将根据 Helm Chart 仓库更新应用仓库。 +-- \ No newline at end of file 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 new file mode 100644 index 000000000..0df2869ed --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/05-delete-an-app-repository.adoc @@ -0,0 +1,44 @@ +--- +title: "删除应用仓库" +keywords: "Kubernetes, {ks_product}, 企业空间, 应用仓库, 删除应用仓库" +description: "介绍如何删除应用仓库。" +weight: 05 +--- + + +:ks_permission: **应用仓库管理** +:ks_navigation: **应用管理 > 应用仓库** + + +本节介绍如何删除应用仓库。 + +// Warning +include::../../../../../_ks_components/admonitions/warning.adoc[] + +应用仓库删除后，用户将不能从应用仓库安装应用，请谨慎执行此操作。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../ + +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要删除的应用仓库右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除应用仓库**对话框，输入应用仓库的名称，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/_index.adoc b/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/_index.adoc new file mode 100644 index 000000000..6770b13d7 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/05-app-management/02-app-repositories/_index.adoc @@ -0,0 +1,13 @@ +--- +title: "应用仓库" +keywords: "Kubernetes, {ks_product}, 企业空间, 应用管理, 应用仓库" +description: "介绍如何添加和管理应用仓库以部署和管理应用。" +weight: 02 +--- + + +本节介绍如何管理企业空间的应用仓库。 + +在{ks_product_both}平台，应用特指由一个或多个工作负载、服务、应用路由等资源组成的业务程序。{ks_product_right}平台的应用仓库功能底层基于 Helm 实现，通过 Helm Chart 定义应用的编排方式。 + +您可以将 Helm Chart 仓库作为应用仓库添加到企业空间，从而在企业空间的项目中安装应用仓库中的应用。有关如何创建 Helm Chart 仓库，请参阅 link:https://helm.sh/zh/docs/topics/chart_repository/[Helm 官方文档]。 \ No newline at end of file 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 new file mode 100644 index 000000000..fc9ab5965 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/05-app-management/_index.adoc @@ -0,0 +1,15 @@ +--- +title: "应用管理" +keywords: "Kubernetes, {ks_product}, 企业空间, 应用管理" +description: "介绍如何上通过企业空间管理应用模板和应用仓库。" +weight: 05 +--- + + +// 本节介绍如何管理应用仓库。 + +// 在{ks_product_both}平台，应用特指由一个或多个工作负载、服务、应用路由等资源组成的业务程序。{ks_product_right}平台的应用模板和应用仓库功能底层基于 Helm 实现，通过 Helm Chart 定义应用的编排方式。 + +// 您可以在企业空间中创建包含一个或多个应用版本的应用模板（每个应用版本由一个 Helm Chart 定义），从而在企业空间的项目中安装应用模板中定义的应用。您也可以将 Helm Chart 仓库作为应用仓库添加到企业空间，从而在企业空间的项目中安装应用仓库中的应用。 + +// 有关 Helm 的更多信息，请参阅 link:https://helm.sh/zh/docs/[Helm 官方文档]。 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 new file mode 100644 index 000000000..22c6fb8b2 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/01-view-workspace-basic-information.adoc @@ -0,0 +1,43 @@ +--- +title: "查看企业空间基本信息" +keywords: "Kubernetes, {ks_product}, 企业空间, 企业空间设置, 基本信息, 查看企业空间基本信息" +description: "介绍如何查看企业空间基本信息。" +weight: 01 +--- + +:ks_navigation: **企业空间设置 > 基本信息** + + +本节介绍如何查看企业空间基本信息。 + + +== 前提条件 + +您需要加入一个企业空间。有关更多信息，请参阅link:../../03-workspace-members/[企业空间成员]和link:../../04-workspace-roles/[企业空间角色]。 + + +== 操作步骤 + +. 登录{ks_product_left} Web 控制台并进入您的企业空间。 + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +-- +**基本信息**页面提供以下信息： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|企业空间信息 +|当前企业空间的信息，包括企业空间的名称、管理员、创建时间、项目数量、DevOps 项目数量、企业空间成员数量。 + +|网络隔离 +|授权给企业空间的集群的网络隔离状态。当授权给企业空间的集群开启网络隔离后，属于该企业空间且运行在该集群中的容器组将不能被企业空间外部的客户端访问，也不能被集群外部的客户端访问。属于该企业空间且运行在该集群中的容器组的出站流量不受限制。 + +默认禁用，当安装“KubeSphere 网络”扩展组件后，可以启用企业空间网络隔离。 + +|=== +-- 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 new file mode 100644 index 000000000..62c0d5f2f --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/02-edit-workspace-information.adoc @@ -0,0 +1,53 @@ +--- +title: "编辑企业空间信息" +keywords: "Kubernetes, {ks_product}, 企业空间, 企业空间设置, 基本信息, 查看编辑企业空间信息" +description: "介绍如何编辑企业空间信息。" +weight: 02 +--- + +:ks_permission: **企业空间设置管理** +:ks_navigation: **企业空间设置 > 基本信息** + + +本节介绍如何编辑企业空间信息。 + +您可以编辑企业空间的别名和描述。{ks_product_right}不支持编辑已创建企业空间的名称。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**企业空间信息**区域右上角选择**管理 > 编辑信息**。 + +. 在**编辑信息**对话框，设置企业空间的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|企业空间的别名。不同企业空间的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|企业空间的描述信息。描述可包含任意字符，最长 256 个字符。 +|=== +-- 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 new file mode 100644 index 000000000..3d6bae788 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/04-delete-a-workspace.adoc @@ -0,0 +1,54 @@ +--- +title: "删除企业空间" +keywords: "Kubernetes, {ks_product}, 企业空间, 企业空间设置, 基本信息, 删除企业空间" +description: "介绍如何删除企业空间。" +weight: 04 +--- + +:ks_permission: **企业空间设置管理** +:ks_navigation: **企业空间设置 > 基本信息** + + +本节介绍如何删除企业空间。 + +// Warning +include::../../../../../_ks_components/admonitions/warning.adoc[] + +企业空间删除后无法恢复。如果您选择同时删除企业空间中的项目，企业空间中的所有项目以及其中的所有资源也将被删除。请谨慎执行此操作。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**企业空间信息**区域右上角选择**管理 > 删除企业空间**。 + +. 在**删除企业空间**对话框，输入企业空间的名称，然后点击**确定**。 ++ +-- +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +您可以选择**删除企业空间中的项目**复选框，以同时删除企业空间中的所有项目。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- diff --git a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/_index.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/_index.adoc new file mode 100644 index 000000000..c4a9e8bc5 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/01-basic-information/_index.adoc @@ -0,0 +1,9 @@ +--- +title: "基本信息" +keywords: "Kubernetes, {ks_product}, 企业空间, 企业空间设置, 基本信息" +description: "介绍如何查看和编辑企业空间基本信息。" +weight: 01 +--- + + +本节介绍如何查看和管理企业空间基本信息。 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 new file mode 100644 index 000000000..1910c128a --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/01-edit-workspace-quotas.adoc @@ -0,0 +1,64 @@ +--- +title: "编辑企业空间配额" +keywords: "Kubernetes, {ks_product}, 企业空间, 企业空间设置, 企业空间配额, 编辑企业空间配额" +description: "编辑如何查看企业空间配额。" +weight: 01 +--- + +:ks_permission: **企业空间设置管理** +:ks_navigation: **企业空间设置 > 企业空间配额** + + +本节介绍如何编辑企业空间配额。 + +在{ks_product_both}平台，多个集群可以授权给同一个企业空间，您可以在企业空间中设置针对每个集群设置资源配额。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的集群右上角点击**编辑配额**。 + ++ + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|CPU 限制 +|企业空间运行在单个集群中所有容器 CPU 上限总和的最大值。 + +|CPU 预留 +|企业空间运行在单个集群中所有容器 CPU 预留总和的最大值。 + +|内存上限 +|企业空间运行在单个集群中所有容器内存上限总和的最大值。 + +|内存预留 +|企业空间运行在单个集群中所有容器内存预留总和的最大值。 + +|存储资源配额 +|可以对企业空间下的存储资源总量进行限制，包括存储资源总量和存储类关联资源。 +|=== ++ + + +. 修改配额后，点击**确定**。 \ No newline at end of file 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 new file mode 100644 index 000000000..cd1538a94 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/02-view-workspace-quotas.adoc @@ -0,0 +1,38 @@ +--- +title: "查看企业空间配额" +keywords: "Kubernetes, {ks_product}, 企业空间, 企业空间设置, 企业空间配额, 查看企业空间配额" +description: "介绍如何查看企业空间配额。" +weight: 02 +--- + +:ks_permission: **企业空间设置查看** +:ks_navigation: **企业空间设置 > 企业空间配额** + + +本节介绍如何查看企业空间配额。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +-- +**企业空间配额**页面显示授权给企业空间的各集群的资源配额信息： + +include::../../../../_custom/workspaceManagement/workspace-quotas/workspaceQuotas-para-cpuMemoryQuotas.adoc[] +-- 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 new file mode 100644 index 000000000..edfe8b1bb --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/02-workspace-quotas/_index.adoc @@ -0,0 +1,16 @@ +--- +title: "企业空间配额" +keywords: "Kubernetes, {ks_product}, 企业空间, 企业空间设置, 企业空间配额" +description: "介绍如何查看和管理企业空间配额。" +weight: 02 +--- + + + +本节介绍如何查看和管理企业空间资源配额。 + +在{ks_product_both}平台，多个集群可以授权给同一个企业空间，您可以在企业空间中设置针对每个集群设置资源配额。企业空间配额包括两类设置： + +* 资源预留：容器的资源预留是系统为单个容器预留的资源，企业空间资源预留是企业空间运行在单个集群中所有容器资源预留总和的最大值。{ks_product_right}平台目前支持设置企业空间的 CPU 预留和内存预留。 + +* 资源上限：容器的资源上限是单个容器可使用资源的上限，企业空间资源上限是企业空间运行在单个集群中所有容器资源上限总和的最大值。{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 new file mode 100644 index 000000000..f71ac8828 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/01-invite-a-user-to-a-workspace.adoc @@ -0,0 +1,46 @@ +--- +title: "邀请用户加入企业空间" +keywords: "Kubernetes, {ks_product}, 企业空间管理, 企业空间设置, 企业空间成员, 邀请用户加入企业空间" +description: "介绍如何邀请用户加入企业空间。" +weight: 01 +--- + +:ks_permission: **成员管理** +:ks_navigation: **企业空间设置 > 企业空间成员** + + +本节介绍如何邀请用户加入企业空间。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickInvite.adoc[] + ++ + +. 在**邀请成员**对话框，在需要邀请的用户右侧点击image:/images/ks-qkcp/zh/icons/add-dark.svg[add-dark,18,18]，在下拉列表中选择用户在企业空间中的角色，然后点击**确定**。 ++ +-- +include::../../../../_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-presetRoles_v4.adoc[] + +用户被邀请加入企业空间后将显示在企业空间成员列表中。 +-- 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 new file mode 100644 index 000000000..522afc5e5 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/02-view-a-workspace-member-list.adoc @@ -0,0 +1,64 @@ +--- +title: "查看企业空间成员列表" +keywords: "Kubernetes, {ks_product}, 企业空间管理, 企业空间设置, 企业空间成员, 查看企业空间成员列表" +description: "介绍如何查看企业空间成员列表。" +weight: 02 +--- + +:ks_permission: **成员查看** +:ks_navigation: **企业空间设置 > 企业空间成员** + + +本节介绍如何查看企业空间成员列表。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +==== +* 企业空间成员列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|用户名 +|企业空间成员的用户名。 + +|状态 +| +企业空间成员当前的状态。 + +include::../../../../_custom/clusterManagement/clusterMembers/clusterMembers-para-userStatus.adoc[] + +|角色 +|企业空间成员在企业空间中的角色。 + +|最近登录 +|企业空间成员最近一次登录{ks_product_left} Web 控制台的时间。 +|=== +-- + +* 在列表上方点击搜索框并输入关键字，可搜索用户名包含特定关键字的企业空间成员。 + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== 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 new file mode 100644 index 000000000..bbd3631ce --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/03-view-workspace-member-details.adoc @@ -0,0 +1,62 @@ +--- +title: "查看企业空间成员详情" +keywords: "Kubernetes, {ks_product}, 企业空间管理, 企业空间设置, 企业空间成员, 查看企业空间成员详情" +description: "介绍如何查看企业空间成员详情。" +weight: 03 +--- + +:ks_permission: **成员查看** +:ks_navigation: **企业空间设置 > 企业空间成员** + + +本节介绍如何查看企业空间成员详情。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在企业空间成员列表点击一个企业空间成员的名称打开其详情页面。 + +. 在企业空间成员详情页面左侧的**属性**区域查看企业空间成员的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|企业空间 +|当前企业空间的名称。 + +|企业空间角色 +|企业空间成员的角色。 + +|邮箱 +|企业空间成员的邮箱地址。 +|=== +-- + +. 在企业空间成员详情页面右侧的**项目**页签查看企业空间成员所属的项目。 ++ +-- +在左上角点击**集群**下拉列表然后选择一个集群，可查看特定集群中的项目。 + +// * 企业空间成员详情页面目前暂不提供联邦项目的相关信息。 +-- 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 new file mode 100644 index 000000000..35bb17cc3 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/04-change-the-role-of-a-workspace-member.adoc @@ -0,0 +1,42 @@ +--- +title: "修改企业空间成员的角色" +keywords: "Kubernetes, {ks_product}, 企业空间管理, 企业空间设置, 企业空间成员, 修改企业空间成员的角色" +description: "介绍如何修改企业空间成员的角色。" +weight: 04 +--- + +:ks_permission: **成员管理** +:ks_navigation: **企业空间设置 > 企业空间成员** + + +本节介绍如何修改企业空间成员的角色。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的企业空间成员右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后选择**修改角色**。 + +. 在**修改角色**对话框，设置企业空间成员的角色，然后在下拉列表中点击**确定**。 ++ +-- +include::../../../../_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-presetRoles_v4.adoc[] +-- \ No newline at end of file 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 new file mode 100644 index 000000000..3e704f509 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/05-remove-a-workspace-member.adoc @@ -0,0 +1,49 @@ +--- +title: "移除企业空间成员" +keywords: "Kubernetes, {ks_product}, 企业空间管理, 企业空间设置, 企业空间成员, 移除企业空间成员" +description: "介绍如何移除企业空间成员。" +weight: 05 +--- + +:ks_permission: **成员管理** +:ks_navigation: **企业空间设置 > 企业空间成员** + + +本节介绍如何移除企业空间成员。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +用户被从企业空间中移除后，将失去企业空间角色提供的权限。如果用户已加入企业空间中的项目，也会从项目中移除。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要移除的企业空间成员右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后选择**移除**。 + +. 在**移除成员**对话框输出企业空间成员的用户名，然后点击**确定**。 ++ +-- +企业空间成员被移除后将不再显示在企业空间成员列表中。 +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/_index.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/_index.adoc new file mode 100644 index 000000000..f6b7c683f --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/03-workspace-members/_index.adoc @@ -0,0 +1,19 @@ +--- +title: "企业空间成员" +keywords: "Kubernetes, {ks_product}, 企业空间, 企业空间设置, 企业空间成员" +description: "介绍如何管理企业空间成员。" +weight: 03 +--- + + + +本节介绍如何管理企业空间成员。 + +企业空间成员是在企业空间中具有资源查看或管理权限的用户，企业空间成员的权限由成员在企业空间中的角色决定。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +include::../../../../_custom/workspaceManagement/workspaceMembers/workspaceMembers-desc-initialWorkspaceAdmin.adoc[] + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] 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 new file mode 100644 index 000000000..d346578bc --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/01-create-a-workspace-role.adoc @@ -0,0 +1,58 @@ +--- +title: "创建企业空间角色" +keywords: "Kubernetes, {ks_product}, 企业空间, 企业空间设置, 企业空间角色, 创建企业空间角色" +description: "介绍如何如何创建企业空间角色。" +weight: 01 +--- + +:ks_permission: **角色管理** +:ks_navigation: **企业空间设置 > 企业空间角色** + + +本节介绍如何创建企业空间角色。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**创建企业空间角色**对话框，设置企业空间角色的名称、别名和描述，然后点击**编辑权限**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|企业空间角色的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 + +include::../../../../_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-aliasAndDescription.adoc[] +|=== +-- + +. 在**编辑权限**对话框，设置企业空间角色的权限，然后点击**确定**。 ++ +==== +include::../../../../_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions_v4.adoc[] +==== 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 new file mode 100644 index 000000000..d8484ee95 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/02-view-a-workspace-role-list.adoc @@ -0,0 +1,40 @@ +--- +title: "查看企业空间角色列表" +keywords: "Kubernetes, {ks_product}, 企业空间, 企业空间设置, 企业空间角色, 查看企业空间角色列表" +description: "介绍如何查看企业空间角色列表。" +weight: 02 +--- + +:ks_permission: **角色查看** +:ks_navigation: **企业空间设置 > 企业空间角色** + + +本节介绍如何查看企业空间角色列表。 + +每个企业空间角色都包含特定的企业空间管理或查看权限。您可以将包含特定权限的角色授予企业空间成员，以控制企业空间成员在企业空间中的权限。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +-- +include::../../../../_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-presetRoles_v4.adoc[] + +您也可以创建自定义企业空间角色。有关更多信息请参阅link:../01-create-a-workspace-role/[创建企业空间角色]。 +-- 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 new file mode 100644 index 000000000..fb8e26239 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/03-view-workspace-role-details.adoc @@ -0,0 +1,48 @@ +--- +title: "查看企业空间角色详情" +keywords: "Kubernetes, {ks_product}, 企业空间, 企业空间设置, 企业空间角色, 查看企业空间角色详情" +description: "介绍如何查看企业空间角色列表。" +weight: 03 +--- + +:ks_permission: **角色查看** +:ks_navigation: **企业空间设置 > 企业空间角色** + + +本节介绍如何查看企业空间角色详情。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在企业空间角色列表点击一个企业空间角色的名称打开其详情页面。 + +. 在企业空间角色详情页面右侧的**权限**页签查看企业空间角色具有的权限。 ++ +==== +include::../../../../_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions_v4.adoc[] +==== + +. 在企业空间角色详情页面右侧点击**授权用户**页签具有当前企业空间角色的用户。 ++ +-- +include::../../../../_custom/clusterManagement/clusterRoles/clusterRoles-para-authorizedUsers.adoc[] +-- \ No newline at end of file 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 new file mode 100644 index 000000000..4e6eac24f --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/04-edit-workspace-role-information.adoc @@ -0,0 +1,49 @@ +--- +title: "编辑企业空间角色信息" +keywords: "Kubernetes, {ks_product}, 企业空间, 企业空间设置, 企业空间角色, 编辑企业空间角色信息" +description: "介绍如何查看企业空间角色列表。" +weight: 04 +--- + +:ks_permission: **角色管理** +:ks_navigation: **企业空间设置 > 企业空间角色** + + +本节介绍如何编辑企业空间角色信息。 + +您可以编辑由用户创建的企业空间角色的别名和描述。{ks_product_right}不支持编辑预置的企业空间角色，同时不支持编辑企业空间角色的名称。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的企业空间角色右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置企业空间角色的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-aliasAndDescription.adoc[] +|=== +-- 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 new file mode 100644 index 000000000..45e924a06 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/05-edit-permissions-of-a-workspace-role.adoc @@ -0,0 +1,43 @@ +--- +title: "编辑企业空间角色权限" +keywords: "Kubernetes, {ks_product}, 企业空间, 企业空间设置, 企业空间角色, 编辑企业空间角色权限" +description: "介绍如何编辑企业空间角色权限。" +weight: 05 +--- + +:ks_permission: **角色管理** +:ks_navigation: **企业空间设置 > 企业空间角色** + + +本节介绍如何编辑企业空间角色权限。 + +您只能编辑用户创建的企业空间角色权限。预置企业空间角色的权限无法编辑。 + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的企业空间角色右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑权限**。 + +. 在**编辑权限**对话框，设置企业空间角色的权限，然后点击**确定**。 ++ +==== +include::../../../../_custom/workspaceManagement/workspaceRoles/workspaceRoles-para-permissions_v4.adoc[] +==== 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 new file mode 100644 index 000000000..321fb2ee0 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/06-delete-a-workspace-role.adoc @@ -0,0 +1,43 @@ +--- +title: "删除企业空间角色" +keywords: "Kubernetes, {ks_product}, 企业空间, 企业空间设置, 企业空间角色, 删除企业空间角色" +description: "介绍如何编辑企业空间角色的权限。" +weight: 06 +--- + +:ks_permission: **角色管理** +:ks_navigation: **企业空间设置 > 企业空间角色** + + +本节介绍如何删除企业空间角色。 + +您可以删除用户创建的企业空间角色。预置企业空间角色无法删除。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + +* 如果需要删除的企业空间角色已经分配给企业空间成员，您需要删除企业空间成员或修改其角色。 + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要删除的企业空间角色右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除角色**对话框点击**确定**。 diff --git a/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/_index.adoc b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/_index.adoc new file mode 100644 index 000000000..9e2d32daf --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/04-workspace-roles/_index.adoc @@ -0,0 +1,19 @@ +--- +title: "企业空间角色" +keywords: "Kubernetes, {ks_product}, 企业空间, 企业空间设置, 企业空间角色" +description: "介绍如何管理企业空间角色。" +weight: 04 +--- + + + +本节介绍如何管理企业空间角色。 + +企业空间角色包含特定的企业空间管理或查看权限。您可以将包含特定权限的角色授予企业空间成员，以控制企业空间成员在企业空间中的权限。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +include::../../../../_custom/workspaceManagement/workspaceMembers/workspaceMembers-desc-initialWorkspaceAdmin.adoc[] + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] 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 new file mode 100644 index 000000000..962ccd885 --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/06-workspace-settings/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "企业空间设置" +keywords: "{ks_product}, 网络隔离，部门管理，企业空间配额" +description: "介绍如何设置企业空间基本信息、修改企业空间配额以及管理部门。" +weight: 06 +--- + + + +本节介绍如何上设置企业空间基本信息、修改企业空间配额、设置企业空间角色和企业空间成员。 + + diff --git a/content/zh/docs/v4.1/08-workspace-management/_index.adoc b/content/zh/docs/v4.1/08-workspace-management/_index.adoc new file mode 100644 index 000000000..da2a516eb --- /dev/null +++ b/content/zh/docs/v4.1/08-workspace-management/_index.adoc @@ -0,0 +1,44 @@ +--- +title: "企业空间管理" +keywords: "Kubernetes, {ks_product}, 企业空间管理" +description: "介绍如何管理单个企业空间中的资源。" +weight: 08 +--- + + + +本节介绍如何管理企业空间中的资源。 + +在{ks_product_both}平台，企业空间用于对资源进行分组管理。集群管理员可以将一个或多个集群授权给企业空间，从而允许企业空间中的资源运行在集群上。每个企业空间可包含多个项目。用户可以被邀请加入企业空间，并根据企业空间角色获得企业空间资源的查看和管理权限。 + +{ks_product_right}安装完成后系统将自动创建 **system-workspace** 企业空间，其中包含系统项目，用于管理系统资源。 + +ifeval::["{file_output_type}" == "pdf"] +== 产品版本 + +本文档适用于{ks_product_left} v4.1.0 版本。 + +== 读者对象 + +本文档主要适用于以下读者： + +* {ks_product_right}用户 + +* 交付工程师 + +* 运维工程师 + +* 售后工程师 + + +== 修订记录 + +[%header,cols="1a,1a,3a"] +|=== +|文档版本 |发布日期 |修改说明 + +|01 +|{pdf_releaseDate} +|第一次正式发布。 +|=== +endif::[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/09-project-management/01-web-console/01-log-in-and-go-to-a-project.adoc b/content/zh/docs/v4.1/09-project-management/01-web-console/01-log-in-and-go-to-a-project.adoc new file mode 100644 index 000000000..3c41d2a03 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/01-web-console/01-log-in-and-go-to-a-project.adoc @@ -0,0 +1,35 @@ +--- +title: "登录并进入项目" +keywords: "Kubernetes, {ks_product}, 项目管理, Web 控制台, 登录并进入项目" +description: "介绍如何登录{ks_product_left} Web 控制台并进入项目。" +weight: 01 +--- + + + +本节介绍如何登录{ks_product_left} Web 控制台并进入项目。 + + +== 前提条件 + +* 您需要获取项目成员用户名和密码。 + +include::../../../_custom/workspaceManagement/webConsole/webConsole-prer-logIn.adoc[] + + +== 操作步骤 + +include::../../../_custom/workspaceManagement/webConsole/webConsole-oper-logIn.adoc[] ++ +-- +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +include::../../../_custom/workspaceManagement/webConsole/webConsole-note-firstLogin.adoc[] + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +. 点击**企业空间管理**。 +. 在**企业空间管理**页面点击一个企业空间的名称进入企业空间。 +. 在左侧导航栏选择**项目**，然后点击一个项目的名称进入项目。 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 new file mode 100644 index 000000000..0e25bc369 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/01-web-console/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Web 控制台" +keywords: "Kubernetes, {ks_product}, 项目管理, Web 控制台" +description: "介绍如何登录{ks_product_left} Web 控制台并进入项目，以及修改用户的邮箱、语言和密码。" +weight: 01 +--- + + + +本节介绍如何登录{ks_product_left} Web 控制台并进入项目。 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 new file mode 100644 index 000000000..c54d89e80 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/02-overview/01-view-project-overall-information.adoc @@ -0,0 +1,69 @@ +--- +title: "查看项目概览信息" +keywords: "Kubernetes, {ks_product}, 项目管理, 概览, 查看项目概览信息" +description: "介绍如何查看项目概览信息。" +weight: 01 +--- + +:ks_permission: **项目设置管理** +:ks_navigation: **概览** + + +本节介绍如何查看项目概览信息。 + + +== 前提条件 + + +:relfileprefix: ../../../ + +include::../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../_ks_components/oper-navigate.adoc[] ++ +-- +**概览**页面提供以下信息： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|基本信息 +|项目的名称、描述、集群、企业空间和创建者。 + +|项目成员和角色 +|项目成员和角色数量，以及最近登录的用户。 + +|已创建资源数量 +|显示当前项目的资源数量，如容器组、部署、有状态副本集、守护进程集、任务、定时任务、持久卷声明、服务、应用路由等的数量。 + +// |已安装应用 +// |项目中已安装的应用。 + +// |资源状态 +// |项目中已创建的应用资源和已使用的物理资源。在右上角的点击下拉列表可选择数据的时间范围。 + +// * **应用资源**：项目中已创建的容器组、部署、有状态副本集、守护进程集、任务、定时任务、持久卷声明、服务和应用路由的数量。 + +// * **物理资源**：项目的 CPU 和内存使用量。 + +// |资源用量 Top 5 +// |项目中特定资源用量最高的 5 个工作负载。点击下拉列表可选择按 CPU、内存、出站流量或入站流量排序。 + +|项目配额 +|项目中所有容器的资源预留总和的最大值，以及项目中所有容器的资源上限总和的最大值。如果项目管理员未设置项目配额则不显示。 + +|默认容器配额 +|项目中的单个容器预留资源的默认值，以及项目中的单个容器可使用资源上限的默认值。如项目未设置默认容器配额则不显示。 +|=== +-- diff --git a/content/zh/docs/v4.1/09-project-management/02-overview/_index.adoc b/content/zh/docs/v4.1/09-project-management/02-overview/_index.adoc new file mode 100644 index 000000000..338fe731c --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/02-overview/_index.adoc @@ -0,0 +1,8 @@ +--- +title: "概览" +keywords: "Kubernetes, {ks_product}, 项目管理, 概览" +description: "介绍如何查看项目概览信息。" +weight: 02 +--- + + 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 new file mode 100644 index 000000000..158e82547 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/01-install-an-app-from-the-app-store.adoc @@ -0,0 +1,68 @@ +--- +title: "从应用商店安装应用" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用, 查看项目概览信息" +description: "介绍如何查看项目概览信息。" +weight: 01 +--- + + +:ks_permission: **应用实例创建** +:ks_navigation: **应用负载 > 应用** + + +本节介绍如何从{ks_product_both}平台的应用商店安装应用。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**创建应用**对话框点击**从应用商店**。 + +. 在应用商店中，点击需要使用的应用模板，然后在右上角点击**部署**。 ++ +-- +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +如果弹出**部署须知**对话框，请仔细阅读相关内容，然后点击**同意**。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +. 在弹出的**位置**对话框，选择应用的安装位置，然后点击**确定**。 + ++ + +include::../../../../_custom/projectManagement/apps/apps-oper-installApp.adoc[] + ++ +-- +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +应用商店中的应用由具有相关权限的企业空间成员发布或由第三方提供。有关应用功能参数的更多信息，请联系相关企业空间成员或应用的提供方。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + +应用创建完成后将显示在应用列表中。 +-- diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..f56ef0cb2 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/02-install-an-app-using-an-app-template.adoc @@ -0,0 +1,76 @@ +--- +title: "从应用模板安装应用" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用, 从应用模板安装应用" +description: "介绍如何从应用模板安装应用。" +weight: 02 +--- + + +:ks_permission: **应用实例创建** +:ks_navigation: **应用负载 > 应用** + + +本节介绍如何从企业空间或第三方应用仓库中的应用模板安装应用。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +若要使用企业空间的应用模板，需要安装并启用“应用商店”扩展组件。安装后，企业空间的**应用管理**菜单下将显示**应用模板**选项。然后由具有相关权限的企业空间成员创建企业空间的应用模板。 + +|=== + +== 前提条件 + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**创建应用**对话框点击**从应用模板**。 + +. 在**应用模板**页面，点击**当前企业空间**下拉列表，选择**当前企业空间**或一个应用仓库。 + +. 点击需要使用的应用模板，然后点击**安装**。 ++ +-- +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +应用模板和应用仓库由具有相关权限的企业空间成员创建。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + ++ + +include::../../../../_custom/projectManagement/apps/apps-oper-installApp.adoc[] ++ +-- +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +应用模板和应用仓库由具有相关权限的企业空间成员创建。有关应用功能参数的更多信息，请联系相关企业空间成员或应用的提供方。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + +应用创建完成后将显示在应用列表中。 +-- diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..2d3211737 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/04-view-an-app-list.adoc @@ -0,0 +1,73 @@ +--- +title: "查看应用列表" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用, 查看应用列表" +description: "介绍如何查看应用列表。" +weight: 04 +--- + + +:ks_permission: **应用实例查看** +:ks_navigation: **应用负载 > 应用** + + +本节介绍如何查看应用列表。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**应用**页面，点击**基于模板的应用**打开应用列表。 ++ +==== +* 应用列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|应用的名称。 + +include::../../../../_custom/projectManagement/apps/apps-para-status_v4.adoc[] + +|应用类型 +|应用模板的类型，如 **helm 应用**或 **yaml 应用**。 + +|应用模板 +|创建应用所使用的应用模板。仅对基于模板的应用显示。 + +|版本 +|应用的版本号。 + +* 对于基于模板的应用，显示 Helm Chart 的版本。 + +// * 对于自制应用，显示用户自定义的版本号。 + +|更新时间 +|应用的更新时间。 +|=== +-- + +* 在列表上方点击搜索框并输入关键字，可按名称搜索应用。 + +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/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 new file mode 100644 index 000000000..a98890602 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/05-view-template-based-app-details.adoc @@ -0,0 +1,83 @@ +--- +title: "查看基于模板的应用详情" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用, 查看基于模板的应用详情" +description: "介绍如何查看基于模板的应用详情。" +weight: 05 +--- + + +:ks_permission: **应用实例查看** +:ks_navigation: **应用负载 > 应用** + + +本节介绍如何查看基于模板的应用详情。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**应用**页面，点击一个应用的名称打开其详情页面。 + +. 在应用详情页面左侧的**属性**区域查看应用的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群 +|应用所属的集群。 + +|项目 +|应用所属的项目。 + +include::../../../../_custom/projectManagement/apps/apps-para-status_v4.adoc[] + +|应用 +|应用所使用的应用模板。 + +include::../../../../_custom/projectManagement/apps/apps-para-details2.adoc[] +|=== +-- + ++ + +include::../../../../_custom/projectManagement/apps/apps-oper-viewResourceStatus_v4.adoc[] + ++ + +. 在应用详情页面右侧点击**应用模板**查看应用模板的信息。 ++ +-- +* 点击**应用描述**可查看应用的介绍信息。 + +* 点击 **Chart 文件**可查看 Helm Chart 压缩包中的文件。在 **Chart 文件**右侧点击下拉列表可选择需要查看的文件。点击image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download,18,18]可将文件下载到本地。 +-- + +. 在应用详情页面右侧点击**应用设置**查看应用的设置信息。 ++ +-- +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +应用的默认设置保存在 Helm Chart 压缩包中的 **values.yaml** 文件中。**应用设置**页面显示的是用户在安装应用时自定义的设置。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..6690755c6 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/06-edit-app-information.adoc @@ -0,0 +1,39 @@ +--- +title: "编辑应用信息" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用, 编辑应用信息" +description: "介绍如何编辑应用信息。" +weight: 06 +--- + +:ks_permission: **应用实例管理** +:ks_navigation: **应用负载 > 应用** + + + +本节介绍如何编辑应用信息。 + +您可以编辑应用的别名和描述。{ks_product_right}不支持编辑已创建应用的名称。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/projectManagement/apps/apps-oper-editAppInformation.adoc[] \ No newline at end of file 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 new file mode 100644 index 000000000..729442c95 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/08-edit-app-settings.adoc @@ -0,0 +1,42 @@ +--- +title: "编辑应用设置" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用, 编辑应用设置" +description: "介绍如何编辑应用设置。" +weight: 08 +--- + +:ks_permission: **应用实例管理** +:ks_navigation: **应用负载 > 应用** + + +本节介绍如何编辑已创建应用的设置。 + +在创建应用时，您也可以编辑应用设置。有关更多信息，请参阅link:../01-install-an-app-from-the-app-store[从应用商店安装后应用]和link:../02-install-an-app-using-an-app-template[从应用模板安装应用]。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**应用**页面，点击一个应用的名称打开其详情页面。 + +. 在应用详情页面左上角选择**更多操作 > 编辑设置**。 + +. 在**编辑应用设置**对话框，在右侧选择目标应用版本、编辑应用设置，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..4d76b10b7 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/10-delete-apps.adoc @@ -0,0 +1,63 @@ +--- +title: "删除应用" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用, 删除应用" +description: "介绍如何删除应用。" +weight: 10 +--- + +:ks_permission: **应用实例删除** +:ks_navigation: **应用负载 > 应用** + + +本节介绍如何删除应用。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 删除单个应用 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +// include::../../../../_custom/projectManagement/apps/apps-oper-openListPage.adoc[] + ++ + +. 在需要删除的应用右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除应用**对话框，输入应用的名称，然后点击**确定**。 + + +== 批量删除应用 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +// include::../../../../_custom/projectManagement/apps/apps-oper-openListPage.adoc[] + ++ + +. 选择需要删除的应用左侧的复选框，然后在应用列表上方点击**删除**。 + +. 在**批量删除应用**对话框，输入应用的名称，然后点击**确定**。 ++ +-- +include::../../../../_custom/note-separateNamesByComma.adoc[] +-- diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/_index.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/_index.adoc new file mode 100644 index 000000000..863cfb5db --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/01-apps/_index.adoc @@ -0,0 +1,14 @@ +--- +title: "应用" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用" +description: "介绍如何管理项目中安装的应用。" +weight: 01 +--- + + + +本节介绍如何管理应用。 + +在{ks_product_both}平台，应用特指由一个或多个工作负载、服务、应用路由等资源组成的业务程序。 + +{ks_product_right}平台目前支持创建基于模板的应用，即通过已有的应用模板创建应用。创建应用所使用的应用模板可以是已发布到应用商店的应用模板、上传到企业空间的应用模板、或第三方应用仓库中的应用模板。 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 new file mode 100644 index 000000000..bf99a722e --- /dev/null +++ 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 @@ -0,0 +1,296 @@ +--- +title: "创建有状态或无状态服务" +keywords: "Kubernetes, {ks_product}, 项目管理, 工作负载, 服务, 创建服务, 创建有状态或无状态服务" +description: "介绍如何创建有状态或无状态服务。" +weight: 01 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 服务** + + +本节介绍如何创建有状态或无状态服务。 + + +== 前提条件 + + +:relfileprefix: ../../../../../ + +include::../../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +请参阅link:#_参数描述[参数描述]设置服务的参数。 + +include::../../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**创建服务**对话框，根据需要选择**有状态服务**或**无状态服务**。 ++ +-- +// Note +include::../../../../../../_ks_components/admonitions/note.adoc[] + +include::../../../../../_custom/clusterManagement/services/services-para-statelessStatefulExternal.adoc[] + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + ++ + +include::../../../../../_custom/projectManagement/services/services-oper-setBasicInformation.adoc[] + ++ + +. 在**容器组设置**页签，为服务后端工作负载管理的容器组设置副本数量、容器、更新策略、安全上下文、调度规则和元数据，然后点击**下一步**。 + ++ + +include::../../../../../_custom/projectManagement/services/services-oper-setStorageAdvanced.adoc[] + + +== 参数描述 + +以下介绍如何设置有状态服务和无状态服务的参数。 + +* 基本信息 ++ +-- +include::../../../../../_custom/projectManagement/services/services-para-setServiceInformation.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../../_custom/clusterManagement/services/services-para-serviceName.adoc[] + +include::../../../../../_custom/clusterManagement/services/services-para-serviceAlias.adoc[] + +include::../../../../../_custom/projectManagement/services/services-para-serviceVersion.adoc[] + +include::../../../../../_custom/clusterManagement/services/services-para-serviceDescription.adoc[] +|=== +-- + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podReplicas.adoc[] + +* 容器组设置 > 添加容器 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] +-- + +* 容器组设置 > 添加容器 > 容器设置 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] + +include::../../../../../_custom/clusterManagement/projects/projects-para-containerQuotas.adoc[] +|=== +-- + +* 容器组设置 > 添加容器 > 端口设置 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] +-- + +* 容器组设置 > 添加容器 > 镜像拉取策略 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] +-- + +* 容器组设置 > 添加容器 > 健康检查 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] +-- + +* 容器组设置 > 添加容器 > 健康检查 > 添加探针 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc[] +-- + +* 容器组设置 > 添加容器 > 生命周期管理 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] +-- + +* 容器组设置 > 添加容器 > 生命周期管理 > 添加动作 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] +-- + +* 容器组设置 > 添加容器 > 启动命令 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] +-- + +* 容器组设置 > 添加容器 > 环境变量 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] +-- + +* 容器组设置 > 添加容器 > 容器组安全上下文 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] +-- + +* 容器组设置 > 添加容器 > 同步主机时区 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] +-- + +* 容器组设置 > 更新策略 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc[] +-- + +* 容器组设置 > 更新策略 > 滚动更新设置 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc[] +-- + +* 容器组设置 > 容器组安全上下文 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSecurityContext.adoc[] +-- + +* 容器组设置 > 容器组调度规则 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc[] +-- + +* 容器组设置 > 容器组调度规则 > 自定义规则 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc[] + +-- +* 容器组设置 > 容器组优雅终止 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc[] +-- + +* 容器组设置 > 添加元数据 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodMetadata.adoc[] +-- + +* 存储设置 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc[] + +// include::../../../../../_custom/projectManagement/workloads/workloads-desc-enableLogCollectionProject.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] +|=== + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume.adoc[] +-- + +* 存储设置 > 添加持久卷声明模板 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc[] +-- + +* 存储设置 > 挂载卷 > 持久卷 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] +-- + +* 存储设置 > 挂载卷 > 临时卷 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume_new.adoc[] +-- + +* 存储设置 > 挂载卷 > HostPath 卷 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] +-- + +* 存储设置 > 挂载配置字典或保密字典 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] +-- + +* 高级设置 ++ +-- +// include::../../../../../_custom/projectManagement/services/services-desc-setLabelsAnnotations.adoc[] + +为服务后端工作负载管理的容器组指定节点，设置服务的外部访问模式、会话保持设置和元数据。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podIpPool.adoc[] + +include::../../../../../_custom/clusterManagement/services/services-para-externalAccess.adoc[] + +include::../../../../../_custom/clusterManagement/services/services-para-sessionPersistence.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc[] + +|添加元数据 +| +include::../../../../../_custom/projectManagement/services/services-desc-setServiceLabelWorkloadAnnotation.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc[] +|=== +-- 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 new file mode 100644 index 000000000..16cc53eaf --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/02-create-an-external-service.adoc @@ -0,0 +1,58 @@ +--- +title: "创建外部服务" +keywords: "Kubernetes, {ks_product}, 项目管理, 工作负载, 服务, 创建服务, 创建外部服务" +description: "介绍如何创建外部服务。" +weight: 02 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 服务** + + +本节介绍如何创建外部服务。 + +外部服务将业务流量转发给集群外部的其他服务，在集群内部可以通过 .**.svc.cluster.local** 格式的域名访问。 + + +== 前提条件 + + +:relfileprefix: ../../../../../ + +include::../../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**创建服务**对话框，选择**外部服务**。 + +. 在**基本信息**页签，设置服务的基本信息，然后点击**下一步**。 + +. 在**外部服务**页签，设置目标服务的地址，然后点击**创建**。 ++ +-- +// Note +include::../../../../../../_ks_components/admonitions/note.adoc[] + +* 目标服务的地址必须为域名，如果您输入 IP 地址，该地址将被视为由数字组成的域名而不是真正的 IP 地址。 + +* 为使业务流量可以被正常转发到目标服务，请确保目标服务的域名可以通过域名服务器解析为实际的 IP 地址。 + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + 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 new file mode 100644 index 000000000..84ed56fbf --- /dev/null +++ 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 @@ -0,0 +1,62 @@ +--- +title: "通过现有工作负载创建服务" +keywords: "Kubernetes, {ks_product}, 项目管理, 工作负载, 服务, 创建服务, 通过现有工作负载创建服务" +description: "介绍如何创建服务并使用现有工作负载作为后端的工作负载。" +weight: 05 +--- + +// :ks_include_id: d0a59bd6df0241ea81fc1cb510b9156e +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 服务** + + +本节介绍如何创建服务并使用现有工作负载作为后端的工作负载。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +* 您需要提前在项目创建工作负载。有关更多信息，请参阅link:../../../03-workloads/01-create-a-workload/[创建工作负载]。 + +== 操作步骤 + +include::../../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**创建服务**对话框，选择**指定工作负载**。 + ++ + +include::../../../../../_custom/projectManagement/services/services-oper-setBasicInformation.adoc[] ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../../_custom/clusterManagement/services/services-para-serviceName.adoc[] + +include::../../../../../_custom/clusterManagement/services/services-para-serviceAlias.adoc[] + +include::../../../../../_custom/clusterManagement/services/services-para-serviceDescription.adoc[] +|=== +-- + ++ + +include::../../../../../_custom/clusterManagement/services/services-oper-createAService.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/_index.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/_index.adoc new file mode 100644 index 000000000..c8c4714bd --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/01-create-a-service/_index.adoc @@ -0,0 +1,24 @@ +--- +title: "创建服务" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 服务, 创建服务" +description: "介绍如何创建服务。" +weight: 01 +--- + + + +include::../../../../../_custom/clusterManagement/services/services-desc-createAService.adoc[] + +{ks_product_right}支持通过以下方式创建服务及服务后端的工作负载： + +* 创建有状态服务：创建内部访问模式为 Headless 的服务，同时创建有状态副本集作为服务后端的工作负载。 + +* 创建无状态服务：创建内部访问模式为 VirtualIP 的服务，同时创建部署作为服务后端的工作负载。 + +* 创建外部服务：服务将业务流量转发给集群外部的其他服务。 + +// * 通过源代码创建服务：创建内部访问模式为 Headless 或 VirtualIP 的服务，并使用 Java、Node.js 或 Python 源代码创建服务后端的工作负载。 + +// * 通过制品创建服务：创建内部访问模式为 Headless 或 VirtualIP 的服务，并使用 JAR、WAR 或二进制制品文件创建服务后端的工作负载。 + +* 指定工作负载：创建内部访问模式为 Headless 或 VirtualIP 的服务，并使用项目中现有的工作负载作为服务后端的工作负载。 diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/02-view-a-service-list.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/02-view-a-service-list.adoc new file mode 100644 index 000000000..69b4f3783 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/02-view-a-service-list.adoc @@ -0,0 +1,64 @@ +--- +title: "查看服务列表" +keywords: "Kubernetes, {ks_product}, 项目管理, 工作负载, 服务, 查看服务列表" +description: "介绍如何查看服务列表。" +weight: 02 +--- + +:ks_permission: **应用负载查看** +:ks_navigation: **应用负载 > 服务** + + +include::../../../../_custom/clusterManagement/services/services-desc-viewServiceList.adoc[] + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +==== +* 服务列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../_custom/clusterManagement/services/services-para-name.adoc[] + +|服务类型 +|服务的类型。取决于服务的创建方式，{ks_product_right}将服务划分为以下类型： + +include::../../../../_custom/clusterManagement/services/services-para-statelessStatefulExternal.adoc[] + +* **外部服务**：服务将业务流量转发给集群外部的其他服务。系统不为服务分配虚拟 IP 地址，可通过 .**.svc.cluster.local** 格式的域名从集群内部访问。 + +* **自定义服务**：用户通过自定义服务的内部访问模式和后端工作负载创建的服务。 + +|应用 +|服务所属的应用。 + +|内部访问 +| +include::../../../../_custom/clusterManagement/services/services-para-internalAccess.adoc[] + +include::../../../../_custom/clusterManagement/services/services-para-virtualip-headless.adoc[] + +include::../../../../_custom/clusterManagement/services/services-para-externalName.adoc[] + +include::../../../../_custom/clusterManagement/services/services-para-externalAccess.adoc[] + +include::../../../../_custom/clusterManagement/services/services-para-creationTime.adoc[] +|=== +-- + +include::../../../../_custom/clusterManagement/services/services-oper-searchForServices.adoc[] + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..e610724f2 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/04-view-service-details.adoc @@ -0,0 +1,40 @@ +--- +title: "查看服务详情" +keywords: "Kubernetes, {ks_product}, 项目管理, 工作负载, 服务, 查看服务详情" +description: "介绍如何查看服务详情。" +weight: 04 +--- + +:ks_permission: **应用负载查看** +:ks_navigation: **应用负载 > 服务** + + +include::../../../../_custom/clusterManagement/services/services-desc-viewServiceDetails.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/services/services-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/services/services-oper-viewServiceDetails.adoc[] 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 new file mode 100644 index 000000000..c25bf2fdc --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/05-edit-service-information.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑服务信息" +keywords: "Kubernetes, {ks_product}, 项目管理, 工作负载, 服务, 编辑服务信息" +description: "介绍如何编辑服务信息。" +weight: 05 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 服务** + + +include::../../../../_custom/clusterManagement/services/services-desc-editServiceInformation.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/services/services-oper-editServiceInformation.adoc[] 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 new file mode 100644 index 000000000..b2df873e4 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/06-edit-service-settings.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑服务设置" +keywords: "Kubernetes, {ks_product}, 项目管理, 工作负载, 服务, 编辑服务设置" +description: "介绍如何编辑服务设置。" +weight: 06 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 服务** + + +include::../../../../_custom/clusterManagement/services/services-desc-editServiceSettings.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/services/services-oper-editServiceSettings.adoc[] 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 new file mode 100644 index 000000000..f0bb9a60e --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/07-edit-service-external-access-settings.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑服务外部访问设置" +keywords: "Kubernetes, {ks_product}, 项目管理, 工作负载, 服务, 编辑服务外部访问设置" +description: "介绍如何编辑服务外部访问设置。" +weight: 07 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 服务** + + +include::../../../../_custom/clusterManagement/services/services-desc-editServiceExternalAccessSettings.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/services/services-oper-editServiceExternalAccessSettings.adoc[] 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 new file mode 100644 index 000000000..1e389c8af --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/09-delete-services.adoc @@ -0,0 +1,53 @@ +--- +title: "删除服务" +keywords: "Kubernetes, {ks_product}, 项目管理, 工作负载, 服务, 删除服务" +description: "介绍如何编辑服务外部访问设置。" +weight: 09 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 服务** + + +include::../../../../_custom/clusterManagement/services/services-desc-deleteServices.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/services/services-oper-deleteASingleService.adoc[] + ++ + +. 在**删除服务**对话框，选择需要同时删除的工作负载，然后点击**确定**。 + + +== 批量删除服务 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/services/services-oper-deleteMultipleServices.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/_index.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/_index.adoc new file mode 100644 index 000000000..181313951 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/02-services/_index.adoc @@ -0,0 +1,9 @@ +--- +title: "服务" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 服务" +description: "介绍如何管理服务。" +weight: 02 +--- + + +include::../../../../_custom/clusterManagement/services/services-desc-services.adoc[] 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 new file mode 100644 index 000000000..8e95263d9 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/01-create-a-workload.adoc @@ -0,0 +1,256 @@ +--- +title: "创建工作负载" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 工作负载, 创建工作负载" +description: "介绍如何创建工作负载。" +weight: 01 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-createAWorkload.adoc[] + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +请参阅link:#_参数描述[参数描述]设置工作负载的参数。 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-createAWorkload.adoc[] + + +== 参数描述 + +以下介绍如何设置工作负载的参数。 + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-basicInformation.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podReplicas.adoc[] + +* 容器组设置 > 添加容器 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] +-- + +* 容器组设置 > 添加容器 > 容器设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] + +include::../../../../_custom/clusterManagement/projects/projects-para-containerQuotas.adoc[] +|=== +-- + +* 容器组设置 > 添加容器 > 端口设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] +-- + +* 容器组设置 > 添加容器 > 镜像拉取策略 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] +-- + +* 容器组设置 > 添加容器 > 健康检查 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] +-- + +* 容器组设置 > 添加容器 > 健康检查 > 添加探针 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc[] +-- + +* 容器组设置 > 添加容器 > 生命周期管理 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] +-- + +* 容器组设置 > 添加容器 > 生命周期管理 > 添加动作 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] +-- + +* 容器组设置 > 添加容器 > 启动命令 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] +-- + +* 容器组设置 > 添加容器 > 环境变量 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] +-- + +* 容器组设置 > 添加容器 > 容器组安全上下文 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] +-- + +* 容器组设置 > 添加容器 > 同步主机时区 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] +-- + +* 容器组设置 > 更新策略 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc[] +-- + +* 容器组设置 > 更新策略 > 滚动更新设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc[] +-- + +* 容器组设置 > 容器组安全上下文 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSecurityContext.adoc[] +-- + +* 容器组设置 > 容器组调度规则 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc[] +-- + +* 容器组设置 > 容器组调度规则 > 自定义规则 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc[] +-- + +* 容器组设置 > 容器组优雅终止 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc[] +-- + +* 容器组设置 > 添加元数据 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodMetadata.adoc[] +-- + +* 存储设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc[] + +// include::../../../../_custom/projectManagement/workloads/workloads-desc-enableLogCollectionProject.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] +|=== + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume.adoc[] +-- + +* 存储设置 > 添加持久卷声明模板 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc[] +-- + +* 存储设置 > 挂载卷 > 持久卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] +-- + +* 存储设置 > 挂载卷 > 临时卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume_new.adoc[] +-- + +* 存储设置 > 挂载卷 > HostPath 卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] +-- + +* 存储设置 > 挂载配置字典或保密字典 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] +-- + +* 高级设置 ++ +-- +为工作负载管理的容器组指定节点，并设置工作负载的元数据。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podIpPool.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc[] + +|添加元数据 +| +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setWorkloadMetadata.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc[] +|=== +-- 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 new file mode 100644 index 000000000..4cc861587 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/02-view-a-workload-list.adoc @@ -0,0 +1,46 @@ +--- +title: "查看工作负载列表" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 工作负载, 查看工作负载列表" +description: "介绍如何查看工作负载列表。" +weight: 02 +--- + +:ks_permission: **应用负载查看** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-viewAWorkloadList.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/workloads/workloads-oper-openListPage.adoc[] ++ +==== +include::../../../../_custom/clusterManagement/workloads/workloads-para-workloadList_new.adoc[] + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-searchForWorkloads.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/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 new file mode 100644 index 000000000..5f0037145 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/03-view-workload-details.adoc @@ -0,0 +1,40 @@ +--- +title: "查看工作负载详情" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 工作负载, 查看工作负载详情" +description: "介绍如何查看工作负载详情。" +weight: 03 +--- + +:ks_permission: **应用负载查看** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-viewWorkloadDetails.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/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-viewWorkloadDetails_new.adoc[] 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 new file mode 100644 index 000000000..bea1fa9e6 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/04-edit-workload-information.adoc @@ -0,0 +1,40 @@ +--- +title: "编辑工作负载信息" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 工作负载, 编辑工作负载信息" +description: "介绍如何编辑工作负载信息。" +weight: 04 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-editWorkloadInformation.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/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-editWorkloadInformation.adoc[] 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 new file mode 100644 index 000000000..8d34fc5bf --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/05-re-create-a-workload.adoc @@ -0,0 +1,40 @@ +--- +title: "重新创建工作负载" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 工作负载, 重新创建工作负载" +description: "介绍如何重新创建工作负载。" +weight: 05 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-recreateAWorkload.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/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-recreateAWorkload.adoc[] 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 new file mode 100644 index 000000000..26dcd7fcb --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/06-adjust-the-number-of-pod-replicas.adoc @@ -0,0 +1,40 @@ +--- +title: "调整容器组副本数量" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 工作负载, 调整容器组副本数量" +description: "介绍如何调整容器组副本数量。" +weight: 06 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-adjustTheNumberOfPodReplicas.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/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-adjustTheNumberOfPodReplicas.adoc[] 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 new file mode 100644 index 000000000..fd7329b22 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/07-stop-workloads.adoc @@ -0,0 +1,40 @@ +--- +title: "停止工作负载" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 工作负载, 停止工作负载" +description: "介绍如何停止工作负载。" +weight: 07 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-stopWorkloads.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/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-stopWorkloads.adoc[] 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 new file mode 100644 index 000000000..8aad925f3 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/08-roll-back-workload-settings.adoc @@ -0,0 +1,42 @@ +--- +title: "回退工作负载设置" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 工作负载, 回退工作负载设置" +description: "介绍如何回退工作负载设置。" +weight: 08 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-rollBackWorkloadSettings.adoc[] + + +== 前提条件 + + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +include::../../../../_custom/clusterManagement/workloads/workloads-prer-workloadEdited.adoc[] + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-rollBackWorkloadSettings.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 new file mode 100644 index 000000000..bdaed87b8 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/10-edit-workload-settings.adoc @@ -0,0 +1,204 @@ +--- +title: "编辑工作负载设置" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 工作负载, 编辑工作负载设置" +description: "介绍如何编辑工作负载设置。" +weight: 10 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-editWorkloadSettings.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/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-editWorkloadSettings.adoc[] + ++ + +. 在**编辑设置**对话框，分别设置工作负载的更新策略、容器、存储、容器组优雅终止和容器组调度规则（仅对部署和有状态副本集可用），然后点击**确定**。有关具体的参数设置方法，请参阅link:#_参数描述[参数描述]。 + +== 参数描述 + +* 更新策略 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc[] +-- + +* 更新策略 > 滚动更新设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc[] +-- + +* 容器 > 添加容器 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] +-- + +* 容器 > 容器设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] + +include::../../../../_custom/clusterManagement/projects/projects-para-containerQuotas.adoc[] +|=== +-- + +* 容器 > 容器设置 > 端口设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] +-- + +* 容器 > 容器设置 > 镜像拉取策略 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] +-- + +* 容器 > 容器设置 > 健康检查 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] +-- + +* 容器 > 容器设置 > 启动命令 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] +-- + +* 容器 > 容器设置 > 环境变量 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] +-- + +* 容器 > 容器设置 > 容器安全上下文 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] +-- + +* 容器 > 容器设置 > 同步主机时区 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] +-- + +* 存储 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc[] + +// include::../../../../_custom/projectManagement/workloads/workloads-desc-enableLogCollectionProject.adoc[] + + + +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] +|=== + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume_new.adoc[] +-- + +// * 存储 > 添加持久卷声明模板 +// + +// -- +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc[] +// -- + +* 存储 > 挂载卷 > 持久卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] +-- + +* 存储 > 挂载卷 > 临时卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume_new.adoc[] +-- + +* 存储 > 挂载卷 > HostPath 卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] +-- + +* 存储 > 挂载配置字典或保密字典 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] +-- + +* 容器组调度规则 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc[] +-- + +* 容器组调度规则 > 自定义规则 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc[] +-- + +* 容器组优雅终止 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc[] +-- + +// * 容器组 IP 池 +// + +// -- +// 选择后将为容器组分配 IP 地址。 +// -- \ No newline at end of file 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 new file mode 100644 index 000000000..a48240cf2 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/11-delete-workloads.adoc @@ -0,0 +1,62 @@ +--- +title: "删除工作负载" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 工作负载, 删除工作负载" +description: "介绍如何删除工作负载。" +weight: 11 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-deleteWorkloads.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/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-deleteASingleWorkload.adoc[] + ++ + +. 在**删除工作负载**对话框，选择需要同时删除的相关资源，然后点击**确定**。 + + + +== 批量删除工作负载 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-openListPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/workloads/workloads-oper-deleteMultipleWorkloads.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/_index.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/_index.adoc new file mode 100644 index 000000000..4afa6f200 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/03-workloads/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "工作负载" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 工作负载" +description: "介绍如何管理工作负载。" +weight: 03 +--- + + + +include::../../../../_custom/clusterManagement/workloads/workloads-desc-workloads.adoc[] 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 new file mode 100644 index 000000000..81d2322be --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/01-create-a-job.adoc @@ -0,0 +1,206 @@ +--- +title: "创建任务" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 任务, 创建任务" +description: "介绍如何创建任务。" +weight: 01 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 任务** + + +include::../../../../_custom/clusterManagement/jobs/jobs-desc-createAJob.adoc[] + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +请参阅link:#_参数描述[参数描述]设置任务的参数。 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/jobs/jobs-oper-openListPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/jobs/jobs-oper-createAJob.adoc[] + + +== 参数描述 + +include::../../../../_custom/clusterManagement/jobs/jobs-para-basicInformation.adoc[] + +include::../../../../_custom/clusterManagement/jobs/jobs-para-strategySettings.adoc[] + +include::../../../../_custom/clusterManagement/jobs/jobs-para-restartPolicy.adoc[] + +* 容器组设置 > 添加容器 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] +-- + +* 容器组设置 > 添加容器 > 容器设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] + +include::../../../../_custom/clusterManagement/projects/projects-para-containerQuotas.adoc[] +|=== +-- + +* 容器组设置 > 添加容器 > 端口设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] +-- + +* 容器组设置 > 添加容器 > 镜像拉取策略 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] +-- + +* 容器组设置 > 添加容器 > 健康检查 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] +-- + +* 容器组设置 > 添加容器 > 健康检查 > 添加探针 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc[] +-- + +* 容器组设置 > 添加容器 > 生命周期管理 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] +-- + +* 容器组设置 > 添加容器 > 生命周期管理 > 添加动作 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] +-- + +* 容器组设置 > 添加容器 > 启动命令 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] +-- + +* 容器组设置 > 添加容器 > 环境变量 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] +-- + +* 容器组设置 > 添加容器 > 容器组安全上下文 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] +-- + +* 容器组设置 > 添加容器 > 同步主机时区 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] +-- + +* 存储设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc[] + +// include::../../../../_custom/projectManagement/workloads/workloads-desc-enableLogCollectionProject.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] +|=== + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume_new.adoc[] +-- + +* 存储设置 > 挂载卷 > 持久卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] +-- + +* 存储设置 > 挂载卷 > 临时卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume_new.adoc[] +-- + +* 存储设置 > 挂载卷 > HostPath 卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] +-- + +* 存储设置 > 挂载配置字典或保密字典 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] +-- + +* 高级设置 ++ +-- +为任务管理的容器组指定节点，并设置任务的元数据。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podIpPool.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc[] + +|添加元数据 +| +include::../../../../_custom/clusterManagement/jobs/jobs-desc-setJobMetadata.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc[] +|=== +-- 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 new file mode 100644 index 000000000..6e4fbad53 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/02-view-a-job-list.adoc @@ -0,0 +1,46 @@ +--- +title: "查看任务列表" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 任务, 查看任务列表" +description: "介绍如何查看任务列表。" +weight: 02 +--- + +:ks_permission: **应用负载查看** +:ks_navigation: **应用负载 > 任务** + + +include::../../../../_custom/clusterManagement/jobs/jobs-desc-viewAJobList.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/jobs/jobs-oper-openListPage.adoc[] ++ +==== +include::../../../../_custom/clusterManagement/jobs/jobs-para-jobList.adoc[] + +include::../../../../_custom/clusterManagement/jobs/jobs-oper-searchForJobs.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/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 new file mode 100644 index 000000000..08e32d122 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/03-view-job-details.adoc @@ -0,0 +1,40 @@ +--- +title: "查看任务详情" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 任务, 查看任务详情" +description: "介绍如何查看任务详情。" +weight: 03 +--- + +:ks_permission: **应用负载查看** +:ks_navigation: **应用负载 > 任务** + + +include::../../../../_custom/clusterManagement/jobs/jobs-desc-viewJobDetails.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/jobs/jobs-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/jobs/jobs-oper-viewJobDetails_new.adoc[] 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 new file mode 100644 index 000000000..45037b157 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/04-edit-job-information.adoc @@ -0,0 +1,40 @@ +--- +title: "编辑任务信息" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 任务, 编辑任务信息" +description: "介绍如何编辑任务信息。" +weight: 04 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 任务** + + +include::../../../../_custom/clusterManagement/jobs/jobs-desc-editJobInformation.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/jobs/jobs-oper-openListPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/jobs/jobs-oper-editJobInformation.adoc[] 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 new file mode 100644 index 000000000..621dbd600 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/05-rerun-a-job.adoc @@ -0,0 +1,40 @@ +--- +title: "重新运行任务" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 任务, 重新运行任务" +description: "介绍如何重新运行任务。" +weight: 05 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 任务** + + +include::../../../../_custom/clusterManagement/jobs/jobs-desc-rerunAJob.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/jobs/jobs-oper-rerunAJob.adoc[] 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 new file mode 100644 index 000000000..c72e86408 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/06-pause-a-cronjob.adoc @@ -0,0 +1,40 @@ +--- +title: "暂停定时任务" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 任务, 暂停定时任务" +description: "介绍如何暂停定时任务。" +weight: 06 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 任务** + + +include::../../../../_custom/clusterManagement/jobs/jobs-desc-pauseACronjob.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/jobs/jobs-oper-pauseACronjob.adoc[] 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 new file mode 100644 index 000000000..160d4b547 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/07-delete-jobs.adoc @@ -0,0 +1,57 @@ +--- +title: "删除任务" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 任务, 删除任务" +description: "介绍如何删除任务。" +weight: 07 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 任务** + + +include::../../../../_custom/clusterManagement/jobs/jobs-desc-deleteJobs.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/jobs/jobs-oper-openListPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/jobs/jobs-oper-deleteASingleJob.adoc[] + + +== 批量删除任务 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/jobs/jobs-oper-openListPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/jobs/jobs-oper-deleteMultipleJobs.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/_index.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/_index.adoc new file mode 100644 index 000000000..cc0c233f4 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/04-jobs/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "任务" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 任务" +description: "介绍如何管理任务。" +weight: 04 +--- + + + +include::../../../../_custom/clusterManagement/jobs/jobs-desc-jobs.adoc[] 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 new file mode 100644 index 000000000..6eae39bfd --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/01-create-a-route.adoc @@ -0,0 +1,42 @@ +--- +title: "创建应用路由" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用路由, 创建应用路由" +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 new file mode 100644 index 000000000..cfddbf4a8 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/02-view-a-route-list.adoc @@ -0,0 +1,42 @@ +--- +title: "查看应用路由列表" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用路由, 查看应用路由列表" +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 new file mode 100644 index 000000000..0d3ca8668 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/03-view-route-details.adoc @@ -0,0 +1,40 @@ +--- +title: "查看应用路由详情" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用路由, 查看应用路由详情" +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 new file mode 100644 index 000000000..0550c80db --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/04-access-a-backend-service-of-a-route.adoc @@ -0,0 +1,42 @@ +--- +title: "访问应用路由的后端服务" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用路由, 访问应用路由的后端服务" +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 new file mode 100644 index 000000000..7ec57a17f --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/05-edit-route-information.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑应用路由信息" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用路由, 编辑应用路由信息" +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 new file mode 100644 index 000000000..281159aa4 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/06-edit-routing-rules.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑路由规则" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用路由, 编辑路由规则" +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 new file mode 100644 index 000000000..431b9feef --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/07-edit-route-annotations.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑应用路由注解" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用路由, 编辑应用路由注解" +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 new file mode 100644 index 000000000..5ac185ef2 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/08-delete-routes.adoc @@ -0,0 +1,49 @@ +--- +title: "删除应用路由" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用路由, 删除应用路由" +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 new file mode 100644 index 000000000..825a9b7d9 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/05-routes/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "应用路由" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用路由" +description: "介绍如何管理应用路由。" +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 new file mode 100644 index 000000000..83779eeef --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/01-view-a-pod-list.adoc @@ -0,0 +1,42 @@ +--- +title: "查看容器组列表" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 容器组, 查看容器组列表" +description: "介绍如何查看容器组列表。" +weight: 01 +--- + +:ks_permission: **应用负载查看** +:ks_navigation: **应用负载 > 容器组** + + +include::../../../../_custom/clusterManagement/pods/pods-desc-viewAPodList.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/pods/pods-para-podList.adoc[] + +include::../../../../_custom/clusterManagement/pods/pods-oper-searchForPods.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/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 new file mode 100644 index 000000000..1feadd26d --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/02-view-pod-details.adoc @@ -0,0 +1,40 @@ +--- +title: "查看容器组详情" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 容器组, 查看容器组详情" +description: "介绍如何查看容器组详情。" +weight: 02 +--- + +:ks_permission: **应用负载查看** +:ks_navigation: **应用负载 > 容器组** + + +include::../../../../_custom/clusterManagement/pods/pods-desc-viewPodDetails.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/pods/pods-oper-openDetails.adoc[] + ++ + +include::../../../../_custom/clusterManagement/pods/pods-oper-viewPodDetails_new.adoc[] 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 new file mode 100644 index 000000000..2cc86aa9e --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/03-view-container-details.adoc @@ -0,0 +1,40 @@ +--- +title: "查看容器详情" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 容器组, 查看容器详情" +description: "介绍如何查看容器详情。" +weight: 03 +--- + +:ks_permission: **应用负载查看** +:ks_navigation: **应用负载 > 容器组** + + +include::../../../../_custom/clusterManagement/pods/pods-desc-viewContainerDetails.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/pods/pods-oper-openDetails.adoc[] + ++ + +include::../../../../_custom/clusterManagement/pods/pods-oper-viewContainerDetails_new.adoc[] 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 new file mode 100644 index 000000000..3892c8026 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/04-access-a-container-terminal.adoc @@ -0,0 +1,40 @@ +--- +title: "访问容器终端" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 容器组, 访问容器终端" +description: "介绍如何访问容器终端。" +weight: 04 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 容器组** + + +include::../../../../_custom/clusterManagement/pods/pods-desc-accessAContainerTerminal.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/pods/pods-oper-openDetails.adoc[] + ++ + +include::../../../../_custom/clusterManagement/pods/pods-oper-accessAContainerTerminal.adoc[] 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 new file mode 100644 index 000000000..af4cba31f --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/05-delete-pods.adoc @@ -0,0 +1,49 @@ +--- +title: "删除容器组" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 容器组, 删除容器组" +description: "介绍如何删除容器组。" +weight: 05 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 容器组** + + +include::../../../../_custom/clusterManagement/pods/pods-desc-deletePods.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/pods/pods-oper-deleteASinglePod.adoc[] + + +== 批量删除容器组 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/pods/pods-oper-deleteMultiplePods.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/_index.adoc b/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/_index.adoc new file mode 100644 index 000000000..6639ea21d --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/06-pods/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "容器组" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 容器组" +description: "介绍如何管理容器组。" +weight: 06 +--- + + + +include::../../../../_custom/clusterManagement/pods/pods-desc-pods.adoc[] 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 new file mode 100644 index 000000000..8abed0066 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/03-application-workloads/_index.adoc @@ -0,0 +1,9 @@ +--- +title: "应用负载" +keywords: "Kubernetes, {ks_product}, 项目管理, 存储, 应用负载" +description: "介绍如何管理应用负载。" +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 new file mode 100644 index 000000000..9462a25c5 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/01-create-a-persistent-volume-claim.adoc @@ -0,0 +1,40 @@ +--- +title: "创建持久卷声明" +keywords: "Kubernetes, {ks_product}, 项目管理, 存储, 持久卷声明, 创建持久卷声明" +description: "介绍如何创建持久卷声明。" +weight: 01 +--- + +:ks_permission: **持久卷声明管理** +:ks_navigation: **存储 > 持久卷声明** + + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAPersistentVolumeClaim.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::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim_new.adoc[] 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 new file mode 100644 index 000000000..8c4edf2c7 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/02-view-a-persistent-volume-claim-list.adoc @@ -0,0 +1,42 @@ +--- +title: "查看持久卷声明列表" +keywords: "Kubernetes, {ks_product}, 项目管理, 存储, 持久卷声明, 查看持久卷声明列表" +description: "介绍如何查看持久卷声明列表。" +weight: 02 +--- + +:ks_permission: **持久卷声明查看** +:ks_navigation: **存储 > 持久卷声明** + + +include::../../../../_custom/clusterManagement/pods/pods-desc-viewAPersistentVolumeList.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/persistentVolumeClaims/persistentVolumeClaims-para-persistentVolumeClaimList.adoc[] + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-searchForPersistentVolumeClaims.adoc[] + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..646442063 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/03-view-persistent-volume-claim-details.adoc @@ -0,0 +1,41 @@ +--- +title: "查看持久卷声明详情" +keywords: "Kubernetes, {ks_product}, 项目管理, 存储, 持久卷声明, 查看持久卷声明详情" +description: "介绍如何查看持久卷声明详情。" +weight: 03 +--- + +:ks_permission: **持久卷声明查看** +:ks_navigation: **存储 > 持久卷声明** + + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-viewPersistentVolumeClaimDetails.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/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails_new.adoc[] + 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 new file mode 100644 index 000000000..4f283a98a --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/04-clone-a-persistent-volume.adoc @@ -0,0 +1,45 @@ +--- +title: "克隆持久卷" +keywords: "Kubernetes, {ks_product}, 项目管理, 存储, 持久卷声明, 克隆持久卷" +description: "介绍如何克隆持久卷。" +weight: 04 +--- + +:ks_permission: **持久卷声明管理** +:ks_navigation: **存储 > 持久卷声明** + + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-cloneAPersistentVolume.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc[] + + +* 请确保后端存储系统支持卷克隆功能，并且持久卷声明对应的存储类已启用卷克隆功能。 + + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-cloneAPersistentVolume.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 new file mode 100644 index 000000000..f39c8c974 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/06-expand-a-persistent-volume.adoc @@ -0,0 +1,46 @@ +--- +title: "扩展持久卷" +keywords: "Kubernetes, {ks_product}, 项目管理, 存储, 持久卷声明, 扩展持久卷" +description: "介绍如何扩展持久卷容量。" +weight: 06 +--- + +:ks_permission: **持久卷声明管理** +:ks_navigation: **存储 > 扩展持久卷** + + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-expandAPersistentVolumeClaim.adoc[] + + +== 前提条件 + + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc[] + + +* 请确保后端存储系统支持卷快克隆功能，并且持久卷声明对应的存储类已启用卷克隆功能。 + +// * 请确保后端存储系统支持卷克隆功能，并且持久卷声明对应的存储类已启用卷克隆功能。有关更多信息，请参阅《{ks_product_full_right}集群管理指南》的“启用和禁用卷操作”章节。 + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-expandAPersistentVolume.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 new file mode 100644 index 000000000..db57ec98e --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/07-edit-persistent-volume-claim-information.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑持久卷声明信息" +keywords: "Kubernetes, {ks_product}, 项目管理, 存储, 持久卷声明, 编辑持久卷声明信息" +description: "介绍如何编辑持久卷声明信息。" +weight: 07 +--- + +:ks_permission: **持久卷声明管理** +:ks_navigation: **存储 > 扩展持久卷** + + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-editPersistentVolumeClaimInformation.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/persistentVolumeClaims/persistentVolumeClaims-oper-editPersistentVolumeClaimInformation.adoc[] 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 new file mode 100644 index 000000000..a6be1ef8e --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/08-delete-persistent-volume-claims.adoc @@ -0,0 +1,50 @@ +--- +title: "删除持久卷声明" +keywords: "Kubernetes, {ks_product}, 项目管理, 存储, 持久卷声明, 删除持久卷声明" +description: "介绍如何删除持久卷声明。" +weight: 08 +--- + +:ks_permission: **持久卷声明管理** +:ks_navigation: **存储 > 扩展持久卷** + + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-deletePersistentVolumeClaims.adoc[] + + +== 前提条件 + + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-backData.adoc[] + + +== 删除单个持久卷声明 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteASinglePersistentVolumeClaim.adoc[] + + +== 批量删除持久卷声明 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteMultiplePersistentVolumeClaims.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/_index.adoc b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/_index.adoc new file mode 100644 index 000000000..e1b1dccc1 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/04-storage/01-peristent-volume-claims/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "持久卷声明" +keywords: "Kubernetes, {ks_product}, 项目管理, 存储, 持久卷声明" +description: "介绍如何管理持久卷声明。" +weight: 01 +--- + + + +本节介绍如何管理持久卷声明。 + +系统根据持久卷声明中的参数，在后端存储系统中创建可供容器使用的存储区域，每个存储区域与{ks_product_both}平台上的一个持久卷对应。 diff --git a/content/zh/docs/v4.1/09-project-management/04-storage/_index.adoc b/content/zh/docs/v4.1/09-project-management/04-storage/_index.adoc new file mode 100644 index 000000000..ac269409c --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/04-storage/_index.adoc @@ -0,0 +1,16 @@ +--- +title: "存储" +keywords: "Kubernetes, {ks_product}, 项目管理, 存储" +description: "介绍如何管理存储资源。" +weight: 04 +--- + + + +本节介绍如何管理存储资源。 + +{ks_product_right}支持在项目中管理以下存储资源： + +* 持久卷声明：定义存储空间需求。系统根据持久卷声明中的参数，在后端存储系统中创建可供容器使用的存储区域，每个存储区域与{ks_product_both}平台上的一个持久卷对应。 + +// * 卷快照：定义快照数据的存储需求。系统根据卷快照中的参数，在后端存储系统中保存快照数据。 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 new file mode 100644 index 000000000..934dadc29 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/01-create-a-secret.adoc @@ -0,0 +1,40 @@ +--- +title: "创建保密字典" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 保密字典, 创建保密字典" +description: "介绍如何创建保密字典。" +weight: 01 +--- + +:ks_permission: **保密字典管理** +:ks_navigation: **配置 > 保密字典** + + +include::../../../../_custom/clusterManagement/secrets/secrets-desc-createASecret.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::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/secrets/secrets-oper-createASecret.adoc[] 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 new file mode 100644 index 000000000..0c12c74ce --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/02-view-a-secret-list.adoc @@ -0,0 +1,42 @@ +--- +title: "查看保密字典列表" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 保密字典, 查看保密字典列表" +description: "介绍如何查看保密字典列表。" +weight: 02 +--- + +:ks_permission: **保密字典查看** +:ks_navigation: **存储 > 保密字典** + + +include::../../../../_custom/clusterManagement/secrets/secrets-desc-viewASecretList.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/secrets/secrets-para-secretList.adoc[] + +include::../../../../_custom/clusterManagement/secrets/secrets-oper-searchForSecrets.adoc[] + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..94f067dae --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/03-view-secret-details.adoc @@ -0,0 +1,40 @@ +--- +title: "查看保密字典详情" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 保密字典, 查看保密字典详情" +description: "介绍如何查看保密字典详情。" +weight: 03 +--- + +:ks_permission: **保密字典查看** +:ks_navigation: **存储 > 保密字典** + + +include::../../../../_custom/clusterManagement/secrets/secrets-desc-viewSecretDetails.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/secrets/secrets-oper-openSecretDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/secrets/secrets-oper-viewSecretDetails.adoc[] 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 new file mode 100644 index 000000000..46be340af --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/04-edit-secret-information.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑保密字典信息" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 保密字典, 编辑保密字典信息" +description: "介绍如何编辑保密字典的键值对数据。" +weight: 04 +--- + +:ks_permission: **保密字典管理** +:ks_navigation: **配置 > 保密字典** + + +include::../../../../_custom/clusterManagement/secrets/secrets-desc-editSecretInformation.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/secrets/secrets-oper-editSecretInformation.adoc[] 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 new file mode 100644 index 000000000..e07e798b9 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/05-edit-secret-settings.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑保密字典设置" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 保密字典, 编辑保密字典设置" +description: "介绍如何编辑保密字典的设置。" +weight: 05 +--- + +:ks_permission: **保密字典管理** +:ks_navigation: **配置 > 保密字典** + + +include::../../../../_custom/clusterManagement/secrets/secrets-desc-editSecretSettings.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/secrets/secrets-oper-editSecretSettings.adoc[] 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 new file mode 100644 index 000000000..ceeb81e88 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/06-delete-secrets.adoc @@ -0,0 +1,49 @@ +--- +title: "删除保密字典" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 保密字典, 删除保密字典" +description: "介绍如何删除保密字典。" +weight: 06 +--- + +:ks_permission: **保密字典管理** +:ks_navigation: **配置 > 保密字典** + + +include::../../../../_custom/clusterManagement/secrets/secrets-desc-deleteSecrets.adoc[] + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 删除单个保密字典 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/secrets/secrets-oper-deleteASingleSecret.adoc[] + + +== 批量删除保密字典 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/secrets/secrets-oper-deleteMultipleSecrets.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/_index.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/_index.adoc new file mode 100644 index 000000000..9d82c59ec --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/01-secrets/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "保密字典" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 保密字典" +description: "介绍如何管理保密字典。" +weight: 01 +--- + + + +include::../../../../_custom/clusterManagement/secrets/secrets-desc-secrets.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 new file mode 100644 index 000000000..fb03aa24d --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/01-create-a-configmap.adoc @@ -0,0 +1,40 @@ +--- +title: "创建配置字典" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 配置字典, 创建配置字典" +description: "介绍如何创建配置字典。" +weight: 01 +--- + +:ks_permission: **配置字典管理** +:ks_navigation: **配置 > 配置字典** + + +include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-createAConfigmap.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::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/configmaps/configmaps-oper-createAConfigmap.adoc[] 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 new file mode 100644 index 000000000..d3da9bd7c --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/02-view-a-configmap-list.adoc @@ -0,0 +1,42 @@ +--- +title: "查看配置字典列表" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 配置字典, 查看配置字典列表" +description: "介绍如何查看配置字典列表。" +weight: 02 +--- + +:ks_permission: **配置字典查看** +:ks_navigation: **配置 > 配置字典** + + +include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-viewAConfigmapList.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/configmaps/configmaps-para-configmapList_new.adoc[] + +include::../../../../_custom/clusterManagement/configmaps/configmaps-oper-searchForConfigmaps.adoc[] + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== \ No newline at end of file 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 new file mode 100644 index 000000000..d71814318 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/03-view-configmap-details.adoc @@ -0,0 +1,40 @@ +--- +title: "查看配置字典详情" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 配置字典, 查看配置字典详情" +description: "介绍如何查看配置字典详情。" +weight: 03 +--- + +:ks_permission: **配置字典查看** +:ks_navigation: **配置 > 配置字典** + + +include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-viewConfigmapDetails.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/configmaps/configmaps-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/configmaps/configmaps-oper-viewConfigmapDetails.adoc[] 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 new file mode 100644 index 000000000..709951525 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/04-edit-configmap-information.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑配置字典信息" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 配置字典, 编辑配置字典信息" +description: "介绍如何编辑配置字典信息。" +weight: 04 +--- + +:ks_permission: **配置字典管理** +:ks_navigation: **配置 > 配置字典** + + +include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-editConfigmapInformation.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/configmaps/configmaps-oper-editConfigmapInformation.adoc[] 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 new file mode 100644 index 000000000..ed901978c --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/05-edit-configmap-settings.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑配置字典设置" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 配置字典, 编辑配置字典设置" +description: "介绍如何编辑配置字典设置。" +weight: 05 +--- + +:ks_permission: **配置字典管理** +:ks_navigation: **配置 > 配置字典** + + +include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-editConfigmapSettings.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/configmaps/configmaps-oper-editConfigmapSettings.adoc[] 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 new file mode 100644 index 000000000..24a0f1f73 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/06-delete-configmaps.adoc @@ -0,0 +1,49 @@ +--- +title: "删除配置字典" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 配置字典, 删除配置字典" +description: "介绍如何删除配置字典。" +weight: 06 +--- + +:ks_permission: **配置字典管理** +:ks_navigation: **配置 > 配置字典** + + +include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-deleteConfigmaps.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/configmaps/configmaps-oper-deleteASingleConfigmap.adoc[] + + +== 批量删除配置字典 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/configmaps/configmaps-oper-deleteMultipleConfigmaps.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/_index.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/_index.adoc new file mode 100644 index 000000000..a974a4bfc --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/02-configmaps/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "配置字典" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 配置字典" +description: "介绍如何管理配置字典。" +weight: 02 +--- + + + +include::../../../../_custom/clusterManagement/configmaps/configmaps-desc-configmaps.adoc[] + +配置字典仅用于存储非保密数据。如需存储保密数据，请使用link:../01-secrets/[保密字典]。 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 new file mode 100644 index 000000000..87b6e6035 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/01-create-a-service-account.adoc @@ -0,0 +1,36 @@ +--- +title: "创建服务帐户" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 服务帐户, 创建服务帐户" +description: "介绍如何创建服务帐户。" +weight: 01 +--- + +:ks_permission: **服务帐户管理** +:ks_navigation: **存储 > 服务帐户** + + +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-createAServiceAccount.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/serviceAccounts/serviceAccounts-oper-createAServiceAccount_new.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 new file mode 100644 index 000000000..282c68a8c --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/02-view-a-service-account-list.adoc @@ -0,0 +1,42 @@ +--- +title: "查看服务帐户列表" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 服务帐户, 查看服务帐户列表" +description: "介绍如何查看服务帐户列表。" +weight: 02 +--- + +:ks_permission: **服务帐户查看** +:ks_navigation: **存储 > 服务帐户** + + +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-viewAServiceAccountList.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/serviceAccounts/serviceAccounts-para-serviceAccountList.adoc[] + +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-searchForServiceAccounts.adoc[] + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== 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 new file mode 100644 index 000000000..d810b0d2a --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/03-view-service-account-details.adoc @@ -0,0 +1,40 @@ +--- +title: "查看服务帐户详情" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 服务帐户, 查看服务帐户详情" +description: "介绍如何查看服务帐户详情。" +weight: 03 +--- + +:ks_permission: **服务帐户查看** +:ks_navigation: **存储 > 服务帐户** + + +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-viewServiceAccountDetails.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/serviceAccounts/serviceAccounts-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-viewServiceAccountDetails.adoc[] 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 new file mode 100644 index 000000000..56124df00 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/04-edit-service-account-information.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑服务帐户信息" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 服务帐户, 编辑服务帐户信息" +description: "介绍如何编辑服务帐户信息。" +weight: 04 +--- + +:ks_permission: **服务帐户管理** +:ks_navigation: **存储 > 服务帐户** + + +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-editServiceAccountInformation.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/serviceAccounts/serviceAccounts-oper-editServiceAccountInformation.adoc[] 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 new file mode 100644 index 000000000..1809dfd4d --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/05-change-the-role-of-a-service-account.adoc @@ -0,0 +1,36 @@ +--- +title: "修改服务帐户角色" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 服务帐户, 修改服务帐户角色" +description: "介绍如何修改服务帐户角色。" +weight: 05 +--- + +:ks_permission: **服务帐户管理** +:ks_navigation: **配置 > 服务帐户** + + +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-changeTheRoleOfAServiceAccount.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/serviceAccounts/serviceAccounts-oper-changeTheRoleOfAServiceAccount.adoc[] 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 new file mode 100644 index 000000000..20b15b4b0 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/06-delete-service-accounts.adoc @@ -0,0 +1,49 @@ +--- +title: "删除服务帐户" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 服务帐户, 删除服务帐户" +description: "介绍如何修改服务帐户角色。" +weight: 06 +--- + +:ks_permission: **服务帐户管理** +:ks_navigation: **配置 > 服务帐户** + + +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-deleteServiceAccounts.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/serviceAccounts/serviceAccounts-oper-deleteASingleServiceAccount.adoc[] + + +== 批量删除服务帐户 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-oper-deleteMultipleServiceAccounts.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/_index.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/_index.adoc new file mode 100644 index 000000000..8ffa14764 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/03-service-accounts/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "服务帐户" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置, 服务帐户" +description: "介绍如何管理服务帐户。" +weight: 03 +--- + + + +include::../../../../_custom/clusterManagement/serviceAccounts/serviceAccounts-desc-serviceAccounts.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/05-configuration/_index.adoc b/content/zh/docs/v4.1/09-project-management/05-configuration/_index.adoc new file mode 100644 index 000000000..dbfb1c0d6 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/05-configuration/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "配置" +keywords: "Kubernetes, {ks_product}, 项目管理, 配置" +description: "介绍如何管理保密字典、配置字典和服务帐户。" +weight: 05 +--- + + + +include::../../../_custom/clusterManagement/clusterManagement-desc-configuration.adoc[] 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 new file mode 100644 index 000000000..75b4f0f10 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/01-view-project-basic-information.adoc @@ -0,0 +1,48 @@ +--- +title: "查看项目基本信息" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 基本信息, 查看项目基本信息" +description: "介绍如何查看项目基本信息。" +weight: 01 +--- + +:ks_permission: **项目设置查看** +:ks_navigation: **项目设置 > 基本信息** + + +本节介绍如何查看项目基本信息。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +-- +**基本信息**页面提供以下信息： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|项目信息 +|当前项目的信息，包括项目的名称、所属企业空间、创建者、创建时间、服务数量、项目角色数量和项目成员数量。 + +include::../../../../_custom/clusterManagement/projects/projects-para-defaultContainerQuotas.adoc[] + +include::../../../../_custom/clusterManagement/projects/projects-para-projectQuotas.adoc[] +|=== +-- 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 new file mode 100644 index 000000000..f2810c2f8 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/02-edit-project-information.adoc @@ -0,0 +1,49 @@ +--- +title: "编辑项目信息" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 基本信息, 编辑项目信息" +description: "介绍如何编辑项目信息。" +weight: 02 +--- + +:ks_permission: **项目设置管理** +:ks_navigation: **项目设置 > 基本信息** + + +本节介绍如何编辑项目基本信息。 + +您可以编辑项目的别名和描述。{ks_product_right}不支持编辑已创建项目的名称。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**基本信息**页面，点击**管理**，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置项目的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../_custom/clusterManagement/projects/projects-para-aliasDescription.adoc[] +|=== +-- 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 new file mode 100644 index 000000000..a41358e23 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/03-edit-project-quotas.adoc @@ -0,0 +1,40 @@ +--- +title: "编辑项目配额" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 基本信息, 编辑项目配额" +description: "介绍如何编辑项目配额。" +weight: 03 +--- + +:ks_permission: **项目设置管理** +:ks_navigation: **项目设置 > 基本信息** + + +include::../../../../_custom/clusterManagement/projects/projects-desc-editQuotas.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/projects/projects-oper-editProjectQuotas.adoc[] 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 new file mode 100644 index 000000000..863b749af --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/04-edit-default-container-quotas.adoc @@ -0,0 +1,40 @@ +--- +title: "编辑默认容器配额" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 基本信息, 编辑默认容器配额" +description: "介绍如何编辑默认容器配额。" +weight: 04 +--- + +:ks_permission: **项目设置管理** +:ks_navigation: **项目设置 > 基本信息** + + +include::../../../../_custom/clusterManagement/projects/projects-desc-editDefaultContainerQuotas.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/projects/projects-oper-editDefaultContainerQuotas.adoc[] 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 new file mode 100644 index 000000000..bbc8fbe4d --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/05-delete-a-project.adoc @@ -0,0 +1,40 @@ +--- +title: "删除项目" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 基本信息, 删除项目" +description: "介绍如何删除项目。" +weight: 05 +--- + +:ks_permission: **项目设置管理** +:ks_navigation: **项目设置 > 基本信息** + + +include::../../../../_custom/clusterManagement/projects/projects-desc-deleteProjects.adoc[] + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**基本信息**页面，点击**管理**，然后在下拉列表中选择**删除项目**。 + +. 在**删除项目**对话框，输入项目的名称，然后点击**确定**。 + + diff --git a/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/_index.adoc b/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/_index.adoc new file mode 100644 index 000000000..8e2b46af6 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/01-basic-information/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "基本信息" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 基本信息" +description: "介绍如何查看和编辑项目基本信息。" +weight: 01 +--- + + + +本节介绍如何查看和管理项目的基本信息。 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 new file mode 100644 index 000000000..5c7c320ce --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/01-create-a-project-role.adoc @@ -0,0 +1,59 @@ +--- +title: "创建项目角色" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 项目角色, 创建项目角色" +description: "介绍如何创建项目角色。" +weight: 01 +--- + +:ks_permission: **角色管理** +:ks_navigation: **项目设置 > 项目角色** + + +本节介绍如何创建项目角色。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**创建项目角色**对话框，设置项目角色的名称、别名和描述，然后点击**编辑权限**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|项目角色的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 + +include::../../../../_custom/projectManagement/projectRoles/projectRoles-para-aliasAndDescription.adoc[] +|=== +-- + +. 在**编辑权限**对话框，设置项目角色的权限，然后点击**确定**。 ++ +include::../../../../_custom/projectManagement/projectRoles/projectRoles-para-permissions_v4.adoc[] + + + 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 new file mode 100644 index 000000000..328f0649c --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/02-view-a-project-role-list.adoc @@ -0,0 +1,36 @@ +--- +title: "查看项目角色列表" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 项目角色, 查看项目角色列表" +description: "介绍如何查看项目角色列表。" +weight: 02 +--- + +:ks_permission: **角色查看** +:ks_navigation: **项目设置 > 项目角色** + + +本节介绍如何查看项目角色列表。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +-- +include::../../../../_custom/projectManagement/projectRoles/projectRoles-para-presetRoles.adoc[] +-- 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 new file mode 100644 index 000000000..e104c3cc0 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/03-view-project-role-details.adoc @@ -0,0 +1,40 @@ +--- +title: "查看项目角色详情" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 项目角色, 查看项目角色详情" +description: "介绍如何查看项目角色详情。" +weight: 03 +--- + +:ks_permission: **角色查看** +:ks_navigation: **项目设置 > 项目角色** + + +本节介绍如何查看项目角色详情。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在项目角色列表中点击一个项目角色的名称打开其详情页面。 + +. 在项目角色详情页面右侧的**权限**页签查看项目角色具有的权限。 + +. 在项目角色详情页面右侧点击**授权用户**页签具有当前项目角色的用户。 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 new file mode 100644 index 000000000..cdce5b040 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/04-edit-project-role-information.adoc @@ -0,0 +1,49 @@ +--- +title: "编辑项目角色信息" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 项目角色, 编辑项目角色信息" +description: "介绍如何编辑项目角色信息。" +weight: 04 +--- + +:ks_permission: **角色管理** +:ks_navigation: **项目设置 > 项目角色** + + +本节介绍如何编辑项目角色信息。 + +您可以编辑由用户创建的项目角色的别名和描述。{ks_product_right}不支持编辑预置的项目角色，同时不支持编辑项目角色的名称。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的项目角色右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置项目角色的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../_custom/projectManagement/projectRoles/projectRoles-para-aliasAndDescription.adoc[] +|=== +-- 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 new file mode 100644 index 000000000..981b9fc52 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/05-edit-permissions-of-a-project-role.adoc @@ -0,0 +1,41 @@ +--- +title: "编辑项目角色权限" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 项目角色, 编辑项目角色权限" +description: "介绍如何编辑项目角色权限。" +weight: 05 +--- + +:ks_permission: **角色管理** +:ks_navigation: **项目设置 > 项目角色** + + +本节介绍如何编辑项目角色权限。 + +您只能编辑用户创建的项目角色权限。预置项目角色的权限无法编辑。 + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的项目角色右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑权限**。 + +. 在**编辑权限**对话框，设置项目角色的权限，然后点击**确定**。 ++ +include::../../../../_custom/projectManagement/projectRoles/projectRoles-para-permissions_v4.adoc[] \ No newline at end of file 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 new file mode 100644 index 000000000..f575b2974 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/06-delete-a-project-role.adoc @@ -0,0 +1,41 @@ +--- +title: "删除项目角色" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 项目角色, 删除项目角色" +description: "介绍如何删除项目角色。" +weight: 06 +--- + +:ks_permission: **角色管理** +:ks_navigation: **项目设置 > 项目角色** + + +本节介绍如何删除项目角色。 + +您可以删除用户创建的项目角色。预置项目角色无法删除。 + + +== 前提条件 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +* 如果需要删除的项目角色已经分配给项目成员，您需要删除项目成员或修改其角色。 + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的项目角色右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除角色**对话框点击**确定**。 diff --git a/content/zh/docs/v4.1/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 new file mode 100644 index 000000000..e52370c91 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/02-project-roles/_index.adoc @@ -0,0 +1,18 @@ +--- +title: "项目角色" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 项目角色" +description: "介绍如何管理项目角色。" +weight: 02 +--- + + +本节介绍如何管理项目角色。 + +每个企业空间角色都包含特定的项目管理或查看权限。您可以将包含特定权限的角色授予项目成员，以控制项目成员在项目中的权限。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +include::../../../../_custom/projectManagement/projectRoles/projectRoles-desc-initialProjectAdmin.adoc[] + +include::../../../../../_ks_components/admonitions/admonEnd.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 new file mode 100644 index 000000000..6b76905c8 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/01-invite-a-user-to-a-project.adoc @@ -0,0 +1,48 @@ +--- +title: "邀请用户加入项目" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 项目成员, 邀请用户加入项目" +description: "介绍如何邀请用户加入项目。" +weight: 01 +--- + +:ks_permission: **成员管理** +:ks_navigation: **项目设置 > 项目成员** + + +本节介绍如何邀请用户加入项目。 + + +== 前提条件 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* 被邀请的的用户需要先加入项目所属的企业空间。 + + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickInvite.adoc[] + ++ + +. 在**邀请成员**对话框，在需要邀请的用户右侧点击image:/images/ks-qkcp/zh/icons/add-dark.svg[add-dark,18,18]，在下拉列表中选择用户在项目中的角色，然后点击**确定**。 ++ +-- +include::../../../../_custom/projectManagement/projectRoles/projectRoles-para-presetRoles.adoc[] + +用户被邀请加入项目后将显示在项目成员列表中。 +-- \ No newline at end of file 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 new file mode 100644 index 000000000..da8648359 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/02-view-a-project-member-list.adoc @@ -0,0 +1,65 @@ +--- +title: "查看项目成员列表" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 项目成员, 查看项目成员列表" +description: "介绍如何查看项目成员列表。" +weight: 02 +--- + +:ks_permission: **成员查看** +:ks_navigation: **项目设置 > 项目成员** + + +本节介绍如何查看项目成员列表。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +==== +* 项目成员列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|用户名 +|项目成员的用户名。 + +|状态 +| +项目成员当前的状态。 + +include::../../../../_custom/clusterManagement/clusterMembers/clusterMembers-para-userStatus.adoc[] + +|角色 +|项目成员在集群中的角色。 + +|最近登录 +|项目成员最近一次登录{ks_product_left} Web 控制台的时间。 +|=== +-- + +* 在列表上方点击搜索框并输入关键字，可搜索用户名包含特定关键字的项目成员。 + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== + 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 new file mode 100644 index 000000000..20a91116b --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/03-change-the-role-of-a-project-member.adoc @@ -0,0 +1,42 @@ +--- +title: "修改项目成员的角色" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 项目成员, 修改项目成员的角色" +description: "介绍如何修改项目成员的角色。" +weight: 03 +--- + +:ks_permission: **成员查看** +:ks_navigation: **项目设置 > 项目成员** + + +本节介绍如何修改项目成员的角色。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的项目成员右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后选择**修改角色**。 + +. 在**修改角色**对话框，设置项目成员的角色，然后点击**确定**。 ++ +-- +include::../../../../_custom/projectManagement/projectRoles/projectRoles-para-presetRoles.adoc[] +-- 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 new file mode 100644 index 000000000..71ee75bc5 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/04-remove-a-project-member.adoc @@ -0,0 +1,49 @@ +--- +title: "移除项目成员" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 项目成员, 移除项目成员" +description: "介绍如何移除项目成员。" +weight: 04 +--- + +:ks_permission: **成员查看** +:ks_navigation: **项目设置 > 项目成员** + + +本节介绍如何移除项目成员。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +用户被从项目中移除后，将失去项目角色提供的权限。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要移除的项目成员右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后选择**移除**。 + +. 在**移除成员**对话框输出项目成员的用户名，然后点击**确定**。 ++ +-- +项目成员被移除后将不再显示在项目成员列表中。 +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/_index.adoc b/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/_index.adoc new file mode 100644 index 000000000..49e59ac97 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/03-project-members/_index.adoc @@ -0,0 +1,19 @@ +--- +title: "项目成员" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 项目成员" +description: "介绍如何管理项目成员。" +weight: 03 +--- + + + +本节介绍如何管理项目成员。 + +项目成员是在项目中具有资源查看或管理权限的用户，项目成员的权限由成员在项目中的角色决定。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +include::../../../../_custom/projectManagement/projectRoles/projectRoles-desc-initialProjectAdmin.adoc[] + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/v4.1/09-project-management/06-project-settings/_index.adoc b/content/zh/docs/v4.1/09-project-management/06-project-settings/_index.adoc new file mode 100644 index 000000000..3a1603916 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/06-project-settings/_index.adoc @@ -0,0 +1,8 @@ +--- +title: "项目设置" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置" +description: "介绍如何管理项目设置。" +weight: 06 +--- + +本节介绍如何查看和管理项目的基本信息、项目角色和项目成员。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/09-project-management/_index.adoc b/content/zh/docs/v4.1/09-project-management/_index.adoc new file mode 100644 index 000000000..2f7e05b91 --- /dev/null +++ b/content/zh/docs/v4.1/09-project-management/_index.adoc @@ -0,0 +1,42 @@ +--- +title: "项目管理" +keywords: "Kubernetes, {ks_product}, 项目管理" +description: "介绍如何管理项目，以及如何在项目中管理应用负载、存储资源、配置资源、灰度发布任务、镜像构建器、监控告警和项目设置。" +weight: 09 +--- + + + +本节介绍如何管理项目中的资源。 + +在{ks_product_both}平台，每个企业空间可以包含一个或多个项目。用户可以被邀请加入项目，并根据项目角色获得项目资源的查看和管理权限。 + +ifeval::["{file_output_type}" == "pdf"] +== 产品版本 + +本文档适用于{ks_product_left} v4.1.0 版本。 + +== 读者对象 + +本文档主要适用于以下读者： + +* {ks_product_right}用户 + +* 交付工程师 + +* 运维工程师 + +* 售后工程师 + + +== 修订记录 + +[%header,cols="1a,1a,3a"] +|=== +|文档版本 |发布日期 |修改说明 + +|01 +|{pdf_releaseDate} +|第一次正式发布。 +|=== +endif::[] \ No newline at end of file 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 new file mode 100644 index 000000000..121b54283 --- /dev/null +++ b/content/zh/docs/v4.1/10-toolbox/01-use-kubectl-tool.adoc @@ -0,0 +1,51 @@ +--- +title: "通过 kubectl 运行命令" +keywords: "Kubernetes, KubeSphere, kubectl, 命令, 通过 kubectl 运行命令" +description: "介绍如何过 kubectl 运行命令。" +weight: 01 +--- + +Kubectl 是 Kubernetes 命令行工具。您可以用它在 Kubernetes 集群上运行命令，以便查看和管理集群资源等。 + +{ks_product_right}控制台提供 Web kubectl，方便用户使用。在默认情况下，当前版本中，只有被授予 platform-admin 角色的用户（例如默认账户 admin）才有权限使用 Web kubectl 进行集群资源操作和管理。 + +本节演示如何使用 Web kubectl 进行集群资源操作和管理。 + +== 前提条件 + +您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../05-users-and-roles/01-users/[用户]和link:../../05-users-and-roles/02-platform-roles/[平台角色]。 + +== 使用 Web Kubectl + +. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 + +. 将光标悬停在页面右下角的image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18]图标，然后在菜单中选择 kubectl。 + +. 在弹出窗口中看到 kubectl 界面，如下图所示。如果有多个集群，则需要先在右上角的下拉列表中选择目标集群。如果只有一个集群，则该下拉列表不可见。 ++ +image:/images/ks-qkcp/zh/v4.0/kubectl.png[,100%] + +. 在命令行工具中输入 kubectl 命令，查询并管理 Kubernetes 集群资源。例如，执行以下命令查询集群中所有 pod 的状态。 ++ +[,bash] +---- +kubectl get pods -A +---- + +. 在终端窗口中使用以下语法运行 kubectl 命令： ++ +[,bash] +---- +kubectl [command] [TYPE] [NAME] [flags] +---- + +include::../../../_ks_components/admonitions/note.adoc[] + +* 其中，command、TYPE、NAME 和 flags 分别是： + +** command：指定要对一个或多个资源执行的操作，例如 create、get、describe 和 delete。 +** 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 new file mode 100644 index 000000000..a1c015960 --- /dev/null +++ b/content/zh/docs/v4.1/10-toolbox/02-view-a-kubeconfig-file.adoc @@ -0,0 +1,20 @@ +--- +title: "查看 kubeconfig 文件" +keywords: "Kubernetes, {ks_product}, 项目管理, 工具箱, 查看 kubeconfig 文件" +description: "介绍如何查看 kubeconfig 文件。" +weight: 02 +--- + + + +include::../../_custom/workspaceManagement/toolBox/toolBox-desc-viewKubeconfig.adoc[] + + +== 前提条件 + +include::../../_custom/workspaceManagement/toolBox/toolBox-prer-viewKubeconfig.adoc[] + + +== 操作步骤 + +include::../../_custom/workspaceManagement/toolBox/toolBox-oper-viewKubeconfig.adoc[] diff --git a/content/zh/docs/v4.1/10-toolbox/_index.adoc b/content/zh/docs/v4.1/10-toolbox/_index.adoc new file mode 100644 index 000000000..d045695cd --- /dev/null +++ b/content/zh/docs/v4.1/10-toolbox/_index.adoc @@ -0,0 +1,40 @@ +--- +title: "工具箱" +keywords: "Kubernetes, {ks_product}, 项目管理, 工具箱" +description: "介绍如何使用工具箱。" +weight: 10 +--- + +{ks_product_right}集成了 kubectl 命令行工具，以及集群的 kubeconfig 文件。通过使用 kubeconfig 文件，您可以配置当前集群的访问信息。 + +本节介绍如何通过 kubectl 运行命令，以及如何查看下载集群的 kubeconfig 文件。 + +ifeval::["{file_output_type}" == "pdf"] +== 产品版本 + +本文档适用于{ks_product_left} v4.1.0 版本。 + +== 读者对象 + +本文档主要适用于以下读者： + +* {ks_product_right}用户 + +* 交付工程师 + +* 运维工程师 + +* 售后工程师 + + +== 修订记录 + +[%header,cols="1a,1a,3a"] +|=== +|文档版本 |发布日期 |修改说明 + +|01 +|{pdf_releaseDate} +|第一次正式发布。 +|=== +endif::[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/01-overview.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/01-overview.adoc new file mode 100644 index 000000000..14a3c11d7 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/01-overview.adoc @@ -0,0 +1,44 @@ +--- +title: "概述" +keywords: "Kubernetes, {ks_product}, DevOps, 概述" +description: "介绍{ks_product_left} DevOps 的基本原理。" +weight: 01 +--- + +DevOps 提供一系列持续集成 (CI) 和持续交付 (CD) 工具，可以使 IT 和软件开发团队之间的流程实现自动化。在 CI/CD 工作流中，每次集成都通过自动化构建来验证，包括编码、发布和测试，从而帮助开发者提前发现集成错误，团队也可以快速、安全、可靠地将内部软件交付到生产环境。 + +不过，传统的 Jenkins Controller-Agent 架构（即多个 Agent 为一个 Controller 工作）有以下不足。 + +* 如果 Controller 宕机，整个 CI/CD 流水线会崩溃。 +* 资源分配不均衡，一些 Agent 的流水线任务 (Job) 出现排队等待，而其他 Agent 处于空闲状态。 +* 不同的 Agent 可能配置环境不同，并需要使用不同的编码语言。这种差异会给管理和维护带来不便。 + +DevOps 组件支持源代码管理工具，例如 GitHub、Git 和 Bitbucket，支持通过图形编辑面板 (Jenkinsfile out of SCM) 构建 CI/CD 流水线，或者从代码仓库 (Jenkinsfile in SCM) 创建基于 Jenkinsfile 的流水线。 + +== 功能 + +DevOps 组件提供以下功能： + +* 独立的 DevOps 项目，提供访问可控的 CI/CD 流水线。 +* 开箱即用的 DevOps 功能，无需复杂的 Jenkins 配置。 +// * 支持 S2I（Source-to-Image），快速交付镜像。 +* link:../03-how-to-use/02-pipelines/02-create-a-pipeline-using-jenkinsfile/[基于 Jenkinsfile 的流水线]，提供一致的用户体验，支持多个代码仓库。 +* link:../03-how-to-use/02-pipelines/01-create-a-pipeline-using-graphical-editing-panel/[图形编辑面板]，用于创建流水线，学习成本低。 +* 强大的工具集成机制，例如 link:../04-how-to-integrate/01-sonarqube/[SonarQube]，用于代码质量检查。 +* 基于 ArgoCD 的持续交付能力，自动化部署到多集群环境。 + +== DevOps 流水线工作流 + +DevOps CI/CD 流水线基于底层 Kubernetes Jenkins Agent 运行。这些 Jenkins Agent 可以动态扩缩，即根据任务状态进行动态供应或释放。Jenkins Controller 和 Agent 以 Pod 的形式运行在{ks_product_both}节点上。Controller 运行在其中一个节点上，其配置数据存储在一个持久卷声明中。Agent 运行在各个节点上，但可能不会一直处于运行状态，而是根据需求动态创建并自动删除。 + +当 Jenkins Controller 收到构建请求，会根据标签动态创建运行在 Pod 中的 Jenkins Agent 并注册到 Controller 上。当 Agent 运行完任务后，将会被释放，相关的 Pod 也会被删除。 + +== 动态供应 Jenkins Agent + +动态供应 Jenkins Agent 有以下优势： + +**资源分配合理**：动态分配已创建的 Agent 至空闲节点，避免因单个节点资源利用率高而导致任务排队等待。 + +**高可扩缩性**：当集群因资源不足而导致任务长时间排队等待时，支持向集群新增节点。 + +**高可用性**：当 Jenkins Controller 故障时，DevOps 会自动创建一个新的 Jenkins Controller 容器，并将持久卷挂载至新创建的容器，保证数据不会丢失，从而实现集群高可用。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/01-create-a-devops-project.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/01-create-a-devops-project.adoc new file mode 100644 index 000000000..729e570cb --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/01-create-a-devops-project.adoc @@ -0,0 +1,54 @@ +--- +title: "创建 DevOps 项目" +keywords: "Kubernetes, {ks_product}, 企业空间, DevOps 项目, 创建 DevOps 项目" +description: "介绍如何创建 DevOps 项目。" +weight: 01 +--- + +:ks_permission:  **DevOps 项目创建** +:ks_navigation:  **DevOps 项目** + + +本节介绍如何创建 DevOps 项目。 + + +== 前提条件 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + +. 在 **DevOps 项目**页面，点击**创建**。 + +. 在**创建 DevOps 项目**对话框，设置 DevOps 项目的参数，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|DevOps 项目的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母开头并以小写字母或数字结尾，最长 63 个字符。 + +include::../../../../_custom/workspaceManagement/devopsProjects/devopsProject-para-aliasAndDescription.adoc[] + +|集群设置 +|可供 DevOps 项目使用的集群。DevOps 项目中的资源运行在此处选择的集群中。 +|=== + +DevOps 项目创建完成后，您可以邀请用户加入 DevOps 项目并在 DevOps 项目中部署业务。 + +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/02-view-a-devops-project-list.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/02-view-a-devops-project-list.adoc new file mode 100644 index 000000000..aa50a470c --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/02-view-a-devops-project-list.adoc @@ -0,0 +1,74 @@ +--- +title: "查看 DevOps 项目列表" +keywords: "Kubernetes, {ks_product}, 企业空间, DevOps 项目, 查看 DevOps 项目列表" +description: "介绍如何查看 DevOps 项目列表。" +weight: 02 +--- + + +:ks_permission:  **DevOps 项目查看** +:ks_navigation:  **DevOps 项目** + + +本节介绍如何查看 DevOps 项目列表。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +==== +* DevOps 项目列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|DevOps 项目的名称。 + +|状态 +|DevOps 项目当前的状态。 + +* **成功**：DevOps 项目已创建成功并且可用。 + +* **等待中**：DevOps 项目正在创建中。 + +* **删除中**：DevOps 项目正在删除中。 + +|创建者 +|创建 DevOps 项目的用户。 + +|创建时间 +|DevOps 项目的创建时间。 +|=== +-- + +* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的 DevOps 项目。 + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] + +* 在列表中点击一个 DevOps 项目的名称可打开 DevOps 项目管理页面。您可以在 DevOps 项目管理页面查看和管理 DevOps 项目中的资源。 + + +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/03-edit-devops-project-information.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/03-edit-devops-project-information.adoc new file mode 100644 index 000000000..3945c29a4 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/03-edit-devops-project-information.adoc @@ -0,0 +1,51 @@ +--- +title: "编辑 DevOps 项目信息" +keywords: "Kuberentes, {ks_product}, 企业空间管理, DevOps 项目, 编辑 DevOps 项目信息" +description: "介绍如何编辑 DevOps 项目信息。" +weight: 03 +--- + +:ks_permission:  **DevOps 项目管理** +:ks_navigation:  **DevOps 项目** + + +本节介绍如何编辑项目信息。 + +您可以编辑项目的别名和描述。{ks_product_right}不支持编辑已创建 DevOps 项目的名称。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + +* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的 DevOps 项目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置 DevOps 项目的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../_custom/workspaceManagement/devopsProjects/devopsProject-para-aliasAndDescription.adoc[] +|=== +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/04-delete-devops-projects.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/04-delete-devops-projects.adoc new file mode 100644 index 000000000..5af3b4174 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/04-delete-devops-projects.adoc @@ -0,0 +1,63 @@ +--- +title: "删除 DevOps 项目" +keywords: "Kuberentes, {ks_product}, 企业空间管理, DevOps 项目, 删除 DevOps 项目" +description: "介绍如何编辑删除 DevOps 项目。" +weight: 04 +--- + +:ks_permission:  **DevOps 项目管理** +:ks_navigation:  **DevOps 项目** + +本节介绍如何删除 DevOps 项目。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +DevOps 项目删除后不能恢复，同时 DevOps 项目中的所有的资源也将被删除，请谨慎执行此操作。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + + +== 删除单个项目 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要删除的 DevOps 项目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除 DevOps 项目**对话框，输入 DevOps 项目的名称，然后点击**确定**。 + + +== 批量删除项目 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 选择需要删除的 DevOps 项目左侧的复选框，然后在 DevOps 项目列表上方点击**删除**。 + +. 在**批量删除 DevOps 项目**对话框，输入 DevOps 项目的名称，然后点击**确定**。 ++ +-- +include::../../../../_custom/note-separateNamesByComma.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/_index.adoc new file mode 100644 index 000000000..7295edf7e --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/02-devops-projects/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "管理 DevOps 项目" +keywords: "Kubernetes, {ks_product}, 企业空间, DevOps 项目" +description: "介绍如何查看 DevOps 项目信息以及管理 DevOps 项目。" +weight: 02 +--- + + + +本节介绍如何管理 DevOps 项目。 + +DevOps 项目为用户提供了持续集成和持续部署（CI/CD）功能。您可以在 DevOps 项目中将{ks_product_both}与第三方代码仓库对接，然后通过流水线或持续部署使源代码变化自动更新到目标环境中。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/01-devops-project-management.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/01-devops-project-management.adoc new file mode 100644 index 000000000..c2918d1b0 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/01-devops-project-management.adoc @@ -0,0 +1,73 @@ +--- +title: "创建和管理 DevOps 项目" +keywords: "Kubernetes, {ks_product}, DevOps 项目, DevOps 项目管理" +description: "演示如何创建和管理 DevOps 项目。" +weight: 01 +--- + +本节演示如何创建和管理 DevOps 项目。 + +== 前提条件 + +ifeval::["{file_output_type}" == "html"] +* 已创建一个企业空间和一个用户 (**project-admin**)，需要邀请该用户至该企业空间并赋予 **workspace-self-provisioner** 角色。有关更多信息，请参阅link:../../../../02-quickstart/03-control-user-permissions[控制用户权限]。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +* 已创建一个企业空间和一个用户 (**project-admin**)，需要邀请该用户至该企业空间并赋予 **workspace-self-provisioner** 角色。有关更多信息，请参阅《{ks_product_right}快速入门》的“控制用户权限”章节。 +endif::[] + +* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + + + +== 创建 DevOps 项目 + +. 以 **project-admin** 用户登录{ks_product_both} Web 控制台，进入一个企业空间。 + +. 点击 **DevOps 项目**，然后点击**创建**。 + +. 输入 DevOps 项目的基本信息，然后点击**确定**。 ++ +-- +* **名称**：DevOps 项目的简明名称，便于用户识别，例如 **demo-devops**。 + +* **别名**：DevOps 项目的别名。 + +* **描述信息**：DevOps 项目的简要介绍。 + +* **集群设置**：在当前版本中，DevOps 项目无法同时跨多个集群运行。如果有多个集群，则必须选择一个集群来运行 DevOps 项目。 +-- + +. DevOps 项目创建后，会显示在 DevOps 项目页面的列表中。 + + +== 查看 DevOps 项目 + +点击刚刚创建的 DevOps 项目，转到其详情页面。 + +在 DevOps 项目中，用户可以创建 CI/CD 流水线、凭证，以及管理项目成员和角色。根据权限不同，用户在 DevOps 项目中可以执行的操作也不同。 + +* 流水线 ++ +-- +流水线是一系列插件的集合，支持持续地集成、测试和构建代码。流水线将持续集成 (CI) 和持续交付 (CD) 进行结合，提供精简的工作流，使您的代码可以自动交付给任何目标。 +-- + +* 凭证 ++ +-- +具有相应权限的 DevOps 项目用户可以为流水线配置凭证，以便与外部环境进行交互。用户在 DevOps 项目中添加凭证后，DevOps 项目就可以使用这些凭证与第三方应用程序（例如 GitHub、GitLab 和 Docker Hub）进行交互。有关更多信息，请参阅link:../../03-how-to-use/05-devops-settings/01-credential-management/[凭证管理]。 +-- + +* 成员和角色 ++ +-- +与项目相似，DevOps 项目也需要为用户授予角色，以便用户在 DevOps 项目拥有不同的权限。项目管理员（例如 **project-admin**）负责邀请用户并授予他们不同的角色。有关更多信息，请参阅link:../../03-how-to-use/05-devops-settings/02-role-and-member-management/[角色和成员管理]。 +-- + +== 编辑或删除 DevOps 项目 + +. 点击 **DevOps 项目设置**下的**基本信息**，查看当前 DevOps 项目的概述，如项目角色和项目成员的数量、项目名称和项目创建者等。 + +. 点击右侧的**管理**按钮，编辑此 DevOps 项目的基本信息或删除 DevOps 项目。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/01-create-a-pipeline-using-graphical-editing-panel.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/01-create-a-pipeline-using-graphical-editing-panel.adoc new file mode 100644 index 000000000..f5ba434b7 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/01-create-a-pipeline-using-graphical-editing-panel.adoc @@ -0,0 +1,500 @@ +--- +title: "使用图形编辑面板创建流水线" +keywords: "Kubernetes, {ks_product}, DevOps 项目, 使用 DevOps, 流水线, 使用图形编辑面板创建流水线" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 01 +--- + + +DevOps 中的图形编辑面板包含用于 Jenkins link:https://www.jenkins.io/zh/doc/book/pipeline/#阶段[阶段 (Stage)] 和link:https://www.jenkins.io/zh/doc/book/pipeline/#步骤[步骤 (Step)] 的所有必要操作。DevOps 支持直接在交互式面板上定义这些阶段和步骤，无需创建任何 Jenkinsfile。 + +本文档演示如何在{ks_product_both}中使用图形编辑面板创建流水线。在整个过程中，DevOps 将根据编辑面板上的设置自动生成 Jenkinsfile，您无需手动创建 Jenkinsfile。待流水线成功运行，它会将镜像推送至 Docker Hub。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + +* 已有一个 link:http://www.dockerhub.com/[Docker Hub] 账户。 + +* 已创建一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../../05-devops-settings/02-role-and-member-management[角色和成员管理]。 + +* 已设置 CI 专用节点用于运行流水线。请参阅link:../../05-devops-settings/04-set-ci-node/[为缓存依赖项设置 CI 节点]。 + +* 配置电子邮件服务器用于接收流水线通知（可选）。 +请参阅link:../09-jenkins-email/[为流水线设置电子邮件服务器]。 + +* 配置 SonarQube 将代码分析纳入流水线中（可选）。 +请参阅link:../../../04-how-to-integrate/01-sonarqube/[将 SonarQube 集成到流水线]。 + + +== 流水线概述 + +本示例流水线包括以下阶段。 + +[.admon.note,cols="a"] +|=== +|说明 + +| +* **阶段 1：Checkout SCM**：从 GitHub 仓库拉取源代码。 + +* **阶段 2：单元测试**：待该测试通过后才会进行下一阶段。 + +* **阶段 3：代码分析**：配置 SonarQube 用于静态代码分析。 + +* **阶段 4：构建并推送**：构建镜像并附上标签 **snapshot-$BUILD_NUMBER** 推送至 Docker Hub，其中 **$BUILD_NUMBER** 是流水线运行记录列表中的记录的运行 ID。 + +* **阶段 5：制品**：生成一个制品（JAR 文件包）并保存。 + +// * **阶段 6：部署至开发环境**：在开发环境中创建一个部署和一个服务。该阶段需要进行审核，部署成功运行后，会发送电子邮件通知。 +|=== + + +== 步骤 1：创建凭证 + +. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 + +. 点击**企业空间管理**并进入您的 DevOps 项目，在 **DevOps 项目设置**下的**凭证**页面创建以下凭证。有关如何创建凭证的更多信息，请参阅link:../../05-devops-settings/01-credential-management/[凭证管理]。 ++ +-- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +如果您的账户或密码中包含任何特殊字符，例如 **@** 和 **$**，可能会因为无法识别而在流水线运行时导致错误。在这种情况下，请先在一些第三方网站（例如 link:https://www.urlencoder.org/[urlencoder]）上对账户或密码进行编码，然后将输出结果复制粘贴作为您的凭证信息。 + +|=== + +[%header,cols="1a,2a,2a"] +|=== +|凭证 ID |类型 |用途 + +|dockerhub-id +|用户名和密码 +|Docker Hub + +// |demo-kubeconfig +// |kubeconfig +// |Kubernetes +|=== +-- + +. 再为 SonarQube 创建一个凭证 (**sonar-token**)，用于上述的阶段 3（代码分析）。凭证类型选择**访问令牌**，在**令牌**字段输入 SonarQube 令牌，请参阅link:../../../04-how-to-integrate/01-sonarqube/[为新项目创建 SonarQube 令牌 (Token)]。点击**确定**完成操作。 + +. 创建完成后，您将在凭证页面看到已创建的凭证。 + +// == 步骤 2：创建项目 + +// 本示例中，流水线会将 link:https://github.com/kubesphere/devops-maven-sample/tree/sonarqube[sample] 应用部署至一个项目。因此，需要创建一个项目（例如 **kubesphere-sample-dev**）。待流水线成功运行，将在该项目中自动创建该应用的部署和服务。 + +// . 使用 **project-admin** 账户创建项目，该用户也将是 CI/CD 流水线的审核员。 + +// . 邀请 **project-regular** 账户至该项目，并授予 **operator** 角色。 + + +== 步骤 2：创建流水线 + +. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 + +. 点击**企业空间管理**并进入您的 DevOps 项目，在**流水线**页面点击**创建**。 + +. 在弹出的对话框中，将其命名为 **graphical-pipeline**，点击**下一步**。 + +. 在**高级设置**页面，点击**添加**，添加以下字符串参数。这些参数将用于流水线的 Docker 命令。添加完成后，点击**创建**。 ++ +-- +[%header,cols="1a,2a,2a,2a"] +|=== +|参数类型 |名称 |值 |参数说明 + +|字符串 +|REGISTRY +|`docker.io` +|镜像仓库地址。本示例使用 **docker.io**。 + +|字符串 +|DOCKERHUB_NAMESPACE +|您的 Docker ID +|您的 Docker Hub 账户或该账户下的组织名称。 + +|字符串 +|APP_NAME +|`devops-sample` +|应用名称。本示例使用 **devops-sample**。 +|=== + +// note +[.admon.note,cols="a"] +|=== +|说明 + +| +有关其他字段，请直接使用默认值或者参阅link:../05-pipeline-settings/[流水线设置]以自定义配置。 +|=== +-- + +== 步骤 3：编辑流水线 + +. 点击流水线名称进入其详情页面。 + +. 要使用图形编辑面板，点击**流水线配置**页签下的**编辑流水线**。在弹出的对话框中： + +* 点击**自定义流水线**，按照以下步骤设置各个阶段。 + +* 或使用 DevOps 提供的link:../03-use-pipeline-templates/[内置流水线模板]。 + +. 点击**下一步**，然后点击**创建**。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +流水线详情页面的**同步状态**，显示了{ks_product_both}和 Jenkins 之间的同步结果。也可点击**编辑 Jenkinsfile** 手动为流水线创建一个 Jenkinsfile。 + +|=== + +=== 阶段 1：拉取源代码 (Checkout SCM) + +图形编辑面板包括两个区域：左侧的**画布**和右侧的**内容**。它会根据您对不同阶段和步骤的配置自动生成一个 Jenkinsfile，为开发者提供更加用户友好的操作体验。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +流水线包括link:https://www.jenkins.io/zh/doc/book/pipeline/syntax/#声明式流水线[声明式流水线]和link:https://www.jenkins.io/zh/doc/book/pipeline/syntax/#脚本化流水线[脚本化流水线]。目前，支持使用该面板创建声明式流水线。有关流水线语法的更多信息，请参阅 link:https://www.jenkins.io/zh/doc/book/pipeline/syntax/[Jenkins 文档]。 + +|=== + +. 在图形编辑面板上，从**类型**下拉列表中选择 **node**，从 **Label** 下拉列表中选择 **maven**。 ++ +-- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +**Agent** 用于定义执行环境。**Agent** 指令指定 Jenkins 执行流水线的位置和方式。有关更多信息，请参阅link:../10-choose-jenkins-agent/[选择 Jenkins Agent]。 + +|=== + +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/graphical_panel.png[,100%] +-- + +. 点击左侧的加号图标来添加阶段。点击**添加步骤**上方的文本框，然后在右侧的**名称**字段中为该阶段设置名称（例如 **Checkout SCM**）。 ++ +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/edit_panel.png[,100%] + +. 点击**添加步骤**。在列表中选择 **Git Clone**，以从 GitHub 拉取示例代码。在弹出的对话框中，填写必需的字段。点击**确定**完成操作。 ++ +-- +* **URL**：输入 GitHub 仓库地址 link:https://github.com/kubesphere/devops-maven-sample.git[]。注意，这里是示例地址，请使用自己的仓库地址。 + +* **凭证 ID**：本示例中无需输入凭证 ID。 + +* **分支**：输入 **v4.1.0-sonarqube**。如果不需要代码分析阶段，则使用默认的 v4.1.0 分支。 + +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/enter_repo_url.png[,100%] +-- + +=== 阶段 2：单元测试 + +. 点击阶段 1 右侧的加号图标添加新的阶段，以在容器中执行单元测试。将它命名为 **Unit Test**。 ++ +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/unit_test.png[,100%] + +. 点击**添加步骤**，在列表中选择**指定容器**。将其命名为 **maven** 然后点击**确定**。 ++ +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/container_maven.png[,100%] + +. 点击 **maven** 容器步骤下的**添加嵌套步骤**，在列表中选择 **shell** 并输入以下命令。点击**确定**保存操作。 ++ +-- +[,bash] +---- +mvn clean test +---- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +在图形编辑面板上，可指定在给定阶段指令中执行的一系列link:https://www.jenkins.io/zh/doc/book/pipeline/syntax/#steps[步骤]。 +|=== +-- + +=== 阶段 3：代码分析（可选） + +本阶段使用 SonarQube 用于测试代码。如果不需要代码分析，可以跳过该阶段。 + +. 点击 **Unit Test** 阶段右侧的加号图标添加一个阶段，以在容器中进行 SonarQube 代码分析。将它命名为 **Code Analysis**。 ++ +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/code_analysis_stage.png[,100%] + +. 在 **Code Analysis** 中，点击**添加步骤**，选择**指定容器**。将其命名为 **maven** 然后点击**确定**。 ++ +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/maven_container.png[,100%] + +. 点击 **maven** 容器步骤下的**添加嵌套步骤**，以添加一个嵌套步骤。点击**添加凭证**并从**凭证 ID** 列表中选择 SonarQube 令牌 (**sonar-token**)。在**文本变量**中输入 **SONAR_TOKEN**，然后点击**确定**。 ++ +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonarqube_credentials.png[,100%] + +. 在**添加凭证**步骤下，点击**添加嵌套步骤**为其添加一个嵌套步骤。 ++ +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/nested_step.png[,100%] + +. 点击 **Sonarqube 配置**，在弹出的对话框中保持默认名称 **sonar** 不变，点击**确定**保存操作。 ++ +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonar_env.png[,100%] + +. 在 **Sonarqube 配置**步骤下，点击**添加嵌套步骤**为其添加一个嵌套步骤。 ++ +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/add_nested_step.png[,100%] + +. 点击 **shell** 并在命令行中输入以下命令，用于 sonarqube 认证和分析，点击**确定**完成操作。 ++ +-- +[,bash] +---- +mvn sonar:sonar -Dsonar.login=$SONAR_TOKEN +---- +-- + +. 点击**指定容器**步骤下的**添加嵌套步骤**（第三个），选择**超时**。在时间中输入 **1** 并将单位选择为**小时**，点击**确定**完成操作。 ++ +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/add_nested_step_2.png[,100%] ++ +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/timeout_set.png[,100%] + +. 点击**超时**步骤下的**添加嵌套步骤**，选择**代码质量检查 (SonarQube)**。在弹出的对话框中选择**检查通过后开始后续任务**。点击**确定**保存操作。 ++ +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/waitforqualitygate_set.png[,100%] ++ +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonar_ready.png[,100%] + + +=== 阶段 4：构建并推送镜像 + +. 点击前一个阶段右侧的加号图标添加一个新的阶段，以构建并推送镜像至 Docker Hub。将其命名为 **Build and Push**。 + +. 在 **Build and Push** 中，点击**添加步骤**，选择**指定容器**，将其命名为 **maven**，然后点击**确定**。 + +. 点击 **maven** 容器步骤下的**添加嵌套步骤**，在列表中选择 **shell** 并在弹出窗口中输入以下命令，点击**确定**完成操作。 ++ +-- +[,bash] +---- +mvn -Dmaven.test.skip=true clean package +---- +-- + +. 再次点击**添加嵌套步骤**，选择 **shell**。在命令行中输入以下命令，以根据 link:https://github.com/kubesphere/devops-maven-sample/blob/sonarqube/Dockerfile-online[Dockerfile] 构建 Docker 镜像。点击**确定**确认操作。 ++ +-- +[,bash] +---- +docker build -f Dockerfile-online -t $REGISTRY/$DOCKERHUB_NAMESPACE/$APP_NAME:SNAPSHOT-$BUILD_NUMBER . +---- +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/shell_command.png[,100%] +-- + +. 再次点击**添加嵌套步骤**，选择**添加凭证**。在弹出的对话框中填写以下字段，点击**确定**确认操作。 ++ +-- +* **凭证名称**：选择您创建的 Docker Hub 凭证，例如 **dockerhub-id**。 +* **用户名变量**：输入 **DOCKER_USERNAME**。 +* **密码变量**：输入 **DOCKER_PASSWORD**。 + +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/docker_credential.png[,100%] + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +出于安全原因，账户信息在脚本中显示为变量。 + +|=== +-- + +. 在**添加凭证**步骤中点击**添加嵌套步骤**（第一个）。选择 **shell** 并在弹出窗口中输入以下命令，用于登录 Docker Hub。点击**确定**确认操作。 ++ +-- +[,bash] +---- +echo "$DOCKER_PASSWORD"|docker login $REGISTRY -u "$DOCKER_USERNAME" --password-stdin +---- + +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/login_docker_command.png[,100%] +-- + +. 在**添加凭证**步骤中点击**添加嵌套步骤**。选择 **shell** 并输入以下命令，将 SNAPSHOT 镜像推送至 Docker Hub。点击**确定**完成操作。 ++ +-- +[,bash] +---- +docker push $REGISTRY/$DOCKERHUB_NAMESPACE/$APP_NAME:SNAPSHOT-$BUILD_NUMBER +---- +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/push_to_docker.png[,100%] +-- + +=== 阶段 5：生成制品 + +. 点击 **Build and Push** 阶段右侧的加号图标添加一个新的阶段，以保存制品，将其命名为 **Artifacts**。本示例使用 JAR 文件包。 ++ +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/add_artifact_stage.png[,100%] + +. 选中 **Artifacts** 阶段，点击**添加步骤**，选择**保存制品**。在弹出的对话框中输入 **target/*.jar**，将其设置为 Jenkins 中制品的保存路径。点击**确定**完成操作。 ++ +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/artifact_info.png[,100%] + +// === 阶段 6：部署至开发环境 + +// . 点击 **Artifacts** 阶段右侧的加号图标添加最后一个阶段，将其命名为 **Deploy to Dev**。该阶段用于将资源部署至您的开发环境（即 **kubesphere-sample-dev** 项目）。 +// + +// image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/deploy_to_dev.png[,100%] + +// . 点击 **Deploy to Dev** 阶段下的**添加步骤**，在列表中选择**审核**，然后在**消息**字段中填入 **@project-admin**，即 **project-admin** 账户在流水线运行到该阶段时会进行审核。点击**确定**保存操作。 +// + +// -- +// image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/input_message.png[,100%] +// //note +// [.admon.note,cols="a"] +// |=== +// |说明 + +// | +// 在{ks_product_both}中，能够运行流水线的账户也能够继续或终止该流水线。 + +// 此外，流水线创建者、拥有该项目管理员角色的用户或者您指定的账户也有权限继续或终止流水线。 + +// |=== +// -- + +// . 再次点击 **Deploy to Dev** 阶段下的**添加步骤**。在列表中选择**指定容器**，将其命名为 **maven**，然后点击**确定**。 + +// . 点击 **maven** 容器步骤下的**添加嵌套步骤**。在列表中选择**添加凭证**，在弹出的对话框中填写以下字段，然后点击**确定**。 +// + +// -- +// * 凭证名称：选择您创建的 kubeconfig 凭证，例如 **demo-kubeconfig**。 + +// * kubeconfig 变量：输入 **KUBECONFIG_CONTENT**。 +// -- + +// . 点击**添加凭证**步骤下的**添加嵌套步骤**。在列表中选择 **shell**，在弹出的对话框中输入以下命令，然后点击**确定**。 +// + +// -- +// [,bash] +// ---- +// mkdir ~/.kube +// echo "$KUBECONFIG_CONTENT" > ~/.kube/config +// envsubst < deploy/no-branch-dev/devops-sample-svc.yaml | kubectl apply -f - +// envsubst < deploy/no-branch-dev/devops-sample.yaml | kubectl apply -f - +// ---- +// -- + +// . 如果想在流水线运行成功时接收电子邮件通知，请点击**添加步骤**，选择**邮件**，以添加电子邮件信息。注意，配置电子邮件服务器是可选操作，如果跳过该步骤，依然可以运行流水线。 +// + +// -- +// //note +// [.admon.note,cols="a"] +// |=== +// |说明 + +// | +// 有关配置电子邮件服务器的更多信息，请参阅link:../09-jenkins-email/[为{ks_product_both}流水线设置电子邮件服务器]。 + +// |=== +// -- + +// . 待完成上述步骤，在右下角点击**确定**，结束编辑流水线。该流水线将展示完整的工作流，并且清晰列示每个阶段。 +// + +// -- +// 在用图形编辑面板定义流水线时，DevOps 会自动创建相应的 Jenkinsfile。点击**编辑 Jenkinsfile** 查看该 Jenkinsfile。 + +// //note +// [.admon.note,cols="a"] +// |=== +// |说明 + +// | +// 在**流水线**列表页面，点击该流水线右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**复制**来创建该流水线的副本。 +// |=== +// -- + +== 步骤 4：运行流水线 + +. 使用图形编辑面板创建的流水线需要手动运行。点击**运行**，弹出的对话框会显示link:#_步骤_2创建流水线[步骤 2：创建流水线]中已定义的三个字符串参数。点击**确定**来运行流水线。 +// . 使用图形编辑面板创建的流水线需要手动运行。点击**运行**，弹出的对话框会显示link:#_步骤_3创建流水线[步骤 3：创建流水线]中已定义的三个字符串参数。点击**确定**来运行流水线。 ++ +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/run_pipeline.png[,100%] + +. 点击**运行记录**页签，查看流水线的运行状态，点击记录查看详情。 + +. 流水线如果运行到 **Push with Tag** 阶段，会在此阶段暂停，需要具有审核权限的用户点击**继续**。 +// . 稍等片刻，流水线如果运行成功，会在 **Deploy to Dev** 阶段停止。**project-admin** 作为流水线的审核员，需要进行审批，然后资源才会部署至开发环境。 + +. 以 **project-admin** 用户登录{ks_product_both} Web 控制台，点击**企业空间管理**并进入您的 DevOps 项目，点击 **graphical-pipeline** 流水线。在**运行记录**页签下，点击要审核的记录，点击**继续**以批准流水线。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +如果要同时运行多个不包含多分支的流水线，在**流水线**列表页面，全部选中这些流水线，然后点击**运行**来批量运行它们。 +|=== + +== 步骤 5：查看流水线详情 + +. 以 **project-regular** 用户登录 {ks_product_both} Web 控制台，点击**企业空间管理**并进入您的 DevOps 项目，点击 **graphical-pipeline** 流水线。 + +. 在**运行记录**页签下，点击**状态**下的记录，进入**运行记录**详情页。如果任务状态为**成功**，流水线所有阶段都会显示**成功**。 + +. 在**运行日志**页签下，点击每个阶段查看其详细日志。点击**查看完整日志**，根据日志排除故障和问题，也可以将日志下载到本地进行进一步分析。 + +== 步骤 6：下载制品 + +在**运行记录**详情页，点击**制品**页签，然后点击制品右侧的图标下载该制品。 + +== 步骤 7：查看代码分析结果 + +在**代码检查**页面，查看由 SonarQube 提供的本示例流水线的代码分析结果。如果没有事先配置 SonarQube，则该部分不可用。有关更多信息，请参阅link:../../../04-how-to-integrate/01-sonarqube/[将 SonarQube 集成到流水线]。 + +== 步骤 8：验证 Kubernetes 资源 + +如果流水线的每个阶段都成功运行，则会自动构建一个 Docker 镜像并推送至您的 Docker Hub 仓库。 +// 如果流水线的每个阶段都成功运行，则会自动构建一个 Docker 镜像并推送至您的 Docker Hub 仓库。最终，流水线会在您事先设置的项目中自动创建一个部署和一个服务。 + +// . 进入项目（本示例中即 **kubesphere-sample-dev**），点击**应用负载**下的**工作负载**，查看流水线自动创建的部署。 + +// . 点击**应用负载**下的**服务**，查看示例服务通过 NodePort 暴露的端口号。使用 **:** 访问该服务。 +// + +// -- +// //note +// [.admon.note,cols="a"] +// |=== +// |说明 + +// | +// 访问服务前，您可能需要配置端口转发规则并在安全组中放行该端口。 + +// |=== +// -- + +. 流水线成功运行后，会推送一个镜像至 Docker Hub。登录 Docker Hub 查看结果。 ++ +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/dockerhub_image.png[,100%] + +. 该应用名称为 **APP_NAME** 的值，本示例中即 **devops-sample**。Tag 为 **SNAPSHOT-$BUILD_NUMBER** 的值，**$BUILD_NUMBER** 即**运行记录**页签下记录的**运行 ID**。 + +// . 如果您在link:#_阶段_6部署至开发环境[阶段 6：部署至开发环境]配置了电子邮件服务器并添加了电子邮件信息，运行完成后还会收到邮件通知。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/02-create-a-pipeline-using-jenkinsfile.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/02-create-a-pipeline-using-jenkinsfile.adoc new file mode 100644 index 000000000..0f398e8a9 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/02-create-a-pipeline-using-jenkinsfile.adoc @@ -0,0 +1,455 @@ +--- +title: "使用 Jenkinsfile 创建流水线" +keywords: "Kubernetes, {ks_product}, DevOps 项目, 使用 DevOps, 流水线, 使用 Jenkinsfile 创建流水线" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 02 +--- + +Jenkinsfile 是一个文本文件，包含 Jenkins 流水线的定义，并被检入源代码控制仓库。Jenkinsfile 将整个工作流存储为代码，因此它是代码审查和流水线迭代过程的基础。有关更多信息，请参阅 link:https://www.jenkins.io/zh/doc/book/pipeline/jenkinsfile/[Jenkins 官方文档]。 + +本文档演示如何基于 GitHub 仓库中的 Jenkinsfile 创建流水线。 +// 本文档演示如何基于 GitHub 仓库中的 Jenkinsfile 创建流水线，并使用该流水线将示例应用程序分别部署到可从外部访问的开发环境和生产环境。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +DevOps 支持创建两种类型的流水线：一种是本文档中介绍的基于 SCM 中 Jenkinsfile 创建的流水线，另一种是link:../01-create-a-pipeline-using-graphical-editing-panel/[通过图形编辑面板创建的流水线]。 + +Jenkinsfile in SCM 需要源代码管理 (SCM) 中有内置 Jenkinsfile，换句话说，Jenkinsfile 必须是 SCM 的一部分。DevOps 系统会根据代码仓库的现有 Jenkinsfile 自动构建 CI/CD 流水线。通过定义工作流，例如 **stage** 和 **step** 可以满足特定的构建、测试和部署要求。 + +|=== + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + +* 已有一个 link:https://hub.docker.com/[Docker Hub] 账户和一个 link:https://github.com/[GitHub] 账户。 + +* 已创建一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../../05-devops-settings/02-role-and-member-management[角色和成员管理]。 + +* 已设置 CI 专用节点用于运行流水线。请参阅link:../../05-devops-settings/04-set-ci-node/[为依赖项缓存设置 CI 节点]。 + +* 已安装和配置 SonarQube（可选）。请参阅link:../../../04-how-to-integrate/01-sonarqube/[将 SonarQube 集成到流水线]。如果跳过这一部分，则没有下面的 **SonarQube 分析**阶段。 + +== 流水线概述 + +本示例流水线包括以下阶段。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +* **阶段 1：Checkout SCM**：从 GitHub 仓库检出源代码。 + +* **阶段 2：单元测试**：待该测试通过后才会进行下一阶段。 + +* **阶段 3：SonarQube 分析**：SonarQube 代码质量分析。 + +* **阶段 4：构建并推送快照镜像**：根据**策略设置**中选定的分支来构建镜像，并将 **SNAPSHOT-$BRANCH_NAME-$BUILD_NUMBER** 标签推送至 Docker Hub，其中 **$BUILD_NUMBER** 是流水线运行记录列表中的记录的运行 ID。 + +* **阶段 5：推送最新镜像**：将 v4.1.0-sonarqube 分支标记为 **latest**，并推送至 Docker Hub。 + +// * **阶段 6：部署至开发环境**：将 v4.1.0-sonarqube 分支部署到开发环境，此阶段需要审核。 + +* **阶段 6：带标签推送**：生成标签并发布到 GitHub，该标签会推送到 Docker Hub。 + +// * **阶段 8：部署至生产环境**：将已发布的标签部署到生产环境。 + +|=== + +== 步骤 1：创建凭证 + +. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 + +. 点击**企业空间管理**并进入您的 DevOps 项目，在 **DevOps 项目设置**下的**凭证**页面创建以下凭证。有关如何创建凭证的更多信息，请参阅link:../../05-devops-settings/01-credential-management/[凭证管理]。 ++ +-- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +如果您的账户或密码中包含任何特殊字符，例如 **@** 和 **$**，可能会因为无法识别而在流水线运行时导致错误。在这种情况下，请先在一些第三方网站（例如 link:https://www.urlencoder.org/[urlencoder]）上对账户或密码进行编码，然后将输出结果复制粘贴作为您的凭证信息。 +|=== + +[%header,cols="1a,2a,2a"] +|=== +|凭证 ID |类型 |用途 + +|dockerhub-id +|用户名和密码 +|Docker Hub + +|github-id +|用户名和密码 +|GitHub + +// |demo-kubeconfig +// |kubeconfig +// |Kubernetes +|=== +-- + +. 再为 SonarQube 创建一个凭证 (**sonar-token**)，用于上述的阶段 3（代码分析）。凭证类型选择**访问令牌**，在**令牌**字段输入 SonarQube 令牌，请参阅link:../../../04-how-to-integrate/01-sonarqube/[为新项目创建 SonarQube 令牌 (Token)]。点击**确定**完成操作。 + +. 还需要创建具有如下图所示权限的 GitHub 个人访问令牌 (PAT)，然后在 DevOps 项目中，使用生成的令牌创建用于 GitHub 认证的账户凭证（例如，**github-token**）。 ++ +-- +image:/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-a-jenkinsfile/github-token-scope.png[,100%] +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +如需创建 GitHub 个人访问令牌，请转到您 GitHub 账户的 **Settings**，点击 **Developer settings**，选择 **Personal access tokens**，然后点击 **Generate new token**。 + +|=== +-- + +. 您将在凭证页面看到已创建的凭证。 + + +== 步骤 2：在 GitHub 仓库中修改 Jenkinsfile + +. 登录 GitHub 并 Fork GitHub 仓库 link:https://github.com/kubesphere/devops-maven-sample[devops-maven-sample] 的所有分支至您的 GitHub 个人账户。 + +. 在您自己的 GitHub 仓库 **devops-maven-sample** 中，切换到 v4.1.0-sonarqube 分支，点击根目录中的文件 **Jenkinsfile-online**。 + +. 点击右侧的编辑图标，编辑环境变量。 ++ +-- +[%header,cols="1a,2a,2a"] +|=== +|条目 |值 |描述信息 + +|DOCKER_CREDENTIAL_ID +|dockerhub-id +|您在{ks_product_both}中为 Docker Hub 账户设置的**名称**。 + +|GITHUB_CREDENTIAL_ID +|github-id +|您在{ks_product_both}中为 GitHub 账户设置的**名称**，用于将标签推送至您的 GitHub 仓库。 + +// |KUBECONFIG_CREDENTIAL_ID +// |demo-kubeconfig +// |您在{ks_product_both}中为 kubeconfig 设置的**名称**，用于访问运行中的 Kubernetes 集群。 + +|REGISTRY +|docker.io +|默认为 **docker.io**，用作推送镜像的地址。 + +|DOCKERHUB_NAMESPACE +|your-dockerhub-id +|请替换为您的 Docker Hub 账户名，也可以替换为该账户下的 Organization 名称。 + +|GITHUB_ACCOUNT +|your-github-id +|请替换为您的 GitHub 账户名。例如，如果您的 GitHub 地址是 link:https://github.com/kubesphere/[]，则您的 GitHub 账户名为 **kubesphere**，也可以替换为该账户下的 Organization 名称。 + +|APP_NAME +|devops-maven-sample +|应用名称。 + +|SONAR_CREDENTIAL_ID +|sonar-token +|您在{ks_product_both}中为 SonarQube 令牌设置的**名称**，用于代码质量检测。 +|=== + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +Jenkinsfile 中 **mvn** 命令的参数 **-o** 表示开启离线模式。本教程中已下载相关依赖项，以节省时间并适应某些环境中的网络干扰。离线模式默认开启。 + +|=== +-- + +. 编辑环境变量后，点击 **Commit changes**，更新 v4.1.0-sonarqube 分支中的文件。 + + +// == 步骤 3：创建项目 + +// 创建两个项目，例如 **kubesphere-sample-dev** 和 **kubesphere-sample-prod**，分别代表开发环境和生产环境。待流水线成功运行，将在这两个项目中自动创建应用程序的相关部署 (Deployment) 和服务 (Service)。 + +// //note +// [.admon.note,cols="a"] +// |=== +// |说明 + +// | +// 您需要提前创建 **project-admin** 账户，用作 CI/CD 流水线的审核者。 + +// |=== + +// . 以 **project-admin** 用户登录{ks_product_left}，在创建 DevOps 项目的企业空间中创建以下两个项目。 +// + +// -- +// [%header,cols="1a,1a"] +// |=== +// |项目名称|别名 + +// |kubesphere-sample-dev +// |development environment + +// |kubesphere-sample-prod +// |production environment +// |=== +// -- + +// . 邀请 **project-regular** 账户至这两个项目，并赋予 **operator** 角色。 + +== 步骤 3：创建流水线 + +. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 + +. 点击**企业空间管理**并进入您的 DevOps 项目，在**流水线**页面点击**创建**。 + +. 在弹出的对话框中，将其命名为 **jenkinsfile-in-scm**。 + +. 在**流水线类别**下，选择**多分支流水线**。 + +. 在**代码仓库**下，选择一个代码仓库，点击**下一步**继续。 ++ +-- +若没有可用的代码仓库，点击下方的**创建代码仓库**。有关更多信息，请参阅link:../../04-import-code-repositories/[导入代码仓库]。 +-- + +.. 在**导入代码仓库**对话框，输入代码仓库名称（自定义），点击选择代码仓库。 + +.. 在 **GitHub** 页签，从**凭证**的下拉菜单中选择 **github-token**，然后点击**确定**。 + +.. 在 GitHub 列表中，选择您的 GitHub 账户，与该令牌相关的所有仓库将在右侧列出。选择 **devops-maven-sample** 并点击**选择**。 + +.. 点击**确定**选择您的代码仓库。 + + +. 在**高级设置**中，勾选**删除旧分支**。本教程中，建议**分支保留天数（天）**和**分支最大数量**使用默认值。 ++ +-- +删除旧分支意味着您将一并丢弃分支记录。分支记录包括控制台输出、已归档制品以及特定分支相关的其他元数据。更少的分支意味着您可以节省 Jenkins 正在使用的磁盘空间。DevOps 提供两个选项来确定何时丢弃旧分支： + +* 分支保留天数（天）：超过保留期限的分支将被删除。 + +* 分支最大数量：分支数量超过最大数量时，删除最旧的分支。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +**分支保留天数（天）**和**分支最大数量**可以同时应用于分支。只要某个分支满足其中一个字段所设置的条件，则会删除该分支。例如，如果您将保留天数和最大分支数分别指定为 2 和 3，待某个分支的保留天数超过 2 或者分支保留数量超过 3，则会删除该分支。DevOps 默认用 7 和 5 预填充这两个字段。 + +|=== +-- + +. 在**策略设置**中，DevOps 默认提供四种策略。本示例不会使用**从 Fork 仓库中发现 PR** 这条策略，因此您可以删除该策略。对于其他策略，无需修改设置，直接使用默认值即可。 ++ +-- +Jenkins 流水线运行时，开发者提交的 Pull Request (PR) 也将被视为一个单独的分支。 + +**发现分支** + +* **排除已提交 PR 的分支**：不扫描源分支，例如源仓库的 master 分支。需要合并这些分支。 +* **只包括已提交 PR 的分支**：仅扫描 PR 分支。 +* **包括所有分支**：拉取源仓库中的所有分支。 + +**从原仓库发现 PR** + +* **拉取 PR 合并后的代码**：PR 合并到目标分支后，基于源代码创建并运行流水线。 +* **拉取 PR 提交时的代码**：根据 PR 本身的源代码创建并运行流水线。 +* **分别创建两个流水线**：创建两个流水线，一个流水线使用 PR 与目标分支合并后的源代码版本，另一个使用 PR 本身的源代码版本。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +选择 GitHub 作为代码仓库，才能启用此处的**策略设置**设置。 + +|=== +-- + +. 向下滚动到**脚本路径**，将其更改为 **Jenkinsfile-online**，这是示例仓库中位于根目录下的 Jenkinsfile 的文件名。该字段指定代码仓库中的 Jenkinsfile 路径。它表示仓库的根目录。如果文件位置变更，则脚本路径也需要更改。 + +. 在**扫描触发器**中，勾选**定时扫描**并设置时间间隔为 **5 分钟**。点击**创建**完成配置。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +设置特定的时间间隔让流水线扫描远程仓库，以便根据您在**策略设置**中设置的策略来检测代码更新或新的 PR。 + +|=== + + +== 步骤 4：运行流水线 + +. 流水线创建后，会展示在列表中。点击流水线名称查看其详情页。 ++ +-- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +* 在**流水线**列表页面，点击该流水线右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**复制**来创建该流水线的副本。 +* 如果要同时运行多个不包含多分支的流水线，在**流水线**列表页面，全部选中这些流水线，然后点击**运行**来批量运行它们。 +* 流水线详情页面的**同步状态**，显示了{ks_product_both}和 Jenkins 之间的同步结果。若同步成功，将显示**成功**以及绿色的对号图标。 + +|=== +-- + +. 在**运行记录**页签下，正在扫描多个分支。点击右侧的**运行**，流水线将根据您设置的行为策略来运行。从下拉列表中选择 **v4.1.0-sonarqube** 分支，然后添加标签号，例如 **v0.0.2**。点击**确定**开始运行。 ++ +-- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +* 如果您在此页面上未看到任何运行记录，则需要手动刷新浏览器或点击**更多操作**按钮中的**扫描仓库**。 +* 标签名称用于在 GitHub 和 Docker Hub 中指代新生成的发布版本和镜像。现有标签名称不能再次用于字段 **TAG_NAME**。否则，流水线将无法成功运行。 + +|=== +-- + +. 稍等片刻，点击运行记录查看详情。 ++ +-- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +运行失败可能由不同因素所引起。本示例中，在上述步骤中编辑分支的环境变量时，仅更改了 v4.1.0-sonarqube 分支的 Jenkinsfile。而 v4.1.0 分支中的这些变量没有修改（使用了错误的 GitHub 和 Docker Hub 账户），从而导致失败。其他原因如网络问题、Jenkinsfile 中的编码不正确等也可能导致运行失败。 + +在运行记录详情页的**运行日志**页签下，查看其日志的详细信息，根据日志排除故障和问题。 +|=== +-- + +. 流水线如果运行到 **Push with Tag** 阶段，会在此阶段暂停，需要具有审核权限的用户点击**继续**。 +// . 流水线如果运行成功，会在 **deploy to dev** 阶段暂停，需要具有审核权限的用户点击**继续**。 ++ +-- +// 在 Jenkinsfile 中定义了三个阶段 **deploy to dev**、**push with tag** 和 **deploy to production**，每个阶段都需要审核。因此在运行到这些阶段时，流水线会暂停，等待审核。 + +在开发或生产环境中，可能需要具有更高权限的人员（例如版本管理员）来审核流水线、镜像以及代码分析结果。他们有权决定流水线是否能进入下一阶段。在 Jenkinsfile 中，支持使用 **input** 来指定审核流水线的用户。如果想指定一个用户（例如 **project-admin**）来审核，可以在 Jenkinsfile 中添加一个字段。如果有多个用户，则需要通过逗号进行分隔，如下所示： + +[,bash] +---- +input(id: 'release-image-with-tag', message: 'release image with tag?', submitter: 'project-admin,project-admin1') +---- +-- + +. 以具有流水线审核权限的用户登录{ks_product_both} Web 控制台，点击**企业空间管理**并进入您的 DevOps 项目，点击流水线名称进入详情页。在**运行记录**页签下，点击要审核的记录，点击**继续**以批准流水线。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +在{ks_product_both}中，如果不指定审核员，那么能够运行流水线的账户也能够继续或终止该流水线。此外，流水线创建者、拥有该项目管理员角色的用户或者您指定的账户也有权限继续或终止流水线。 +|=== + +== 步骤 5：检查流水线状态 + +. 在运行记录的**流水线**页签下，查看流水线的运行状态。流水线在刚创建时会初始化几分钟。示例流水线有八个阶段，它们已在 link:https://github.com/kubesphere/devops-maven-sample/blob/sonarqube/Jenkinsfile-online[Jenkinsfile-online] 中单独定义。 + +. 点击**运行日志**页签查看流水线运行日志。点击每个阶段查看其详细日志。点击**查看完整日志**，根据日志排除故障和问题，也可以将日志下载到本地进行进一步分析。 + +== 步骤 6：验证结果 + +. 流水线成功运行后，点击**代码检查**通过 SonarQube 查看结果。 + +. 按照 Jenkinsfile 中的定义，通过流水线构建的 Docker 镜像也已成功推送到 Docker Hub。在 Docker Hub 中，您会看到带有标签 **v0.0.2** 的镜像，该标签在流水线运行之前已指定。 + +. 同时，GitHub 中会生成一个新标签和一个新发布版本。 + +// . 示例应用程序将部署到 **kubesphere-sample-dev** 和 **kubesphere-sample-prod**，并创建相应的部署和服务。转到这两个项目，预期结果如下所示： +// + +// -- +// [%header,cols="1a,2a,2a,2a,2a"] +// |=== +// |环境 |URL |命名空间 |部署 |服务 + +// |开发环境 +// |http://{$NodeIP}:{$30861} +// |kubesphere-sample-dev +// |ks-sample-dev +// |ks-sample-dev + +// |生产环境 +// |http://{$NodeIP}:{$30961} +// |kubesphere-sample-prod +// |ks-sample +// |ks-sample +// |=== + +// //note +// [.admon.note,cols="a"] +// |=== +// |说明 + +// | +// 您可能需要在您的安全组中放行该端口，以便通过 URL 访问应用程序。 + +// |=== +// -- + +// == 步骤 7：访问示例服务 + +// . 以 **platform-admin** 用户登录{ks_product_both} Web 控制台。 + +// . 进入 **kubesphere-sample-dev** 项目，在**应用负载**下的**服务**中点击 **ks-sample-dev**。在详情页获取 Endpoint 用于访问该服务。 + +// . 在右下角的**工具箱**中使用 **kubectl** 执行如下命令： +// + +// [,bash] +// ---- +// curl 10.233.120.230:8080 +// ---- + + +// . 预期输出: +// + +// -- +// [,bash] +// ---- +// Really appreciate your star, that's the power of our life. +// ---- +// //note +// [.admon.note,cols="a"] +// |=== +// |说明 + +// | +// 使用 **curl** 访问 Endpoint，或者访问 {$Virtual IP}:{$Port} 或 {$Node IP}:{$NodePort}。 + +// |=== +// -- + +// . 也可以在项目 **kubesphere-sample-prod** 中测试服务，您将看到相同的输出结果。 +// + +// [,bash] +// ---- +// $ curl 10.233.120.236:8080 +// Really appreciate your star, that's the power of our life. +// ---- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/03-use-pipeline-templates.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/03-use-pipeline-templates.adoc new file mode 100644 index 000000000..c1f377b26 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/03-use-pipeline-templates.adoc @@ -0,0 +1,123 @@ +--- +title: "使用流水线模板创建流水线" +keywords: "Kubernetes, {ks_product}, DevOps 项目, 使用 DevOps, 流水线" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 03 +--- + +本文档演示如何在{ks_product_both}上使用流水线模板创建流水线。 + +DevOps 提供图形编辑面板，支持通过交互式操作来定义 Jenkins 流水线的阶段和步骤。内置多个流水线模板，如 Node.js、Maven 以及 Golang，使用户能够快速创建对应模板的流水线。DevOps 还提供 CI 以及 CI & CD 流水线模板，但是这两个模板难以满足定制化需求，建议您采用其它内置模板或直接自定义流水线。 + +* CI 流水线模板 ++ +-- +CI 流水线模板包含两个阶段。**clone code** 阶段用于检出代码，**build & push** 阶段用于构建镜像并将镜像推送至 Docker Hub。先为代码仓库和 Docker Hub 仓库创建凭证，然后在相应的步骤中设置仓库的 URL 以及凭证。完成编辑后，流水线即可开始运行。 +-- + +* CI & CD 流水线模板 ++ +-- +CI & CD 流水线模板包含六个阶段。有关每个阶段的更多信息，请参阅link:../02-create-a-pipeline-using-jenkinsfile/[使用 Jenkinsfile 创建流水线]。先为代码仓库、Docker Hub 仓库创建凭证，然后在相应的步骤中设置仓库的 URL 以及凭证。完成编辑后，流水线即可开始运行。 +// CI & CD 流水线模板包含六个阶段。有关每个阶段的更多信息，请参阅link:../02-create-a-pipeline-using-jenkinsfile/[使用 Jenkinsfile 创建流水线]。先为代码仓库、Docker Hub 仓库和集群的 kubeconfig 创建凭证，然后在相应的步骤中设置仓库的 URL 以及凭证。完成编辑后，流水线即可开始运行。 +-- + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + +* 已创建一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../../05-devops-settings/02-role-and-member-management[角色和成员管理]。 + + +== 操作步骤 + +下面以 Node.js 为例演示如何使用内置流水线模板。使用 Maven 以及 Golang 流水线模板的操作基本相同。 + +. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 + +. 点击**企业空间管理**并进入您的 DevOps 项目，在**流水线**页面点击**创建**。 + +. 在弹出的对话框中，输入流水线名称，点击**下一步**，然后点击**创建**。 + +. 点击已创建的流水线，在**流水线配置**页签下，点击**编辑流水线**。 + +. 在**创建流水线**对话框，点击 **Node.js**，然后点击**下一步**。 + +. 在**参数设置**页签，按照实际情况设置以下参数，点击**创建**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|GitURL +|需要克隆的项目仓库的地址。 + +|GitRevision +|需要检出的分支。 + +|NodeDockerImage +|Node.js 的 Docker 镜像版本。 + +|InstallScript +|安装依赖项的 Shell 脚本。 + +|TestScript +|项目测试的 Shell 脚本。 + +|BuildScript +|构建项目的 Sell 脚本。 + +|ArtifactsPath +|制品文件所在的路径。 +|=== +-- + +. 在左侧的可视化编辑页面，系统默认已添加一系列步骤，点击**添加步骤**或**添加并行阶段**进行修改。 + +. 点击一个步骤，在页面右侧，您可以执行以下操作。编辑完成后，点击**确定**。 ++ +-- +* 修改阶段名称。 + +* 删除阶段。 + +* 设置代理类型。 + +* 添加条件。 + +* 编辑或删除某一任务。 + +* 添加步骤或嵌套步骤。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +请参阅link:../01-create-a-pipeline-using-graphical-editing-panel/[使用图形编辑面板创建流水线]，了解如何在流水线模板中自定义步骤和阶段。 + +|=== +-- + +. 在右侧的**代理**区域，选择代理类型，默认值为 **kubernetes**，点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|代理类型|说明 + +|any +|调用默认的 base pod 模板创建 Jenkins agent 运行流水线。 + +|node +|调用指定类型的 pod 模板创建 Jenkins agent 运行流水线，可配置的 label 标签为 base、java、nodejs、maven、go 等。 + +|kubernetes +|通过 yaml 文件定义的标准 kubernetes pod 模板运行 agent，执行流水线任务。 +|=== +-- + +. 查看已创建的流水线模板详情，点击**运行**即可运行该流水线。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/04-gitlab-multibranch-pipeline.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/04-gitlab-multibranch-pipeline.adoc new file mode 100644 index 000000000..d2f3c4d21 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/04-gitlab-multibranch-pipeline.adoc @@ -0,0 +1,225 @@ +--- +title: "使用 GitLab 创建多分支流水线" +keywords: "Kubernetes, {ks_product}, DevOps 项目, 使用 DevOps, 流水线" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 04 +--- + + +link:https://gitlab.com/users/sign_in[GitLab] 是一款基于 web 的 Git 仓库管理工具，支持公开和私有仓库，并提供了全面的 DevOps 功能，包括源代码管理、代码审查、问题跟踪、持续集成等。通过 GitLab，团队能够在一个平台上高效协作，完成从代码编写到部署的整个软件开发过程。 + +{ks_product_right}支持在 DevOps 项目中使用 GitLab 创建多分支流水线。本文档演示如何使用 GitLab 创建多分支流水线。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + +* 已创建一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../../05-devops-settings/02-role-and-member-management[角色和成员管理]。 + +* 已有一个 link:https://gitlab.com/users/sign_in[GitLab] 账户以及一个 link:https://hub.docker.com/[Docker Hub] 账户。 + +== 步骤 1：创建凭证 + +. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 + +. 点击**企业空间管理**并进入您的 DevOps 项目，在 **DevOps 项目设置**下的**凭证**中创建以下凭证。有关如何创建凭证的更多信息，请参阅link:../../05-devops-settings/01-credential-management/[凭证管理]。 ++ +-- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +如果您的账户或密码中包含任何特殊字符，例如 **@** 和 **$**，则可能会因为无法识别而在流水线运行时导致错误。在此情况下，您需要先在第三方网站（例如 link:https://www.urlencoder.org/[urlencoder]）上对账户或密码进行编码，然后将输出结果复制粘贴作为您的凭证信息。 + +|=== + +[%header,cols="1a,2a,2a"] +|=== +|凭证 ID|类型|用途 + +|dockerhub-id +|用户名和密码 +|Docker Hub + +|gitlab-id +|用户名和密码 +|GitLab + +// |demo-kubeconfig +// |kubeconfig +// |Kubernetes +|=== +-- + +. 创建完成后，您将在凭证页面看到已创建的凭证。 + + +== 步骤 2：在 GitLab 仓库中编辑 Jenkinsfile + +. 登录 GitLab 并创建一个公开项目。点击**新建项目 > 导入项目**，选择**从 URL 导入仓库**，输入 link:https://github.com/kubesphere/devops-maven-sample[devops-maven-sample] 的 URL，可见性级别选择**公开**，然后点击**新建项目**。 + +. 在刚刚创建的项目中，从 v4.1.0 分支中创建一个新分支，命名为 **gitlab-demo**。 + +. 在 **gitlab-demo** 分支中，点击根目录中的 **Jenkinsfile-online** 文件。 + +. 点击**编辑**，分别将 **GITHUB_CREDENTIAL_ID**、**GITHUB_ACCOUNT** 以及 **@github.com** 更改为 **GITLAB_CREDENTIAL_ID**、**GITLAB_ACCOUNT** 以及 **@gitlab.com**，然后编辑下表所列条目。还要将 **push latest** 中 **branch** 的值更改为 **gitlab-demo**。 +// . 点击**编辑**，分别将 **GITHUB_CREDENTIAL_ID**、**GITHUB_ACCOUNT** 以及 **@github.com** 更改为 **GITLAB_CREDENTIAL_ID**、**GITLAB_ACCOUNT** 以及 **@gitlab.com**，然后编辑下表所列条目。还要将 **push latest** 和 **deploy to dev** 中 **branch** 的值更改为 **gitlab-demo**。 ++ +-- +[%header,cols="1a,2a,2a"] +|=== +|条目|值|描述信息 + +|GITLAB_CREDENTIAL_ID +|gitlab-id +|您在{ks_product_both}中为自己的 GitLab 账户设置的**名称**，用于将标签推送至您的 GitLab 仓库。 + +|DOCKERHUB_NAMESPACE +|your-dockerhub-id +|请替换为您的 Docker Hub 账户名，也可以替换为该账户下的 Organization 名称。 + +|GITLAB_ACCOUNT +|your-gitlab-id +|请替换为您的 GitLab 账户名，也可以使用该账户的用户组名称。 +|=== + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +有关 Jenkinsfile 中环境变量的更多信息，请参阅link:../02-create-a-pipeline-using-jenkinsfile/[使用 Jenkinsfile 创建流水线]。 + +|=== +-- + +. 点击 **Commit changes** 更新该文件。 + + +// == 步骤 3：创建项目 + +// 创建两个项目，例如 **kubesphere-sample-dev** 和 **kubesphere-sample-prod**，分别代表开发环境和生产环境。待流水线成功运行，将在这两个项目中自动创建应用程序的相关部署 (Deployment) 和服务 (Service)。 + +// 有关更多信息，请参阅link:../02-create-a-pipeline-using-jenkinsfile/#_步骤_2在_github_仓库中修改_jenkinsfile[使用 Jenkinsfile 创建流水线]。 + +== 步骤 3：创建流水线 + +. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 + +. 点击**企业空间管理**并进入您的 DevOps 项目，在**流水线**页面点击**创建**。 + +. 在弹出的对话框中，将其命名为 **gitlab-multi-branch**。 + +. 在**流水线类别**下，选择**多分支流水线**。 + +. 在**代码仓库**下，选择一个代码仓库，点击**下一步**继续。 ++ +-- +若没有可用的代码仓库，点击下方的**创建代码仓库**。有关更多信息，请参阅link:../../04-import-code-repositories/[导入代码仓库]。 +-- + +.. 在**导入代码仓库**对话框，输入代码仓库名称（自定义），点击选择代码仓库。 + +.. 在 **GitLab** 页签下的 **GitLab 服务器地址**中选择默认选项 link:https://gitlab.com[]，在**项目组/所有者**中输入该 GitLab 项目所属组的名称，然后从**代码仓库**的下拉菜单中选择 **devops-maven-sample** 仓库。点击右下角的image:/images/ks-qkcp/zh/icons/check-dark.svg[check,18,18]，然后点击**下一步**。 ++ +-- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +如需使用 GitLab 私有仓库，请参考以下步骤： + +* 在 GitLab 上前往**用户设置 > 访问令牌**，创建拥有 API 和 read_repository 权限的个人访问令牌。 + +* link:../../../04-how-to-integrate/01-sonarqube/[登录 Jenkins 面板]，前往**系统管理 > Manage Credentials**，使用您的 GitLab 令牌创建 Jenkins 凭证，用于访问 GitLab。然后前往**系统管理 > 系统配置**，在 **GitLab 服务**中添加该凭证。 + +* 在 DevOps 项目中，选择 **DevOps 项目设置 > 凭证**，使用您的 GitLab 令牌创建一个凭证。创建流水线时，在 **GitLab** 页签的**凭证**中指定该凭证，以便流水线能够从您的 GitLab 私有仓库中拉取代码。 + +|=== +-- + +. 在**高级设置**页签中，将**脚本路径**更改为 **Jenkinsfile-online** 然后点击**创建**。 ++ +-- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +该字段指定代码仓库中的 Jenkinsfile 路径，它表示该仓库的根目录。如果文件位置变更，则脚本路径也需要更改。 + +|=== +-- + + +== 步骤 4：运行流水线 + +. 流水线创建后，会展示在列表中。点击流水线名称查看其详情页。 +. 点击右侧的**运行**。在弹出的对话框中，从下拉菜单中选择 **gitlab-demo** 并添加一个标签号，比如 **v0.0.2**。点击**确定**来触发一个新运行。 +. 稍等片刻，点击运行记录查看详情。 +. 流水线如果运行到 **Push with Tag** 阶段，会在此阶段暂停，需要具有审核权限的用户点击**继续**。 +// . 流水线如果运行成功，会在 **Deploy to Dev** 阶段暂停，需要具有审核权限的用户点击**继续**。 +// + +// -- +// //note +// [.admon.note,cols="a"] +// |=== +// |说明 + +// | +// 在 Jenkinsfile 中定义了三个阶段 **deploy to dev**、**push with tag** 和 **deploy to production**，每个阶段都需要审核。因此在运行到这些阶段时，流水线会暂停，等待审核。 +// |=== +// -- + + +== 步骤 5：检查流水线状态 + +. 在运行记录的**流水线**页签下，查看流水线的运行状态。 + +. 点击**运行日志**页签查看流水线运行日志。点击每个阶段查看其详细日志。点击**查看完整日志**，根据日志排除故障和问题，也可以将日志下载到本地进行进一步分析。 + + +== 步骤 6：验证结果 + +. 按照 Jenkinsfile 中的定义，通过流水线构建的 Docker 镜像也已成功推送到 Docker Hub。在 Docker Hub 中，您会看到带有标签 **v0.0.2** 的镜像，该标签在流水线运行之前已指定。 + +. 同时，GitLab 中也已生成一个新标签。 + +// . 示例应用程序将部署到 **kubesphere-sample-dev** 和 **kubesphere-sample-prod**，并创建相应的部署和服务。转到这两个项目，预期结果如下所示： + +// + +// -- +// [%header,cols="1,2,2,1,1"] +// |=== +// |环境|URL|命名空间|部署|服务 + +// |开发环境 +// |http://{$NodeIP}:{$30861} +// |kubesphere-sample-dev +// |ks-sample-dev +// |ks-sample-dev + +// |生产环境 +// |http://{$NodeIP}:{$30961} +// |kubesphere-sample-prod +// |ks-sample +// |ks-sample +// |=== + +// //note +// [.admon.note,cols="a"] +// |=== +// |说明 + +// | +// 您可能需要在安全组中打开端口，以便使用 URL 访问该应用。有关更多信息，请参阅link:../02-create-a-pipeline-using-jenkinsfile/#_步骤_8访问示例服务[访问示例服务]。 + +// |=== +// -- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/05-pipeline-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/05-pipeline-settings.adoc new file mode 100644 index 000000000..c8a779221 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/05-pipeline-settings.adoc @@ -0,0 +1,202 @@ +--- +title: "设置流水线" +keywords: "Kubernetes, {ks_product}, DevOps 项目, 使用 DevOps, 流水线" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 05 +--- + + +创建流水线时，可以通过各种设置来自定义流水线配置。 + +流水线创建后，进入流水线详情页，点击**编辑信息**和更多操作中的**编辑设置**，也可以编辑流水线的配置。 + +本文档详细介绍如何设置流水线。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + +* 已创建一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../../05-devops-settings/02-role-and-member-management[角色和成员管理]。 + + +== 基本信息 + +在**基本信息**页签，您可以自定义以下信息： + +* **名称**：流水线的名称，同一个 DevOps 项目内的流水线不能重名。 + +* **DevOps 项目**：流水线所属的 DevOps 项目。 + +* **描述**：描述流水线的附加信息，描述信息不超过 256 个字符。 + +* **流水线类别**：普通流水线或多分支流水线。若选择多分支流水线，则需要选择一个代码仓库。 + +* **代码仓库（可选）**：选择一个代码仓库作为流水线的代码源，可选择 GitHub、GitLab、Bitbucket、以及 Git 作为代码源。 ++ +==== +* GitHub ++ +-- +如果选择 **GitHub**，则必须指定用于访问 GitHub 的凭证。如果您已预先使用您的 GitHub 令牌创建了凭证，则从下拉菜单中选择已有凭证，或者点击**创建凭证**来创建新凭证。选择凭证后，点击**确定**，即可在右侧选择您的仓库。完成所有操作后，点击image:/images/ks-qkcp/zh/icons/check-dark.svg[check,18,18]。 +-- + +* GitLab ++ +-- +如果选择 **GitLab**，则必须指定 GitLab 服务器地址、项目组/所有者和代码仓库。如果访问代码仓库需要凭证，则需要指定一个凭证。完成所有操作后，点击image:/images/ks-qkcp/zh/icons/check-dark.svg[check,18,18]。 +-- + +* Bitbucket ++ +-- +如果选择 **Bitbucket**，则需要输入您的 Bitbucket 服务器地址。预先使用您的 Bitbucket 用户名和密码创建一个凭证，或者点击**创建凭证**来创建一个新凭证。输入信息后点击**确定**，即可在右侧选择您的仓库。完成所有操作后，点击image:/images/ks-qkcp/zh/icons/check-dark.svg[check,18,18]。 +-- + +* Git ++ +-- +如果选择 **Git**，则需要指定仓库 URL。如果访问代码仓库需要凭证，则需要指定一个凭证，或者点击**创建凭证**来添加新凭证。完成所有操作后，点击image:/images/ks-qkcp/zh/icons/check-dark.svg[check,18,18]。 +-- +==== + +== 高级设置 + +=== 指定代码仓库 + +如果指定了一个代码仓库，则可以在**高级设置**页签上自定义以下配置： + +* 分支设置 ++ +-- +**删除旧分支**：自动删除旧分支。分支记录将一起被删除。分支记录包括控制台输出、已归档制品以及特定分支相关的其他元数据。更少的分支意味着您可以节省 Jenkins 正在使用的磁盘空间。DevOps 提供两个选项来确定何时丢弃旧分支： + +* **分支保留天数（天）**：超过保留期限的分支将被删除。 + +* **分支最大数量**：分支数量超过最大数量时，删除最旧的分支。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +**分支保留天数（天）**和**分支最大数量**可以同时应用于分支。只要某个分支满足其中一个字段所设置的条件，则会删除该分支。例如，如果您将保留天数和最大分支数分别指定为 2 和 3，待某个分支的保留天数超过 2 或者分支保留数量超过 3，则会删除该分支。DevOps 默认用 7 和 5 预填充这两个字段。 + +|=== +-- + +* 策略设置 ++ +-- +在**策略设置**中，DevOps 默认提供四种策略。Jenkins 流水线运行时，开发者提交的 PR (Pull Request) 也将被视为一个单独的分支。 + +**发现分支** + +* **排除已提交 PR 的分支**：已提交 PR 的分支将被排除。 +* **只包括已提交 PR 的分支**：只拉取已提交 PR 的分支。 +* **包括所有分支**：拉取源仓库中的所有分支。 + +**发现标签** + +* **启用标签发现**：拥有指定标签的分支将被扫描。 +* **禁用标签发现**：拥有指定标签的分支不会被扫描。 + +**从原仓库发现 PR** + +* **拉取 PR 合并后的代码**：PR 合并到目标分支后，将基于源代码创建并运行流水线。 +* **拉取 PR 提交时的代码**：根据 PR 本身的源代码创建并运行流水线。 +* **分别创建两个流水线**：创建两个流水线，一个流水线使用 PR 与目标分支合并后的源代码版本，另一个使用 PR 本身的源代码版本。 + +**从 Fork 仓库发现 PR** + +拉取策略： + +* **拉取 PR 合并后的代码**：PR 合并到目标分支后，将基于源代码创建并运行流水线。 +* **拉取 PR 提交时的代码**：根据 PR 本身的源代码创建并运行流水线。 +* **分别创建两个流水线**：创建两个流水线，一个流水线使用 PR 与目标分支合并后的源代码版本，另一个使用 PR 本身的源代码版本。 + +受信用户： + +* **贡献者**：对 PR 做出贡献的用户。 +* **所有人**：每个可以访问 PR 的用户。 +* **具有管理员或有编辑权限的用户**：仅限于对 PR 具有管理员或编辑权限的用户。 +* **无**：如果选择此选项，那么无论在**拉取策略**中选择了哪个选项，都不会发现 PR。 +-- + +* 正则过滤 ++ +-- +勾选选框以指定正则表达式来过滤分支、PR 和标签。 +-- + +* 脚本路径 ++ +-- +**脚本路径**参数指定代码仓库中的 Jenkinsfile 路径，它指代仓库的根目录。如果文件位置发生更改，则脚本路径也需要更改。 +-- + +* 扫描触发器 ++ +-- +勾选**定时扫描**，并从下拉列表中设置扫描时间间隔。 +-- + +* 构建触发器 ++ +-- +勾选**通过流水线事件触发**，从**创建流水线时触发**和**删除流水线时触发**的下拉列表中选择一个流水线，以便在创建新的流水线或删除流水线时自动触发指定流水线中的任务。 +-- + +* 克隆设置 ++ +-- +* **启用浅克隆**：如果开启浅克隆，则克隆的代码不会包含标签。 +* **克隆深度**：克隆时需要提取的 commit 数量。 +* **克隆超时时间（min）**：完成克隆过程所需要的时长（以分钟为单位）。 +-- + +* Webhook ++ +-- +**Webhook** 能有效地让流水线发现远程代码仓库中的更改，并自动触发新一轮运行。Webhook 应成为触发 Jenkins 自动扫描 GitHub 和 Git（例如 GitLab）的主要方法。有关更多信息，请参阅link:../06-pipeline-webhook/[使用 Webhook 触发流水线]。 +-- + + +=== 不指定代码仓库 + +如果不指定代码仓库，则可以在**高级设置**页签上自定义以下配置： + +* 构建设置 ++ +-- +**删除过期构建记录**：指定何时删除分支下的构建记录。构建记录包括控制台输出、已归档制品以及与特定构建相关的其他元数据。保留较少的构建可以节省 Jenkins 所使用的磁盘空间。DevOps 提供两个选项来确定何时删除旧的构建： + +* **构建记录保留期限（天）**：超过保留期限的构建记录将被删除。 + +* **构建记录最大数量**：当构建记录数量超过允许的最大数量，最早的构建记录将被删除。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| + +**构建记录保留期限（天）**和**构建记录最大数量**可以同时应用于构建记录。只要某个构建记录满足其中一个字段所设置的条件，则会删除该构建记录。例如，如果您将保留期限和最大数量分别指定为 2 和 3，待某个构建记录的保留天数超过 2 或者最大数量超过 3，则会删除该构建记录。DevOps 默认用 7 和 10 预填充这两个字段。 +|=== + +* **不允许并发构建**：如果勾选此选项，则不能并发运行多个构建。 +-- + +* 构建参数 ++ +-- +参数化的构建过程允许在开始运行流水线时传入一个或多个参数。DevOps 默认提供五种参数类型，包括**字符串**、**多行字符串**、**布尔值**、**选项**以及**密码**。当参数化项目时，构建会被替换为参数化构建，其中将提示用户为每个定义的参数输入值。 +-- + +* 构建触发器 ++ +-- +**定时构建**：允许定期执行构建。输入 CRON 表达式以设置定时计划。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/06-pipeline-webhook.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/06-pipeline-webhook.adoc new file mode 100644 index 000000000..a4e736096 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/06-pipeline-webhook.adoc @@ -0,0 +1,77 @@ +--- +title: "使用 Webhook 触发流水线" +keywords: "Kubernetes, {ks_product}, DevOps 项目, 使用 DevOps, 流水线" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 06 +--- + + +若要通过远程代码仓库创建基于 Jenkinsfile 的流水线，可以在远程仓库中配置 webhook，以便在远程仓库变更时，自动触发流水线。 + +本文档演示如何在 GitHub 仓库中用 webhook 触发流水线。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + +* 已创建一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../../05-devops-settings/02-role-and-member-management[角色和成员管理]。 + +* 已通过远程代码仓库创建一个基于 Jenkinsfile 的流水线。有关更多信息，请参阅link:../02-create-a-pipeline-using-jenkinsfile/[使用 Jenkinsfile 创建流水线]。 + +== 配置 Webhook + +=== 获取 webhook URL + +. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 + +. 点击**企业空间管理**并进入您的 DevOps 项目。 + +. 在**流水线**页面，点击一个流水线（例如 **jenkins-in-scm**）以查看其详情页面。 + +. 点击**更多操作**，在下拉菜单中选择**编辑设置**。 + +. 在弹出的会话框中，滚动至 **Webhook** 以获得 Webhook push URL。 + +=== 在 GitHub 仓库中设置 webhook + +. 登录您的 GitHub，并进入 **devops-maven-sample** 仓库。 + +. 点击 **Settings** > **Webhooks**，然后点击 **Add webhook**。 + +. 在 **Payload URL** 中输入流水线中的 Webhook push URL，然后点击 **Add webhook**。 +本教程选择默认的 **Just the push event**，请根据实际需要进行配置。有关更多信息，请参阅 link:https://docs.github.com/en/developers/webhooks-and-events/webhooks/creating-webhooks[GitHub 文档]。 + +. 配置好的 webhook 会展示在 **Webhooks** 页面。 + + +== 使用 Webhook 触发流水线 + +=== 提交拉取请求到仓库 + +. 在 devops-maven-sample 仓库的 **Code** 页面，点击 **master** 然后选择 **v4.1.0-sonarqube** 分支。 + +. 转到 **/deploy/dev-ol** 然后点击文件 **devops-sample.yaml**。 + +. 点击image:/images/ks-qkcp/zh/icons/pen-light.svg[pen-light,18,18]编辑文件。 例如，将 **spec.replicas** 的值改变为 **3**。 + +. 点击 **Commit changes**。 + +=== 检查 webhook 交付 + +. 在 devops-maven-sample 仓库的 **Settings** > **Webhooks** 页面，点击创建的 webhook。 + +. 点击 **Recent Deliveries**，然后点击一个具体交付记录查看详情。 + + +== 检查流水线状态 + +. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 + +. 点击**企业空间管理**并进入您的 DevOps 项目。 + +. 在**流水线**页面，点击一个流水线（例如 **jenkins-in-scm**）以查看其详情页面。 + +. 在**运行记录**页签，检查提交到远程仓库 **v4.1.0-sonarqube** 分支的拉取请求是否触发了新的运行。 + +// . 转到 **kubesphere-sample-dev** 项目的 **工作负载 > 容器组** 页面，检查 3 个 Pods 的状态。如果 3 个 Pods 为运行状态，表示流水线运行正常。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/07-jenkins-setting.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/07-jenkins-setting.adoc new file mode 100644 index 000000000..b4d95918e --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/07-jenkins-setting.adoc @@ -0,0 +1,55 @@ +--- +title: "设置 Jenkins 系统" +keywords: "Kubernetes, {ks_product}, DevOps 项目, 使用 DevOps, 流水线" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 07 +--- + +DevOps 系统提供基于 Jenkins 的容器化 CI/CD 功能。Jenkins 作为 CI/CD 工作流的事实标准，具备强大而灵活的特性。然而，许多插件要求用户在使用 Jenkins 之前必须进行系统级配置。 + +为了提供可调度的 Jenkins 环境，{ks_product_right}采用了 **Configuration as Code** 的方式进行 Jenkins 系统设置。用户需要登录 Jenkins 仪表板，修改配置后再重新加载。 + +本文档演示如何在 Jenkins 仪表板上设置 Jenkins 并重新加载配置。 + +== 前提条件 + +{ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + + +== Jenkins Configuration as Code + +{ks_product_right}默认安装 Jenkins Configuration as Code 插件，支持通过 YAML 文件定义 Jenkins 的期望状态，便于再现 Jenkins 的配置（包括插件配置）。请参阅link:https://github.com/jenkinsci/configuration-as-code-plugin/tree/master/demos[该目录]查看具体的 Jenkins 配置和示例 YAML 文件。 + +此外，还可以在 link:https://github.com/kubesphere/ks-jenkins[ks-jenkins] 仓库中找到 **formula.yaml** 文件，查看插件版本并按需自定义这些版本。 + + +== 修改 ConfigMap + +建议通过 Configuration as Code (CasC) 在{ks_product_both}中配置 Jenkins。将内置 Jenkins CasC 文件存储为 ConfigMap。 + +. 以 **platform-admin** 用户登录{ks_product_left} Web 控制台。 + +. 点击**集群管理**，进入一个集群。 + +. 在左侧导航栏中选择**配置**下的**配置字典**。在**配置字典**页面，从下拉列表中选择 **kubesphere-devops-system**，然后点击 **jenkins-casc-config**。 + +. 在详情页面，点击**更多操作**，在下拉列表中选择**编辑 YAML**。 + +. **jenkins-casc-config** 的配置模板是一个 YAML 文件，位于 **data:jenkins_user.yaml:** 部分。在 ConfigMap 的代理 (Kubernetes Jenkins Agent) 中修改容器镜像、标签、资源请求 (Request) 和限制 (Limit) 等内容，或者在 podTemplate 中添加容器。完成操作后，点击**确定**。 + +. 等待 1 ~ 2 分钟，会自动重新加载新的配置。 + + + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +* 有关如何通过 CasC 设置 Jenkins 的更多信息，请参阅 link:https://github.com/jenkinsci/configuration-as-code-plugin[Jenkins 文档]。 + +* 在当前版本中，并非所有插件都支持 CasC 设置。CasC 仅会覆盖通过 CasC 设置的插件配置。 + +|=== + diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/08-jenkins-shared-library.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/08-jenkins-shared-library.adoc new file mode 100644 index 000000000..3bb0c57c8 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/08-jenkins-shared-library.adoc @@ -0,0 +1,150 @@ +--- +title: "在流水线中使用 Jenkins 共享库" +keywords: "Kubernetes, {ks_product}, DevOps 项目, 使用 DevOps, 流水线" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 08 +--- + + + +对于包含相同阶段或步骤的 Jenkins 流水线，可以在 Jenkinsfile 中使用 Jenkins 共享库避免流水线代码重复。 + +本文档演示如何在{ks_product_left} DevOps 流水线中使用 Jenkins 共享库。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + +* 已创建一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../../05-devops-settings/02-role-and-member-management[角色和成员管理]。 + +* 已有一个可用 Jenkins 共享库。本教程以 link:https://github.com/devops-ws/jenkins-shared-library[GitHub 仓库]中的 Jenkins 共享库为例。 + + +== 步骤 1：在 Jenkins 仪表盘配置共享库 + +. link:../../../04-how-to-integrate/01-sonarqube/[登录 Jenkins 仪表板]并点击左侧导航栏中的**系统管理**。 + +. 向下滚动并点击**系统配置**。 + +. 向下滚动到 **Global Pipeline Libraries**，然后点击**新增**。 + +. 配置字段如下所示。 + +* **Name：** 为共享库设置名称（例如，`demo-shared-library`），以便在 Jenkinsfile 中引用此名称来导入共享库。 + +* **Default version：** 设置共享库所在仓库的一个分支名称，将其作为导入共享库的默认分支。本教程将使用 master。 + +* 在 **Retrieval method** 下，选择 **Modern SCM**。 + +* 在 **Source Code Management** 下，选择 **Git**，并为**项目仓库**输入示例仓库的 URL 。如果您使用自己的仓库且访问此仓库需要凭证，还需要配置**凭证**。 + +. 编辑完成后，点击**应用**。 ++ +-- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +您还可以配置link:https://www.jenkins.io/zh/doc/book/pipeline/shared-libraries/#folder-level-shared-libraries[文件夹级别的共享库]。 + +|=== +-- + +== 步骤 2：在流水线中使用共享库 + + +=== 创建流水线 + +. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 + +. 点击**企业空间管理**并进入您的 DevOps 项目，在**流水线**页面点击**创建**。 + +. 在弹出的对话框中，将其命名为 **demo-shared-library**，点击**下一步**。 + +. 在**高级设置**中，直接点击**创建**，使用默认设置创建流水线。 + +=== 编辑流水线 + +. 在流水线列表页面，点击流水线名称进入其详情页面，然后点击**编辑 Jenkinsfile**。 + +. 在弹出的对话框中，添加以下示例 Jenkinsfile。完成编辑后，点击**确定**。 ++ +-- +[,json] +---- + +library identifier: 'devops-ws-demo@master', retriever: modernSCM([ + $class: 'GitSCMSource', + remote: 'https://github.com/devops-ws/jenkins-shared-library', + traits: [[$class: 'jenkins.plugins.git.traits.BranchDiscoveryTrait']] +]) + +pipeline { + agent any + + stages { + stage('Demo') { + steps { + script { + mvn.fake() + } + } + } + } +} +---- + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +根据需要，为 **agent** 指定 **label**。 + +|=== +-- + ++ +或者，使用以 **@Library('<配置好的共享库名称>') _** 开头的 Jenkinsfile。如果使用这种类型的 Jenkinsfile，需要提前在 Jenkins 仪表板上配置共享库。在本教程中，您可以使用以下示例 Jenkinsfile。 ++ +-- +[,json] +---- + +@Library('demo-shared-library') _ + +pipeline { + agent any + + stages { + stage('Demo') { + steps { + script { + mvn.fake() + } + } + } + } +} +---- + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +使用 **@Library('demo-shared-library@<分支名称>') _** 来指定特定的分支。 + +|=== +-- + +== 步骤 3：运行流水线 + +. 在流水线详情页面，点击**运行**运行流水线。 + +. 点击**运行记录**页签下的记录，查看流水线运行详情。点击**运行日志**查看日志详细信息。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/09-jenkins-email.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/09-jenkins-email.adoc new file mode 100644 index 000000000..07f2f6b01 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/09-jenkins-email.adoc @@ -0,0 +1,62 @@ +--- +title: "为流水线设置电子邮件服务器" +keywords: "Kubernetes, {ks_product}, DevOps 项目, 使用 DevOps, 流水线" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 09 +--- + + +内置 Jenkins 无法与{ks_product_both}的通知系统共享相同的电子邮件配置。因此，您需要单独为 DevOps 流水线配置电子邮件服务器。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + +* 您需要在{ks_product_both}平台具有**集群管理**权限。 + + +== 操作步骤 + +. 以具有**集群管理**权限的账户登录{ks_product_left} Web 控制台。 + +. 点击**集群管理**，进入一个集群。 + +. 在左侧导航栏中选择**应用负载**下的**工作负载**，从下拉列表中选择 **kubesphere-devops-system** 项目。点击 **devops-jenkins** 右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，并选择**编辑 YAML**。 + +. 在 YAML 文件中编辑如下所示的字段。完成修改后，点击**确定**。 ++ +-- +//warning +[.admon.warning,cols="a"] +|=== +|警告 + +| +修改电子邮件服务器配置后，**devops-jenkins** 部署 (Deployment) 会重新启动。因此，DevOps 系统将在几分钟内不可用，请在适当的时候修改这些配置。 + +|=== + + +[%header,cols="1a,3a"] +|=== +|环境变量名称 |描述信息 +|EMAIL_SMTP_HOST +|SMTP 服务器地址 + +|EMAIL_SMTP_PORT +|SMTP 服务器端口（如：25） + +|EMAIL_FROM_ADDR +|电子邮件发件人地址 + +|EMAIL_FROM_NAME +|电子邮件发件人姓名 + +|EMAIL_FROM_PASS +|电子邮件发件人密码 + +|EMAIL_USE_SSL +|是否启用 SSL 配置 +|=== +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/10-choose-jenkins-agent.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/10-choose-jenkins-agent.adoc new file mode 100644 index 000000000..41b493af6 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/10-choose-jenkins-agent.adoc @@ -0,0 +1,219 @@ +--- +title: "选择 Jenkins Agent" +keywords: "Kubernetes, {ks_product}, DevOps 项目, 使用 DevOps, 流水线" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 10 +--- + + +**agent** 部分指定整个流水线或特定阶段 (Stage) 将在 Jenkins 环境中执行的位置，具体取决于该 **agent** 部分的放置位置。该部分必须在 **pipeline** 块的顶层进行定义，但是阶段级别的使用是可选的。有关更多信息，请参阅 link:https://www.jenkins.io/zh/doc/book/pipeline/syntax/#代理[Jenkins 官方文档]。 + + +== 内置 podTemplate + +podTemplate 是一种 Pod 模板，用于创建 Agent。您可以定义在 Kubernetes 插件中使用的 podTemplate。 + +在流水线运行期间，每个 Jenkins Agent Pod 必须具有一个名为 **jnlp** 的容器，以便实现 Jenkins Controller 与 Jenkins Agent 之间的通信。此外，您可以在 podTemplate 中添加容器，以满足个性化需求。可选择使用自定义的 Pod YAML 来灵活控制运行时环境（Runtime），并通过 **container** 命令来切换容器。以下是相关示例。 + +[,json] +---- + +pipeline { + agent { + kubernetes { + //cloud 'kubernetes' + label 'mypod' + yaml """ +apiVersion: v1 +kind: Pod +spec: + containers: + - name: maven + image: maven:3.3.9-jdk-8-alpine + command: ['cat'] + tty: true +""" + } + } + stages { + stage('Run maven') { + steps { + container('maven') { + sh 'mvn -version' + } + } + } + } +} +---- + +在目前版本中，{ks_product_right}内置了 4 种类型的 podTemplate：**base**、**nodejs**、**maven** 和 **go**，并且在 Pod 中提供隔离的 Docker 环境。 + +您可以通过指定 Agent 的标签来使用内置 podTemplate。例如，要使用 nodejs 的 podTemplate，在创建流水线时指定标签为 **nodejs** 即可，具体参阅以下示例。 + +[,json] +---- + +pipeline { + agent { + node { + label 'nodejs' + } + } + + stages { + stage('nodejs hello') { + steps { + container('nodejs') { + sh 'yarn -v' + sh 'node -v' + sh 'docker version' + sh 'docker images' + } + } + } + } +} +---- + + +* podTemplate base ++ +-- +[%header,cols="1a,4a"] +|=== +|名称 |类型/版本 + +|Jenkins Agent 标签 +|base + +|容器名称 +|base + +|操作系统 +|centos-7 + +|Docker +|18.06.0 + +|Helm +|2.11.0 + +|Kubectl +|稳定版 + +|内置工具 +|unzip、which、make、wget、zip、bzip2、git +|=== +-- + +* podTemplate nodejs ++ +-- +[%header,cols="1a,4a"] +|=== +|名称 |类型/版本 + +|Jenkins Agent 标签 +|nodejs + +|容器名称 +|nodejs + +|操作系统 +|centos-7 + +|Node +|9.11.2 + +|Yarn +|1.3.2 + +|Docker +|18.06.0 + +|Helm +|2.11.0 + +|Kubectl +|稳定版 + +|内置工具 +|unzip、which、make、wget、zip、bzip2、git +|=== +-- + +* podTemplate maven ++ +-- +[%header,cols="1a,4a"] +|=== +|名称|类型/版本 + +|Jenkins Agent 标签 +|maven + +|容器名称 +|maven + +|操作系统 +|centos-7 + +|Jdk +|openjdk-1.8.0 + +|Maven +|3.5.3 + +|Docker +|18.06.0 + +|Helm +|2.11.0 + +|Kubectl +|稳定版 + +|内置工具 +|unzip、which、make、wget、zip、bzip2、git +|=== +-- + +* podTemplate go ++ +-- +[%header,cols="1a,4a"] +|=== +|名称|类型/版本 + +|Jenkins Agent 标签 +|go + +|容器名称 +|go + +|操作系统 +|centos-7 + +|Go +|1.11 + +|GOPATH +|/home/jenkins/go + +|GOROOT +|/usr/local/go + +|Docker +|18.06.0 + +|Helm +|2.11.0 + +|Kubectl +|稳定版 + +|内置工具 +|unzip、which、make、wget、zip、bzip2、git +|=== +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/11-customize-jenkins-agent.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/11-customize-jenkins-agent.adoc new file mode 100644 index 000000000..fbaf3b3e8 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/11-customize-jenkins-agent.adoc @@ -0,0 +1,85 @@ +--- +title: "自定义 Jenkins Agent" +keywords: "Kubernetes, {ks_product}, DevOps 项目, 使用 DevOps, 流水线" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 11 +--- + + +若要使用运行特定环境（例如 JDK 11）的 Jenkins Agent，可以在{ks_product_both}上自定义 Jenkins Agent。 + +本文档描述如何在{ks_product_both}上自定义 Jenkins Agent。 + + +== 前提条件 + +{ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + + +== 自定义 Jenkins Agent + +. 以 **admin** 用户登录{ks_product_left} Web 控制台。 + +. 点击**集群管理**，进入一个集群。 + +. 在左侧导航栏选择**配置**下的**配置字典**。 + +. 在**配置字典**页面的搜索框中输入 **jenkins-casc-config** 并按**回车键**。 + +. 点击 **jenkins-casc-config** 进入其详情页面，点击**更多操作**，选择**编辑 YAML**。 + +. 在弹出的对话框中，搜寻至 **data:jenkins_user.yaml:jenkins:clouds:kubernetes:templates** 下方并输入以下代码，点击**确定**。 ++ +-- +[,yaml] +---- + +- name: "maven-jdk11" # 自定义 Jenkins Agent 的名称。 + label: "maven jdk11" # 自定义 Jenkins Agent 的标签。若要指定多个标签，请用空格来分隔标签。 + inheritFrom: "maven" # 自定义 Jenkins Agent 所继承的现有容器组模板的名称。 + containers: + - name: "maven" # 自定义 Jenkins Agent 所继承的现有容器组模板中指定的容器名称。 + image: "kubespheredev/builder-maven:v3.2.0jdk11" # 此镜像只用于测试。请使用您自己的镜像。 +---- + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +请确保遵守 YAML 文件中的缩进。 + +|=== +-- + +. 等待 1 ~ 2 分钟，会自动重新加载新的配置。 + +. 要使用自定义的 Jenkins Agent，请参考下方的示例 Jenkinsfile，在创建流水线时指定自定义 Jenkins Agent 对应的标签和容器名。 ++ +-- + +[,json] +---- + +pipeline { + agent { + node { + label 'maven && jdk11' + } + } + stages { + stage('Print Maven and JDK version') { + steps { + container('maven') { + sh ''' + mvn -v + java -version + ''' + } + } + } + } +} +---- +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/_index.adoc new file mode 100644 index 000000000..f01518088 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/02-pipelines/_index.adoc @@ -0,0 +1,8 @@ +--- +title: "流水线" +keywords: "Kubernetes, {ks_product}, DevOps 项目, 使用 DevOps, 流水线" +description: "本节介绍如何使用流水线功能。" +weight: 02 +--- + +本节介绍如何使用流水线功能。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/03-use-gitops-for-continous-deployment.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/03-use-gitops-for-continous-deployment.adoc new file mode 100644 index 000000000..29b6326c4 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/03-use-gitops-for-continous-deployment.adoc @@ -0,0 +1,255 @@ +--- +title: "使用 GitOps 实现应用持续部署" +keywords: "Kubernetes, {ks_product}, DevOps 项目, 使用 DevOps" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 03 +--- + + +{ks_product_right}引入了一种为云原生应用实现持续部署的理念 – GitOps。GitOps 的核心思想是拥有一个 Git 仓库，并将应用系统的申明式基础架构和应用程序存放在 Git 仓库中进行版本控制。GitOps 结合 Kubernetes 能够利用自动交付流水线将更改应用到指定的任意多个集群中，从而解决跨云部署的一致性问题。 + +本文档演示如何创建持续部署以实现应用的部署。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + +* 已有一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../05-devops-settings/02-role-and-member-management[角色和成员管理]。 + + +== 导入代码仓库 + +. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 + +. 点击**企业空间管理**并进入您的 DevOps 项目。 + +. 在左侧导航栏，点击**代码仓库**。 + +. 在右侧的代码仓库页面，点击**添加**。 + +. 在**导入代码仓库**对话框，输入代码仓库名称，如 **open-podcasts**，点击选择代码仓库。您也可以为代码仓库设置别名和添加描述信息。 + + +. 在**选择代码仓库**对话框，点击 **Git**，在**代码仓库地址**区域，输入代码仓库地址，如 link:https://github.com/kubesphere-sigs/open-podcasts[]，点击**确定**。 ++ +-- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +此处导入的是公共仓库，因此不需要创建凭证。如果您添加的是私有仓库，则需要创建凭证。有关如何添加凭证的更多信息，请参阅link:../05-devops-settings/01-credential-management/[凭证管理]。 + +|=== +-- + + +== 创建持续部署 + +. 在左侧导航栏，点击**持续部署**。 + +. 在右侧的**持续部署**页面，点击**创建**。 + +. 在**基本信息**页签，输入持续部署名称，如 **open-podcasts**。在**部署位置**区域，选择持续部署的部署集群和项目。点击**下一步**。 + +. 在**代码仓库设置**页签，选择上一步创建的代码仓库，设置代码仓库的分支或标签以及 Kustomization 清单文件路径。点击**下一步**。 ++ +-- +[%header, cols="1a,3a"] +|=== +|参数 |描述 + +|修订版本 +|Git 仓库中的 commit ID、分支或标签。例如，**master**, **v1.2.0**, **0a1b2c3** 或 **HEAD**。 + +|清单文件路径 +|设置清单文件路径。例如，**config/default**。 +|=== +-- + +. 在**同步策略**区域，根据需要选择**自动同步**或**手动同步**。 ++ +-- + +* **自动同步**：在检测到 Git 仓库中的清单与部署资源的实时状态之间存在差异时，根据设置的同步选项，自动触发应用程序同步。具体参数如下表所示。 ++ +==== +[%header, cols="1a,3a"] +|=== +|参数 |描述 + +|清理资源 +|如果勾选，自动同步时会删除 Git 仓库中不存在的资源。不勾选时，自动同步触发时不会删除集群中的资源。 + +|自恢复 +|如果勾选，当检测到 Git 仓库中定义的状态与部署资源中有偏差时，将强制应用 Git 仓库中的定义。不勾选时，对部署资源做更改时不会触发自动同步。 +|=== +==== + +* **手动同步**：根据设置的同步选项，手动触发应用程序同步。 + +// 具体参数如下表所示。 +// + +// ==== +// [%header, cols="1a,3a"] +// |=== +// |参数 |描述 + +// |清理资源 +// |如果勾选，同步会删除 Git 仓库中不存在的资源。不勾选时，同步不会删除集群中的资源，而是会显示 **out-of-sync**。 + +// |模拟运行 +// |模拟同步，不影响最终部署资源。 + +// |仅执行 Apply +// |如果勾选，同步应用资源时会跳过 **pre/post** 钩子，仅执行 **kubectl apply**。 + +// |强制 Apply +// |如果勾选，同步时会执行 **kubectl apply --force**。 +// |=== +// ==== + +-- + +. 在**同步设置**区域，根据需要设置同步相关参数。 ++ +-- +[%header, cols="1a,3a"] +|=== +|参数 |描述 + +|跳过规范校验 +|跳过 **kubectl** 验证。执行 **kubectl apply** 时，增加 **--validate=false** 标识。 + +|自动创建项目 +|在项目不存在的情况下自动为应用程序资源创建项目。 + +|最后清理 +|同步操作时，其他资源都完成部署且处于健康状态后，再清理资源。 + +|选择性同步 +|仅同步 **out-of-sync** 状态的资源。 +|=== +-- + + +. 在**依赖清理策略**区域，根据需要选择依赖清理策略。 ++ +-- +[%header, cols="1a,3a"] +|=== +|参数 |描述 + +|foreground +|先删除依赖资源，再删除主资源。 + +|background +|先删除主资源，再删除依赖资源。 + +|orphan +|删除主资源，留下依赖资源成为孤儿。 +|=== +-- + +. 在**替换资源**区域，选择是否需要替换已存在的资源。 ++ +-- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| + +如果勾选，将执行 **kubectl replace/create** 命令同步资源。不勾选时，使用 **kubectl apply** 命令同步资源。 +|=== +-- + +. 点击**创建**。资源创建完成后将显示在持续部署列表中。 + + +== 查看已创建的持续部署信息 + +. 在**持续部署**页面上查看到已创建的持续部署信息。具体参数如下表所示。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|持续部署的名称。 + +|健康状态 +|持续部署的健康状态。主要包含以下几种状态： + +* **健康**：资源健康。 +* **已降级**：资源已经被降级。 +* **进行中**：资源正在同步。默认返回该状态。 +* **暂停**：资源已经被暂停并等待恢复。 +* **未知**：资源健康状态未知。 +* **丢失**：资源已缺失。 + +|同步状态 +|持续部署的同步状态。主要包含以下几种状态： + +* **已同步**：资源同步已完成。 +* **未同步**：资源的实际运行状态和期望状态不一致。 +* **未知**：资源同步状态未知。 + +|部署位置 +|资源部署的集群和项目。 + +|更新时间 +|资源更新的时间。 +|=== +-- + +. 点击持续部署右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，您可以执行以下操作： ++ +-- +* **编辑信息**：编辑别名和描述信息。 + +* **编辑 YAML**：编辑持续部署的 YAML 文件。 + +* **同步**：触发资源同步。 + +* **删除**：删除持续部署。 + +//warning +[.admon.warning,cols="a"] +|=== +|警告 + +| + +删除持续部署的同时会删掉和该持续部署关联的资源。请谨慎操作。 +|=== + +-- + +. 点击已创建的持续部署进入详情页面，查看同步状态和同步结果。 + + +== 访问已创建的应用 + +. 进入持续部署所属的项目，在左侧导航栏，点击**应用负载** > **服务**。 + +. 在右侧的**服务**区域，找到已部署的应用，并点击右侧image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**编辑外部访问**。 + +. 在**访问模式**中选择 **NodePort**，点击**确定**。 + +. 在服务列表页面的**外部访问**列，查看暴露的端口，通过 {Node IP}:{NodePort} 访问此应用。 ++ +-- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +在访问服务之前，请确保安全组中的端口已打开。 +|=== +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/04-import-code-repositories.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/04-import-code-repositories.adoc new file mode 100644 index 000000000..44bd48b2f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/04-import-code-repositories.adoc @@ -0,0 +1,100 @@ +--- +title: "导入代码仓库" +keywords: "Kubernetes, {ks_product}, DevOps 项目, 使用 DevOps" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 04 +--- + + +{ks_product_right}支持导入 GitHub、GitLab、Bitbucket 或其它基于 Git 的代码仓库，如 Gitee。下面以 Github 仓库为例，展示如何导入代码仓库。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + +* 已有一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../05-devops-settings/02-role-and-member-management[角色和成员管理]。 + + +== 操作步骤 + +. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 + +. 点击**企业空间管理**并进入您的 DevOps 项目。 + +. 在左侧导航栏，点击**代码仓库**。 + +. 在右侧的代码仓库页面，点击**添加**。 + +. 在**导入代码仓库**对话框，输入代码仓库名称，点击选择代码仓库。您也可以为代码仓库设置别名和添加描述信息。 ++ +-- +下表列举了支持导入的代码仓库和参数设置项。以下步骤以 GitHub 为例。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|GitHub +|**凭证**：选择访问代码仓库的凭证。 + +|GitLab +| +* **GitLab 服务器地址**：选择 GitLab 服务器地址，默认值为 link:https://gitlab.com[]。 +* **项目组/所有者**：输入 GitLab 账号。 +* **凭证**：选择访问代码仓库的凭证。 +* **代码仓库**：选择代码仓库。 + +|Bitbucket +| +* **Bitbucket 服务器地址**：设置 Bitbucket 服务器地址。 +* **凭证**：选择访问代码仓库的凭证。 + +|Git +| +* **代码仓库地址**：输入代码仓库地址，如 link:https://gitee.com[]。 +* **凭证**：选择访问代码仓库的凭证。 +|=== + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +如需使用 GitLab 私有仓库，请参阅link:../02-pipelines/04-gitlab-multibranch-pipeline/[使用 GitLab 创建多分支流水线]。 + +|=== +-- + +. 在**凭证**区域，点击**创建凭证**。在弹出的**创建凭证**对话框，设置以下参数，点击**确定**。 ++ +-- +* **名称**：输入凭证名称，如 **github-id**。 +* **类型**：取值包括**用户名和密码**、**SSH 密钥**和**访问令牌**。在 DevOps 项目中，建议使用**用户名和密码**。 +// * **类型**：取值包括**用户名和密码**、**SSH 密钥**、**访问令牌**和 **kubeconfig**。在 DevOps 项目中，建议使用**用户名和密码**。 +* **用户名**：此处默认用户名为 **admin**。 +* **密码/令牌**：输入您的 GitHub 令牌。 +* **描述**：添加描述信息。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| + +更多关于如何添加凭证的信息，请参阅link:../05-devops-settings/01-credential-management/[凭证管理]。 +|=== +-- + +. 在**凭证**下拉列表中，选择创建的凭证，点击**确定**。 +. 在弹出的 GitHub 仓库中，选择代码仓库，点击**确定**。 + +. 点击代码仓库右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，可以执行以下操作： ++ +-- +* **编辑**：修改代码仓库别名和描述信息，以及重新选择代码仓库。 +* **编辑 YAML**：编辑代码仓库 YAML 文件。 +* **删除**：删除代码仓库。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/01-credential-management.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/01-credential-management.adoc new file mode 100644 index 000000000..4025053ee --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/01-credential-management.adoc @@ -0,0 +1,184 @@ +--- +title: "凭证管理" +keywords: "Kubernetes, {ks_product}, DevOps 项目, 使用 DevOps" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 01 +--- + + +凭证是包含敏感信息的对象，例如用户名和密码、SSH 密钥和令牌 (Token)。当{ks_product_left} DevOps 流水线运行时，会与外部环境中的对象进行交互，以执行一系列任务，包括拉取代码、推送和拉取镜像以及运行脚本等。此过程中需要提供相应的凭证，而这些凭证不会明文出现在流水线中。 + +具有必要权限的 DevOps 项目用户可以为 Jenkins 流水线配置凭证。用户在 DevOps 项目中添加或配置这些凭证后，便可以在 DevOps 项目中使用这些凭证与第三方应用程序进行交互。 + +目前，您可以在 DevOps 项目中创建以下类型的凭证： + +* **用户名和密码**：用户名和密码，可以作为单独的组件处理，或者作为用冒号分隔的字符串（格式为 **username:password**）处理，例如 GitHub 和 GitLab 账户。 + +* **SSH 密钥**：带有私钥的用户名，SSH 公钥/私钥对。 + +* **访问令牌**：具有访问权限的令牌。 + +// * **kubeconfig**：用于配置跨集群认证。 + +本文档演示如何在 DevOps 项目中创建和管理凭证。有关如何使用凭证的更多信息，请参阅link:../../02-pipelines/02-create-a-pipeline-using-jenkinsfile/[使用 Jenkinsfile 创建流水线]和link:../../02-pipelines/01-create-a-pipeline-using-graphical-editing-panel/[使用图形编辑面板创建流水线]。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + +* 已有一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../02-role-and-member-management[角色和成员管理]。 + + +== 创建凭证 + +. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 + +. 点击**企业空间管理**并进入您的 DevOps 项目。 + +. 在左侧导航栏，选择 **DevOps 项目设置 > 凭证**。 + +. 在右侧的**凭证**区域，点击**创建**。 + +. 在弹出的**创建凭证**对话框，输入凭证名称，并选择凭证类型。不同的凭证类型需要设置的参数不同，具体请参考以下内容。 ++ +==== +* 创建用户名和密码凭证 ++ +-- +以创建 GitHub 用户凭证为例，您需要设置以下参数： + +[%header,cols="1a,2a"] +|=== +|参数|描述 + +|名称 +|设置凭证名称，如 **github-id**。 + + +|类型 +|选择**用户名和密码**。 + + +|用户名 +|输入您的 GitHub 用户名。 + +|密码/令牌 +|输入您的 GitHub 令牌。 + +|描述 +|凭证的简介。 +|=== + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +* 自 2021 年 8 月起，GitHub 要求使用基于令牌的身份验证，此处需要输入令牌，而非 GitHub 密码。有关如何生成令牌，请参阅link:https://docs.github.com/cn/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token[创建个人访问令牌]。 + +* 如果您的账户或密码中包含任何特殊字符，例如 **@** 和 **$**，可能会因为无法识别而在流水线运行时导致错误。在这种情况下，您需要先在一些第三方网站（例如 link:https://www.urlencoder.org/[urlencoder]）上对账户或密码进行编码，然后将输出结果复制粘贴作为您的凭证信息。 + +|=== +-- + +* 创建 SSH 密钥凭证 ++ +-- + +[%header,cols="1a,2a"] +|=== +|参数|描述 + +|名称 +|设置凭证名称。 + + +|类型 +|选择**SSH 密钥**。 + + +|用户名 +|输入您的用户名。 + +|私钥 +|输入您的 SSH 密钥。 + +|密码短语 +|输入密码短语。为了更好保护您的账户安全，建议设置该参数。 + +|描述 +|凭证的简介。 +|=== +-- + +* 创建访问令牌凭证 ++ +-- + +[%header,cols="1a,2a"] +|=== +|参数|描述 + +|名称 +|设置凭证名称。 + +|类型 +|选择**访问令牌**。 + +|令牌 +|输入您的令牌。 + +|描述 +|凭证的简介。 +|=== +-- + +// * 创建 kubeconfig 凭证 +// + +// -- +// [%header,cols="1a,2a"] +// |=== +// |参数|描述 + +// |名称 +// |设置凭证名称，例如 **demo-kubeconfig**。 + +// |类型 +// |选择 **kubeconfig**。 + +// |内容 +// |系统自动获取当前 Kubernetes 集群的 kubeconfig 文件内容，并自动填充该字段，您无须做任何更改。但是访问其他集群时，您可能需要更改 kubeconfig。 + +// |描述 +// |凭证的简介。 +// |=== + +// //note +// [.admon.note,cols="a"] +// |=== +// |说明 + +// | +// 用于配置集群访问的文件称为 kubeconfig 文件。这是引用配置文件的通用方法。有关更多信息，请参阅 link:https://kubernetes.io/zh/docs/concepts/configuration/organize-cluster-access-kubeconfig/[Kubernetes 官方文档]。 +// |=== +// -- +==== + + +== 查看和管理凭证 + +. 点击已创建的凭证，进入其详情页面，查看凭证详情和与此凭证相关的所有事件。 + +. 点击**编辑**修改凭证信息，点击**删除**删除凭证。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +编辑凭证时，{ks_product_right}不会显示现有用户名或密码信息。如果输入新的用户名和密码，则前一个将被覆盖。 +|=== + diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/02-role-and-member-management.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/02-role-and-member-management.adoc new file mode 100644 index 000000000..105b3f8ab --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/02-role-and-member-management.adoc @@ -0,0 +1,118 @@ +--- +title: "角色和成员管理" +keywords: "Kubernetes, {ks_product}, DevOps 项目, 使用 DevOps" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 02 +--- + + +本文档演示如何在 DevOps 项目中管理角色和成员。 + +在 DevOps 项目范围内，您可以向角色授予以下资源的权限： + +* DevOps 项目设置 +* 流水线 +* 凭证 +* 持续部署 +* 代码仓库 +* 访问控制 + + +== 前提条件 + +* 已创建一个 DevOps 项目，例如 **demo-devops**。 + +* 已有一个在 DevOps 项目级别具有 **admin** 角色的用户（例如 **devops-admin**）。 + + +== 内置角色 + +在 **DevOps 项目角色**中，有三个可用的内置角色，如下所示。创建 DevOps 项目时，会自动创建内置角色，并且无法编辑或删除这些角色。 + +[%header,cols="1a,4a"] +|=== +|内置角色|描述信息 + +|viewer +|DevOps 项目观察者，查看 DevOps 项目中的所有资源。 + +|operator +|DevOps 项目普通成员，管理 DevOps 凭证和流水线以及查看 DevOps 项目中的成员和角色。 + +|admin +|DevOps 项目管理员，管理 DevOps 项目中的所有资源。 +|=== + + +== 创建 DevOps 项目角色 + +. 以 **devops-admin** 用户登录 {ks_product_both} Web 控制台。 + +. 前往 **DevOps 项目**页面点击一个 DevOps 项目（例如 **demo-devops**）。 ++ +-- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +本文档使用 **devops-admin** 账户作为示例。只要账户被授予的角色包含 DevOps 项目级别**访问控制**中的**成员查看**、**角色管理**和**角色查看**的权限，此账户便可以创建 DevOps 项目角色。 + +|=== +-- + +. 选择 **DevOps 项目设置**中的 **DevOps 项目角色**，点击**创建**。 + +. 设置**名称**。在本示例中，将创建一个名为 **pipeline-creator** 的角色。点击**编辑权限**继续。 + +. 在**流水线**页签，选择您希望授予该角色的权限。例如，为此角色选择**流水线管理**和**流水线查看**。点击**确定**完成操作。 ++ +-- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +**依赖于**表示当前授权项依赖所列出的授权项，勾选该权限后系统会自动选上所有依赖权限。 +|=== +-- + +. 新创建的角色将显示在 **DevOps 项目角色**列表中。点击右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]对其进行编辑。 ++ +-- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +**pipeline-creator** 角色仅被授予**流水线管理**和**流水线查看**权限，可能无法满足您的实际需求。本示例仅用于演示，请根据实际需要创建自定义角色。 + +|=== +-- + + +== 邀请 DevOps 项目成员 + +. 在 **DevOps 项目设置**中选择 **DevOps 项目成员**，然后点击**邀请**。 + +. 点击image:/images/ks-qkcp/zh/icons/add-dark.svg[add,18,18]邀请账户加入此 DevOps 项目，并向此账户授予 **pipeline-creator** 角色。 ++ +-- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +必须先邀请用户加入 DevOps 项目所在的企业空间。 + +|=== +-- + +. 点击**确定**将用户添加到此 DevOps 项目。在 **DevOps 项目成员**页面，将显示新邀请的成员。 + +. 点击项目成员右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，修改现有成员的角色或从 DevOps 项目中删除该用户。 + diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/03-add-cd-allowlist.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/03-add-cd-allowlist.adoc new file mode 100644 index 000000000..a658b52b2 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/03-add-cd-allowlist.adoc @@ -0,0 +1,31 @@ +--- +title: "添加持续部署白名单" +keywords: "Kubernetes, {ks_product}, DevOps 项目, 使用 DevOps" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 03 +--- + + +{ks_product_right}支持通过设置白名单，限制资源持续部署的代码仓库和目标位置。 + +本文档介绍如何添加持续部署白名单。 + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + +* 已有一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。请参阅link:../02-role-and-member-management[角色和成员管理]。 + +* 已link:../../04-import-code-repositories/[导入代码仓库]。 + +== 操作步骤 + +. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 + +. 点击**企业空间管理**并进入您的 DevOps 项目。 + +. 在左侧导航栏，选择 **DevOps 项目设置 > 基本信息**。 + +. 在右侧**基本信息**下的**持续部署白名单**区域，点击**编辑白名单**。 + +. 在弹出的**编辑白名单**对话框，选择代码仓库、部署集群和项目，点击**确定**。点击**添加**可添加多个代码仓库和部署位置。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/04-set-ci-node.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/04-set-ci-node.adoc new file mode 100644 index 000000000..b684eb9aa --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/04-set-ci-node.adoc @@ -0,0 +1,41 @@ +--- +title: "为依赖项缓存设置 CI 节点" +keywords: "Kubernetes, {ks_product}, DevOps 项目, 使用 DevOps" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 04 +--- + + +构建应用程序通常需要拉取不同的依赖项。拉取过程中可能会遇到某些问题，例如拉取时间长、网络不稳定，进而导致构建失败。为了提供更可靠和稳定的环境，可以配置节点或节点组，专门用于持续集成 (CI)，并通过使用缓存来加快构建过程。 + +本文档演示如何设置 CI 节点，以便{ks_product_both}将流水线的任务调度到这些节点。 +// 本文档演示如何设置 CI 节点，以便{ks_product_both}将流水线的任务以及 S2I/B2I 构建的任务调度到这些节点。 + +== 前提条件 + +您需要在{ks_product_both}平台具有**集群管理**权限。 + +== 标记 CI 节点 + +. 以具有**集群管理**权限的账户登录{ks_product_left} Web 控制台。 + +. 点击**集群管理**，进入一个集群。 + +. 在左侧导航栏中选择**节点**下的**集群节点**，查看当前集群中的现有节点。 + +. 从列表中选择一个节点用来运行 CI 任务。点击节点名称转到其详情页面，点击**更多操作** > **编辑标签**。 + +. 在弹出的对话框中，在键为 **node-role.kubernetes.io/worker** 的后面，输入 **ci** 作为此标签的值，点击**确定**。 + + +== 给 CI 节点添加污点 + +流水线一般会根据link:https://kubernetes.io/zh/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity[节点亲和性]来确定是否调度任务到某一节点。如果要将节点专用于 CI 任务，即不允许将其他工作负载调度到该节点，可以在该节点上添加link:https://kubernetes.io/zh/docs/concepts/scheduling-eviction/taint-and-toleration/[污点]。 + +// 流水线和 S2I/B2I 工作流一般会根据link:https://kubernetes.io/zh/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity[节点亲和性]来确定是否调度任务到某一节点。如果要将节点专用于 CI 任务，即不允许将其他工作负载调度到该节点，可以在该节点上添加link:https://kubernetes.io/zh/docs/concepts/scheduling-eviction/taint-and-toleration/[污点]。 + +. 点击**更多操作** > **编辑污点**。 + +. 点击**添加**，输入键 **node.kubernetes.io/ci** 而不指定值。根据需要选择**阻止调度**、**尽可能阻止调度**或**阻止调度并驱逐现有容器组** 。 + +. 点击**确定**。{ks_product_right}将根据您设置的污点调度任务。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/_index.adoc new file mode 100644 index 000000000..db3adb8d2 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/05-devops-settings/_index.adoc @@ -0,0 +1,9 @@ +--- +title: "DevOps 项目设置" +keywords: "Kubernetes, {ks_product}, DevOps 项目, 使用 DevOps" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 05 +--- + + +本节介绍如何管理 DevOps 项目的设置。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/_index.adoc new file mode 100644 index 000000000..4e6251d4c --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/_index.adoc @@ -0,0 +1,9 @@ +--- +title: "使用 DevOps" +keywords: "Kubernetes, {ks_product}, DevOps 项目, 使用 DevOps" +description: "介绍如何使用 DevOps 功能。" +weight: 03 +--- + + +本节介绍如何使用 DevOps 功能。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/04-how-to-integrate/01-sonarqube.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/04-how-to-integrate/01-sonarqube.adoc new file mode 100644 index 000000000..896e9b11e --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/04-how-to-integrate/01-sonarqube.adoc @@ -0,0 +1,372 @@ +--- +title: "将 SonarQube 集成到流水线" +keywords: "Kubernetes, {ks_product}, DevOps 项目" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 01 +--- + + +link:https://www.sonarqube.org/[SonarQube] 是一种主流的代码质量持续检测工具，可用于代码库的静态和动态分析。SonarQube 集成到{ks_product_both}流水线后，如果在运行的流水线中检测到问题，将会在仪表板上直接显示常见代码问题。 + +本文档演示如何将 SonarQube 集成到流水线中。在link:../../03-how-to-use/02-pipelines/02-create-a-pipeline-using-jenkinsfile/[使用 Jenkinsfile 创建流水线]之前，请先阅读本节内容。 + + +== 前提条件 + +{ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + + +== 安装 SonarQube 服务器 + +要将 SonarQube 集成到您的流水线，必须先安装 SonarQube 服务器。 + +. 安装 Helm，以便使用该工具安装 SonarQube。例如，运行以下命令安装 Helm 3： ++ +-- +// Bash +[,bash] +---- +curl https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3|bash +---- + +查看 Helm 版本。 + +// Bash +[,bash] +---- +helm version + +version.BuildInfo{Version:"v3.4.1", GitCommit:"c4e74854886b2efe3321e185578e6db9be0a6e29", GitTreeState:"clean", GoVersion:"go1.14.11"} +---- + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +有关更多信息，请参阅 link:https://helm.sh/zh/docs/intro/install/[Helm 文档]。 +|=== +-- + +. 执行以下命令安装 SonarQube 服务器。 ++ +-- +// Bash +[,bash] +---- + +helm upgrade --install sonarqube sonarqube --repo https://charts.kubesphere.io/main -n \ +kubesphere-devops-system --create-namespace --set service.type=NodePort + +---- + +// Note +[.admon.note,cols="a"] +|=== +|说明 + +| + +请确保使用 Helm 3 安装 SonarQube 服务器。 +|=== +-- + + +== 获取 SonarQube 控制台地址 + +. 执行以下命令获取 SonarQube NodePort。 ++ +-- +// Bash +[,bash] +---- +export NODE_PORT=$(kubectl get --namespace kubesphere-devops-system -o jsonpath="{.spec.ports[0].nodePort}" services sonarqube-sonarqube) + +export NODE_IP=$(kubectl get nodes --namespace kubesphere-devops-system -o jsonpath="{.items[0].status.addresses[0].address}") + +echo http://$NODE_IP:$NODE_PORT +---- +-- + +. 预期输出结果：（您的 NodeIP 和 NodePort 应该不同） ++ +-- +// Bash +[,bash] +---- +http://10.77.1.201:31377 +---- +-- + + +== 配置 SonarQube 服务器 + +=== 步骤 1：访问 SonarQube 控制台 + +. 执行以下命令查看 SonarQube 的状态。注意，只有在 SonarQube 启动并运行后才能访问 SonarQube 控制台。 ++ +-- +// Bash +[,bash] +---- +kubectl get pod -n kubesphere-devops-system +---- +-- + +. 在浏览器中访问 SonarQube 控制台 link:http://NodeIP:NodePort[]。 + +. 点击右上角的 **Log in**，然后使用默认账户 **admin/admin** 登录。 ++ +-- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| + +取决于实例的部署位置，您可能需要设置必要的端口转发规则，并在您的安全组中放行该端口，以便访问 SonarQube。 +|=== +-- + +=== 步骤 2：创建 SonarQube 管理员令牌 (Token) + +. 点击右上角字母 **A**，然后从菜单中选择 **My Account** 以转到 **Profile** 页面。 + +. 点击 **Security** 并输入令牌名称，例如 **kubesphere**。 + +. 点击 **Generate** 并复制此令牌。 ++ +-- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +如提示所示，您无法再次查看此令牌，因此请确保复制成功。 +|=== +-- + +=== 步骤 3：创建 Webhook 服务器 + +. 执行以下命令获取 SonarQube Webhook 的地址。 ++ +-- +// Bash +[,bash] +---- + +export NODE_PORT=$(kubectl get --namespace kubesphere-devops-system -o jsonpath="{.spec.ports[0].nodePort}" services devops-jenkins) + +export NODE_IP=$(kubectl get nodes --namespace kubesphere-devops-system -o jsonpath="{.items[0].status.addresses[0].address}") + +echo http://$NODE_IP:$NODE_PORT/sonarqube-webhook/ + +---- +-- + +. 预期输出结果： ++ +-- +// Bash +[,bash] +---- + +http://10.77.1.201:30180/sonarqube-webhook/ + +---- +-- + +. 依次点击 **Administration**、**Configuration** 和 **Webhooks** 创建一个 Webhook。 + +. 点击 **Create**。 + +. 在弹出的对话框中输入 **Name** 和 **Jenkins Console URL**（即 SonarQube Webhook 地址）。点击 **Create** 完成操作。 + +=== 步骤 4：将 SonarQube 配置添加到 ks-installer + +. 执行以下命令编辑 **ks-installer**。 ++ +-- +// Bash +[,bash] +---- + +kubectl edit cc -n kubesphere-system ks-installer + +---- +-- + +. 搜寻至 **devops**。添加字段 **sonarqube** 并在其下方指定 **externalSonarUrl** 和 **externalSonarToken**。 ++ +-- +[,yaml] +---- +devops: + enabled: true + jenkinsJavaOpts_MaxRAM: 2g + jenkinsJavaOpts_Xms: 512m + jenkinsJavaOpts_Xmx: 512m + jenkinsMemoryLim: 2Gi + jenkinsMemoryReq: 1500Mi + jenkinsVolumeSize: 8Gi + sonarqube: # Add this field manually. + externalSonarUrl: http://10.77.1.201:31377 # The SonarQube IP address. + externalSonarToken: 00ee4c512fc987d3ec3251fdd7493193cdd3b91d # The SonarQube admin token created above. + +---- +-- + +. 完成操作后保存此文件。 + +=== 步骤 5：将 SonarQube 服务器添加至 Jenkins + +. 执行以下命令获取 Jenkins 的地址。 ++ +-- +// Bash +[,bash] +---- + +export NODE_PORT=$(kubectl get --namespace kubesphere-devops-system -o jsonpath="{.spec.ports[0].nodePort}" services devops-jenkins) + +export NODE_IP=$(kubectl get nodes --namespace kubesphere-devops-system -o jsonpath="{.items[0].status.addresses[0].address}") + +echo http://$NODE_IP:$NODE_PORT + +---- +-- + +. 获取 Jenkins 的端口号。 ++ +-- +// Bash +[,bash] +---- + +http://10.77.1.201:30180 + +---- +-- + +. 使用地址 link:http://NodeIP:30180[] 访问 Jenkins。 ++ +-- +安装 DevOps 时，默认情况下也会安装 Jenkins 仪表板。此外，Jenkins 还配置有{ks_product_left} LDAP，这意味着您可以直接使用{ks_product_both}账户登录 Jenkins。有关配置 Jenkins 的更多信息，请参阅 link:../../03-how-to-use/02-pipelines/07-jenkins-setting/[Jenkins 系统设置]。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +取决于实例的部署位置，您可能需要设置必要的端口转发规则，并在您的安全组中放行端口 **30180**，以便访问 Jenkins。 + +|=== +-- + +. 点击左侧导航栏中的**系统管理**。 + +. 向下滚动并点击**系统配置**。 + +. 搜寻到 **SonarQube servers**，然后点击 **Add SonarQube**。 + +. 输入 **Name** 和 **Server URL** (link:http://NodeIP:NodePort[])。 点击**添加**，选择 **Jenkins**，然后在弹出的对话框中用 SonarQube 管理员令牌创建凭证（如下方第二张截图所示）。创建凭证后，从 **Server authentication token** 旁边的下拉列表中选择该凭证。点击**应用**完成操作。 ++ +-- +image:/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-jenkins-settings.png[,100%] + +image:/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/add-credentials.png[,100%] + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +如果点击**添加**按钮无效，前往**系统管理**下的 **Manage Credentials** 并点击 **Stores scoped to Jenkins** 下的 **Jenkins**，再点击**全局凭据 (unrestricted)**，然后点击左侧导航栏的**添加凭据**，参考上方第二张截图用 SonarQube 管理员令牌添加凭证。添加凭证后，从 **Server authentication token** 旁边的下拉列表中选择该凭证。 + +|=== +-- + +=== 步骤 6：将 sonarqubeURL 添加到{ks_product_both}控制台 + +您需要指定 **sonarqubeURL**，以便可以直接从{ks_product_both} Web 控制台访问 SonarQube。 + +. 执行以下命令： ++ +-- +// Bash +[,bash] +---- + +kubectl editcm -n kubesphere-system ks-console-config + +---- +-- + +. 搜寻到 **data:client:enableKubeConfig**，在下方添加 **devops** 字段并指定 **sonarqubeURL**。 ++ +-- +[,yaml] +---- +client: + enableKubeConfig: true + devops: # 手动添加该字段。 + sonarqubeURL: http://10.77.1.201:31377 # SonarQube IP 地址。 + +---- +-- + +. 保存该文件。 + +=== 步骤 7：重启服务 + +执行以下命令重启服务。 + +// Bash +[,bash] +---- + +kubectl -n kubesphere-devops-system rollout restart deploy devops-apiserver + +---- + +// Bash +[,bash] +---- + +kubectl -n kubesphere-system rollout restart deploy ks-console + +---- + + +== 为新项目创建 SonarQube Token + +创建一个 SonarQube 令牌，以便流水线在运行时可以与 SonarQube 通信。 + +. 在 SonarQube 控制台上，点击 **Create new project**。 ++ +image:/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-create-project.png[,100%] + +. 输入项目密钥，例如 **java-demo**，然后点击 **Set Up**。 ++ +image:/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/jenkins-projet-key.png[,100%] + +. 输入项目名称，例如 **java-sample**，然后点击 **Generate**。 ++ +image:/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/generate-a-token.png[,100%] + +. 创建令牌后，点击 **Continue**。 ++ +image:/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/token-created.png[,100%] + +. 分别选择 **Java** 和 **Maven**，复制下图所示绿色框中的序列号。如果要在流水线中使用，则需要在link:../../03-how-to-use/05-devops-settings/01-credential-management/[凭证]中添加此序列号。 ++ +image:/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-example.png[,100%] + +== 在{ks_product_both}控制台查看结果 + +link:../../03-how-to-use/02-pipelines/02-create-a-pipeline-using-jenkinsfile/[使用 Jenkinsfile 创建流水线]或link:../../03-how-to-use/02-pipelines/01-create-a-pipeline-using-graphical-editing-panel/[使用图形编辑面板创建流水线]之后，即可查看代码质量分析的结果。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/04-how-to-integrate/02-harbor.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/04-how-to-integrate/02-harbor.adoc new file mode 100644 index 000000000..c17440db7 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/04-how-to-integrate/02-harbor.adoc @@ -0,0 +1,171 @@ +--- +title: "将 Harbor 集成到流水线" +keywords: "Kubernetes, {ks_product}, DevOps 项目" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 02 +--- + +本文档演示如何将 Harbor 集成到{ks_product_both}流水线。 + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **DevOps** 扩展组件。 + +* 已有一个企业空间、一个 DevOps 项目和一个用户 (例如 **project-regular**)，并已邀请该用户至 DevOps 项目且授予 **operator** 角色。 + +== 安装 Harbor + +执行以下命令，使用 Helm 3 安装 Harbor。 + +// Bash +[,bash] +---- + +helm repo add harbor https://helm.goharbor.io +# 如需快速安装，您可以通过 NodePort 暴露 Harbor 并禁用 tls。 +# 请将 externalURL 设置为您的一个节点 IP，并确保 Jenkins 能够访问它。 +helm install harbor-release harbor/harbor --set expose.type=nodePort,externalURL=http://$ip:30002,expose.tls.enabled=false + +---- + +== 获取 Harbor 凭证 + +. 安装 Harbor 后，访问 **:30002** 并使用默认账户和密码 (**admin/Harbor12345**) 登录 Web 控制台。 + +. 在左侧导航栏中点击**项目**，然后点击**新建项目**。 + +. 在弹出的对话框中，设置项目名称 **ks-devops-harbor** 并点击**确定**。 + +. 点击刚刚创建的项目，在**机器人账户**页签下点击**添加机器人账户**。 + +. 在弹出的对话框中，为机器人账户设置名称 **robot-test** 并点击**添加**。请确保在**权限**中勾选推送制品的权限选框。 + +. 在弹出的对话框中，点击**导出到文件中**，保存该令牌。 + +== 启用 Insecure Registry + +配置 Docker，使其忽略您 Harbor 仓库的安全性。 + +. 在您的主机上运行 **vim /etc/docker/daemon.json** 命令以编辑 **daemon.json** 文件，输入以下内容并保存更改。 ++ +-- +[,json] +---- +{ + "insecure-registries" : ["103.61.38.55:30002"] +} +---- + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +请将 **103.61.38.55:30002** 替换为您自己的 Harbor 仓库地址。对于 Linux，**daemon.json** 文件的路径为 **/etc/docker/daemon.json**；对于 Windows，该文件的路径为 **C:\ProgramData\docker\config\daemon.json**。 +|=== +-- + +. 运行以下命令重启 Docker，使更改生效。 ++ +-- +[,bash] +---- +sudo systemctl daemon-reload + +sudo systemctl restart docker +---- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +建议您在隔离的测试环境或者严格控制的离线环境中使用该方案。有关更多信息，请参阅 link:https://docs.docker.com/registry/insecure/#deploy-a-plain-http-registry[Deploy a plain HTTP registry]。完成上述操作后，即可在项目中部署工作负载时使用您 Harbor 仓库中的镜像。您需要为自己的 Harbor 仓库创建一个镜像密钥，然后在**容器镜像**页签下的**容器设置**中，选择您的 Harbor 仓库并输入镜像的绝对路径以搜索您的镜像。 + +|=== +-- + +== 创建凭证 + +. 以 **project-regular** 用户登录{ks_product_both} Web 控制台。 +. 点击**企业空间管理**并进入您的 DevOps 项目。 +. 在 **DevOps 项目设置**下的**凭证**页面为 Harbor 创建凭证。 +. 在**创建凭证**页面，设置凭证 ID (**robot-test**)，**类型**选择**用户名和密码**，**用户名**字段必须和您刚刚下载的 JSON 文件中 **name** 的值相同，并在**密码/令牌**中输入 Harbor 令牌文件中 **token** 的值。 + +. 点击**确定**以保存。 + +== 创建流水线 + +. 转到**流水线**页面，点击**创建**。 + +. 在**基本信息**页签，输入名称 **demo-pipeline**，然后点击**下一步**。 + +. **高级设置**中使用默认值，点击**创建**。 + +== 编辑 Jenkinsfile + +. 点击该流水线进入其详情页面，然后点击**编辑 Jenkinsfile**。 + +. 将以下内容复制粘贴至 Jenkinsfile。注意，必须将 **REGISTRY**、**HARBOR_NAMESPACE**、**APP_NAME** 和 **HARBOR_CREDENTIAL** 替换为您自己的值。 ++ +-- +[,json] +---- + +pipeline { + agent { + node { + label 'maven' + } + } + + environment { + // 您 Harbor 仓库的地址。 + REGISTRY = '103.61.38.55:30002' + // 项目名称。 + // 请确保您的机器人账户具有足够的项目访问权限。 + HARBOR_NAMESPACE = 'ks-devops-harbor' + // Docker 镜像名称。 + APP_NAME = 'docker-example' + // ‘robot-test’是您在{ks_product_both} Web 控制台上创建的凭证 ID。 + HARBOR_CREDENTIAL = credentials('robot-test') + } + + stages { + stage('docker login') { + steps{ + container ('maven') { + // 请替换 -u 后面的 Docker Hub 用户名，不要忘记加上 ''。您也可以使用 Docker Hub 令牌。 + sh '''echo $HARBOR_CREDENTIAL_PSW|docker login $REGISTRY -u 'robot$robot-test' --password-stdin''' + } + } + } + + stage('build & push') { + steps { + container ('maven') { + sh 'git clone https://github.com/kstaken/dockerfile-examples.git' + sh 'cd dockerfile-examples/rethinkdb && docker build -t $REGISTRY/$HARBOR_NAMESPACE/$APP_NAME:devops-test .' + sh 'docker push$REGISTRY/$HARBOR_NAMESPACE/$APP_NAME:devops-test' + } + } + } + } +} + +---- + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +您可以通过带有环境变量的 Jenkins 凭证来传送参数至 **docker login -u**。但是，每个 Harbor 机器人账户的用户名都包含一个 **$** 字符，当用于环境变量时，Jenkins 会将其转换为 **$$**。（Harbor v2.2以后可以自定义机器人后缀，避免此类问题）link:https://number1.co.za/rancher-cannot-use-harbor-robot-account-imagepullbackoff-pull-access-denied/[了解更多]。 +|=== +-- + +== 运行流水线 + +保存 Jenkinsfile 后，{ks_product_right}会自动在图形编辑面板上创建所有阶段和步骤。点击**运行**来运行该流水线。如果一切运行正常，Jenkins 将推送镜像至您的 Harbor 仓库。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/04-how-to-integrate/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/04-how-to-integrate/_index.adoc new file mode 100644 index 000000000..999e211a8 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/04-how-to-integrate/_index.adoc @@ -0,0 +1,9 @@ +--- +title: "工具集成" +keywords: "Kubernetes, {ks_product}, DevOps 项目" +description: "介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中管理流水线和 DevOps 项目设置。" +weight: 04 +--- + + +本节介绍如何将第三方工具与流水线集成。 diff --git a/content/zh/docs/v4.1/11-use-extensions/01-devops/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/01-devops/_index.adoc new file mode 100644 index 000000000..076f43a5b --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/01-devops/_index.adoc @@ -0,0 +1,15 @@ +--- +title: "DevOps" +keywords: "Kubernetes, {ks_product}, DevOps" +description: "如何在 DevOps 项目中进行管理和操作，包括运行流水线、创建凭证和集成工具等。" +weight: 01 +--- + + +DevOps 支持在 Kubernetes 集群上部署和管理 CI/CD 任务以及相关的工作负载。安装 DevOps 扩展组件时，会自动部署 Jenkins，支持通过 Jenkinsfile 构建流水线。此外，DevOps 还提供图形编辑面板，将整个流程可视化，直观地呈现流水线在每个阶段的运行状态。 + +安装 DevOps 扩展组件后，企业空间左侧导航栏将显⽰ **DevOps 项⽬**。 + +本节介绍如何管理 DevOps 项目，以及如何在 DevOps 项目中进行管理和操作，包括运行流水线、创建凭证和集成工具等。 + + diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/01-create-an-app-template.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/01-create-an-app-template.adoc new file mode 100644 index 000000000..cad259ebb --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/01-create-an-app-template.adoc @@ -0,0 +1,62 @@ +--- +title: "创建应用模板" +keywords: "Kubernetes, {ks_product}, 企业空间,应用模板, 创建应用模板" +description: "介绍如何创建应用模板。" +weight: 01 +--- + +:ks_permission: **应用/应用版本/应用实例创建** +:ks_navigation: **应用管理 > 应用模板** + +本节介绍如何创建应用模板。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + +* 已准备 .tar.gz 或 .tgz 格式的 Helm Chart 压缩包，或应用的 yaml 文件。您可以link:https://kubesphere.io/files/application-templates/nginx-0.1.0.tgz[下载 Nginx Helm Chart] 用于测试。有关更多信息，请参阅 link:https://helm.sh/zh/docs/topics/charts/[Helm 官方文档]。 + + +== 操作步骤 + +include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**创建应用**对话框，点击**上传 Helm Chart**，选择本地存储的 .tar.gz 或 .tgz 格式的 Helm Chart 压缩包。 ++ +或者点击**创建 yaml 应用**，输入应用名称和版本号，使用 yaml 文件创建应用。 ++ +-- +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +点击image:/images/ks-qkcp/zh/icons/upload-dark-white.svg[upload-dark,18,18]可从本地上传 yaml 文件。 + +点击image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download-dark,18,18]可将 yaml 文件下载到本地。 +|=== +-- + +. 点击**确定**。 ++ +-- +应用模板创建完成后将显示在应用模板列表中。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/02-view-an-app-template-list.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/02-view-an-app-template-list.adoc new file mode 100644 index 000000000..4401f7d8c --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/02-view-an-app-template-list.adoc @@ -0,0 +1,63 @@ +--- +title: "查看应用模板列表" +keywords: "Kubernetes, {ks_product}, 企业空间,应用模板, 查看应用模板列表" +description: "介绍如何查看应用模板列表。" +weight: 02 +--- + +:ks_permission: **应用/应用版本/应用实例查看** +:ks_navigation: **应用管理 > 应用模板** + +本节介绍如何查看应用模板列表。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] ++ +==== +* 应用模板列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-appTemplateName.adoc[] + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-status_v4.adoc[] + +|企业空间 +|应用模板所属的企业空间。 + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-latestVersion_v4.adoc[] + +|应用模板 +|应用模板的类型，如 **helm 应用**或 **yaml 应用**。 + +|更新时间 +|应用模板的更新时间。 +|=== +-- + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-searchForAppTemplates.adoc[] + +include::../../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/03-view-app-template-details.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/03-view-app-template-details.adoc new file mode 100644 index 000000000..381ec5e79 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/03-view-app-template-details.adoc @@ -0,0 +1,106 @@ +--- +title: "查看应用模板详情" +keywords: "Kubernetes, {ks_product}, 企业空间,应用模板, 查看应用模板详情" +description: "介绍如何查看应用模板列表。" +weight: 03 +--- + + +:ks_permission: **应用/应用版本/应用实例查看** +:ks_navigation: **应用管理 > 应用模板** + + +本节介绍如何查看应用模板详情。 + + +== 前提条件 + + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] + ++ + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-viewAttributes.adoc[] ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|应用 ID +|应用名称。 + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-status_v4.adoc[] + +|分类 +|应用模板所属的分类，需手动设置。有关更多信息，请参阅link:../04-edit-app-template-information/[编辑应用模板信息]。 + +|类型 +|应用模板的类型，如 **helm 应用**或 **yaml 应用**。 + +|企业空间 +|应用模板所属的企业空间。 + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-creationTime.adoc[] +|=== +-- + ++ + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-viewVersions.adoc[] ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|状态 +|应用版本当前的状态。 + +* **未提交**：应用版本已上传到企业空间，但未提交给{ks_product_both}平台的应用商店管理员审核。 + +* **已提交**：应用版本已提交给{ks_product_both}平台的应用商店管理员审核。 + +* **已发布**：应用版本已获得{ks_product_both}平台的应用商店管理员的批准，可以上架到应用商店。 + +* **已拒绝**：应用版本未获得{ks_product_both}平台的应用商店管理员的批准，审核不通过。 + +* **未发布**：应用版本发布后被应用商店管理员取消发布，或应用版本上架到{ks_product_both}平台的应用商店后被应用商店管理员下架。 + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-version.adoc[] + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-developer.adoc[] + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-versionUpdateTime.adoc[] +|=== +-- + ++ +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-viewAppInformation.adoc[] + ++ + +// include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-viewAppReviewRecords.adoc[] + ++ + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-viewAppInstances.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/04-edit-app-template-information.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/04-edit-app-template-information.adoc new file mode 100644 index 000000000..da9277afa --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/04-edit-app-template-information.adoc @@ -0,0 +1,70 @@ +--- +title: "编辑应用模板信息" +keywords: "Kubernetes, {ks_product}, 企业空间,应用模板, 编辑应用模板信息" +description: "介绍如何编辑应用模板信息。" +weight: 04 +--- + +:ks_permission: **应用/应用版本/应用实例管理** +:ks_navigation: **应用管理 > 应用模板** + + +本节介绍如何编辑应用模板信息。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] + ++ + +. 在应用模板详情页面左上角点击**编辑**。 + +. 在**编辑信息**对话框设置应用模板的参数，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|应用的别名。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|应用的描述信息。描述可包含任意字符，最长 120 个字符。 + +|图标 +|应用的图标。如果未设置应用模板的图标，系统将默认使用应用名称第一个字符大写作为图标。图标格式必须为 .png 或 .jpg，不能超过 96 x 96 像素和 20 KB。 + +|应用分类 +|应用的功能分类。应用模板在上传到应用商店后将被自动划分到此处选择的分类下。 + +|服务商网站 +|服务商的网站地址。从应用商店安装应用的用户可联系服务商获取技术支持。 + +|应用截图 +|应用的介绍图片。最多支持上传 6 张截图，每张截图大小不能超过 2 MB。 + +|应用介绍 +|应用的介绍信息。支持输入 markdown 格式的图文介绍。 +|=== +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/05-install-an-app-by-using-an-app-template.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/05-install-an-app-by-using-an-app-template.adoc new file mode 100644 index 000000000..e8aac10ef --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/05-install-an-app-by-using-an-app-template.adoc @@ -0,0 +1,82 @@ +--- +title: "使用应用模板安装应用" +keywords: "Kubernetes, {ks_product}, 企业空间, 应用模板, 使用应用模板安装应用" +description: "介绍如何使用应用模板安装应用。" +weight: 05 +--- + +:ks_permission: **应用/应用版本/应用实例管理** +:ks_navigation: **应用管理 > 应用模板** + + +本节介绍如何在企业空间中使用应用模板安装应用。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] + ++ + +. 在应用模板详情页面右侧的**版本**页签，点击所需的应用版本，然后在展开的区域中点击**部署**。 + +. 在弹出的**位置**对话框，选择应用的安装位置，然后点击**确定**。 + +. 在**基本信息**页签，设置应用的基本信息，然后点击**下一步**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|用户自定义的应用名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母开头并以小写字母或数字结尾，最长 32 个字符。 + +|版本 +|需要安装的应用版本。 + +|描述 +|应用的描述信息。描述可包含任意字符，最长 256 个字符。 + +|位置 +|应用所属的集群和项目。应用所属的企业空间默认为应用模板所属的企业空间。 +|=== +-- + +. 在**应用设置**页签，根据需要修改应用的参数设置，然后点击**安装**。 ++ +-- +// Note +include::../../../../../../_ks_components/admonitions/note.adoc[] + +{ks_product_right}的应用模板功能底层基于 Helm Chart 实现。**应用设置**页签的参数设置应符合 Helm Chart 的 Values 文件规范。有关更多信息，请参阅 link:https://helm.sh/zh/docs/chart_template_guide/values_files/[Helm 官方文档]。 + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] + +ifeval::["{file_output_type}" == "html"] +应用安装完成后，即可在目标项目中查看已安装的应用。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +应用安装完成后，即可在目标项目中查看已安装的应用。有关更多信息，请参阅《{ks_product_full_right}项目管理指南》的“应用”章节。 +endif::[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/06-upload-an-app-version.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/06-upload-an-app-version.adoc new file mode 100644 index 000000000..8abf2562f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/06-upload-an-app-version.adoc @@ -0,0 +1,47 @@ +--- +title: "上传应用版本" +keywords: "Kubernetes, {ks_product}, 企业空间, 应用模板, 上传应用版本" +description: "介绍如何在应用模板创建后上传应用版本。" +weight: 06 +--- + + +:ks_permission: **应用/应用版本/应用实例管理** +:ks_navigation: **应用管理 > 应用模板** + + +本节介绍如何在应用模板创建后上传应用版本。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + +* 已准备 .tar.gz 或 .tgz 格式的 Helm Chart 压缩包。有关更多信息，请参阅 link:https://helm.sh/zh/docs/topics/charts/[Helm 官方文档]。 + + +== 操作步骤 + +include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] + +. 在应用模板详情页面右侧的**版本**页签，点击**上传版本**。 + +. 在弹出的对话框中，点击**上传 Helm Chart**，选择本地存储的 .tar.gz 或 .tgz 格式 Helm Chart 压缩包，然后点击**确定**。 ++ +-- +应用新版本上传完成后将显示在应用模板详情页面的**版本**页签。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/08-delete-an-app-version.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/08-delete-an-app-version.adoc new file mode 100644 index 000000000..40a68d38d --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/08-delete-an-app-version.adoc @@ -0,0 +1,50 @@ +--- +title: "删除应用版本" +keywords: "Kubernetes, {ks_product}, 企业空间, 应用模板, 删除应用版本" +description: "介绍如何在应用模板中删除应用版本。" +weight: 08 +--- + +:ks_permission: **应用/应用版本/应用实例删除** +:ks_navigation: **应用管理 > 应用模板** + + +本节介绍如何在应用模板中删除应用版本。 + +// Warning +include::../../../../../../_ks_components/admonitions/warning.adoc[] + +应用版本删除后无法恢复，请谨慎执行此操作。 + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + +* 如果需要删除的应用版本已上架到应用商店，您需要联系应用商店管理员将应用版本下架。 + + + +== 操作步骤 + +include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] + ++ + +. 在应用模板详情页面右侧的**版本**页签，点击需要删除的应用版本，在展开的区域中点击**删除**，然后在弹出的对话框点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/09-download-a-helm-chart-package.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/09-download-a-helm-chart-package.adoc new file mode 100644 index 000000000..174861b72 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/09-download-a-helm-chart-package.adoc @@ -0,0 +1,44 @@ +--- +title: "下载 Helm Chart 压缩包" +keywords: "Kubernetes, {ks_product}, 企业空间, 应用模板, 下载 Helm Chart 压缩包" +description: "介绍如何下载应用版本的 Helm Chart 压缩包。" +weight: 09 +--- + + +:ks_permission: **应用/应用版本/应用实例查看** +:ks_navigation: **应用管理 > 应用模板** + + +本节介绍如何下载应用版本的 Helm Chart 压缩包。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + +== 操作步骤 + +include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] + ++ + +. 在应用模板详情页面右侧的**版本**页签，点击所需的应用版本，然后在展开的区域中点击**下载**。 ++ +-- +应用版本的 Helm Chart 压缩包将通过浏览器下载到本地。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/10-release-an-app-version-to-the-app-store.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/10-release-an-app-version-to-the-app-store.adoc new file mode 100644 index 000000000..9cd19dfa7 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/10-release-an-app-version-to-the-app-store.adoc @@ -0,0 +1,53 @@ +--- +title: "将应用版本发布到应用商店" +keywords: "Kubernetes, {ks_product}, 企业空间, 应用模板, 将应用版本发布到应用商店" +description: "介绍如何将应用模板发布到应用商店。" +weight: 10 +--- + +:ks_permission: **应用/应用版本/应用实例管理** +:ks_navigation: **应用管理 > 应用模板** + + +本节介绍如何将应用版本发布到应用商店。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] + ++ + +. 在应用模板详情页面右侧的**版本**页签，点击需要发布的应用版本，然后在展开的区域中点击**提交审核**。 + +. 待应用商店管理员审核通过并将其上架后，在页面左上角点击**应用商店**，即可在应用商店中查看已上架的应用版本。 ++ +-- +// Note +include::../../../../../../_ks_components/admonitions/note.adoc[] + +* 审核通过后，应用版本的状态将变为**已发布**，表示可以被应用商店管理员上架到应用商店。上架后，所有项目成员才可以从应用商店将应用版本安装到项目中。 + +* 有关应用审核和上架的更多信息，请参阅link:../../../03-app-store-management/[应用商店管理]。 + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/11-delete-an-app-template.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/11-delete-an-app-template.adoc new file mode 100644 index 000000000..f9b062008 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/11-delete-an-app-template.adoc @@ -0,0 +1,47 @@ +--- +title: "删除应用模板" +keywords: "Kubernetes, {ks_product}, 企业空间, 应用模板, 删除应用模板" +description: "介绍如何删除应用模板。" +weight: 11 +--- + + +:ks_permission: **应用/应用版本/应用实例删除** +:ks_navigation: **应用管理 > 应用模板** + + +本节介绍如何删除应用模板。 + +// Warning +include::../../../../../../_ks_components/admonitions/warning.adoc[] + +应用模板删除后无法恢复，请谨慎执行此操作。 + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + +// * 已删除应用模板中的所有应用版本。有关更多信息，请参阅link:../08-delete-an-app-version/[删除应用版本]。 + +== 操作步骤 + +include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要删除的应用模板右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除应用模板**对话框，输入应用模板的名称，然后点击**确定**。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/_index.adoc new file mode 100644 index 000000000..751164f42 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/01-app-templates/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "应用模板" +keywords: "Kubernetes, {ks_product}, 企业空间, 应用管理, 应用模板" +description: "介绍如何管理应用模板。" +weight: 01 +--- + +本节介绍如何管理企业空间的应用模板。 + +每个应用模板可包含一个或多个由 Helm Chart 定义的应用版本。您可以将 Helm Chart 作为应用模板上传到企业空间，从而在企业空间中的所有项目使用该应用模板安装应用。您也可以进一步将应用模板上传到应用商店，从而在{ks_product_both}平台的所有项目安装应用。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/_index.adoc new file mode 100644 index 000000000..144d5395e --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/02-app-management/_index.adoc @@ -0,0 +1,21 @@ +--- +title: "应用管理" +keywords: "Kubernetes, {ks_product}, 企业空间, 应用管理, 应用模板" +description: "介绍如何上通过企业空间管理应用模板。" +weight: 02 +--- + + +在{ks_product_both}平台，应用特指由一个或多个工作负载、服务、应用路由等资源组成的业务程序。{ks_product_right}平台的应用模板功能底层基于 Helm 实现，通过 Helm Chart 定义应用的编排方式。 + +您可以在企业空间中创建包含一个或多个应用版本的应用模板（每个应用版本由一个 Helm Chart 定义），从而在企业空间的项目中安装应用模板中定义的应用。 + +ifeval::["{file_output_type}" == "html"] +有关企业空间中应用仓库的更多信息，请参阅link:../../../08-workspace-management/05-app-management/02-app-repositories/[应用仓库]。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +有关企业空间中应用仓库的更多信息，请参阅《{ks_product_right}企业空间管理指南》的“应用仓库”章节。 +endif::[] + +有关 Helm 的更多信息，请参阅 link:https://helm.sh/zh/docs/[Helm 官方文档]。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/01-view-an-app-template-list.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/01-view-an-app-template-list.adoc new file mode 100644 index 000000000..a343aff91 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/01-view-an-app-template-list.adoc @@ -0,0 +1,69 @@ +--- +title: "查看应用模板列表" +keywords: "Kubernetes, {ks_product}, 应用商店管理, 应用, 查看应用模板列表" +description: "介绍如何查看应用模板列表。" +weight: 01 +--- + +:ks_permission: **应用商店管理** +:ks_navigation: **应用** + + +本节介绍如何查看应用商店中的应用模板列表。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] ++ +==== +* **应用**页面显示应用商店中的应用模板，并提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-appTemplateName.adoc[] + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-status_v4.adoc[] + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-workspace.adoc[] + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-latestVersion_v4.adoc[] + + +// |分类 +// |应用模板所属的分类。将应用模板分配到一个分类中以便于管理。有关更多信息，请参阅link:../../02-app-categories/[应用分类]。 + +|应用模板 +|应用模板的类型，如 **helm 应用**或 **yaml 应用**。 + +|更新时间 +|应用模板的更新时间。 +|=== +-- + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-searchForAppTemplates.adoc[] + +include::../../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/02-view-app-template-details.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/02-view-app-template-details.adoc new file mode 100644 index 000000000..97911e66c --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/02-view-app-template-details.adoc @@ -0,0 +1,105 @@ +--- +title: "查看应用模板详情" +keywords: "Kubernetes, {ks_product}, 应用商店管理, 应用, 查看应用模板详情" +description: "介绍如何查看应用模板详情。" +weight: 02 +--- + +:ks_permission: **应用商店管理** +:ks_navigation: **应用** + + +本节介绍如何查看应用模板详情。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] + ++ + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-viewAttributes.adoc[] ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|应用 ID +|应用名称。 + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-status_v4.adoc[] + +|分类 +|应用模板所属的分类。将应用模板分配到一个分类中以便于管理。有关更多信息，请参阅link:../../02-app-categories/[应用分类]。 + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-type.adoc[] + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-workspace.adoc[] + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-creationTime.adoc[] +|=== +-- + ++ + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-viewVersions.adoc[] ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|状态 +|应用版本当前的状态。 + +* **未提交**：应用版本已上传到企业空间，但未提交给{ks_product_both}平台的应用商店管理员审核。 + +* **已提交**：应用版本已提交给{ks_product_both}平台的应用商店管理员审核。 + +* **已发布**：应用版本已获得{ks_product_both}平台的应用商店管理员的批准，可以上架到应用商店。 + +* **已拒绝**：应用版本未获得{ks_product_both}平台的应用商店管理员的批准，审核不通过。 + +* **未发布**：应用版本发布后被应用商店管理员取消发布，或应用版本上架到{ks_product_both}平台的应用商店后被应用商店管理员下架。 + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-version.adoc[] + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-developer.adoc[] + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-versionUpdateTime.adoc[] +|=== +-- + ++ + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-viewAppInformation.adoc[] + ++ + +// include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-viewAppReviewRecords.adoc[] + ++ + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-viewAppInstances.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/04-edit-an-app-template.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/04-edit-an-app-template.adoc new file mode 100644 index 000000000..4fd8c66a8 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/04-edit-an-app-template.adoc @@ -0,0 +1,64 @@ +--- +title: "编辑应用模板" +weight: 04 +--- + +:ks_permission: **应用商店管理** +:ks_navigation: **应用** + + +本节介绍如何编辑应用商店中的应用模板信息。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + +. 在需要编辑的应用模板右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑**。 + +. 在**编辑信息**对话框设置应用模板的参数，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|应用的别名。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|应用的描述信息。描述可包含任意字符，最长 120 个字符。 + +|图标 +|应用的图标。如果未设置应用模板的图标，系统将默认使用应用名称第一个字符大写作为图标。图标格式必须为 .png 或 .jpg，不能超过 96 x 96 像素和 20 KB。 + +|应用分类 +|应用的功能分类。应用模板在上传到应用商店后将被自动划分到此处选择的分类下。 + +|服务商网站 +|服务商的网站地址。从应用商店安装应用的用户可联系服务商获取技术支持。 + +|应用截图 +|应用的介绍图片。最多支持上传 6 张截图，每张截图大小不能超过 2 MB。 + +|应用介绍 +|应用的介绍信息。支持输入 markdown 格式的图文介绍。 +|=== +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/06-publish-an-app-template.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/06-publish-an-app-template.adoc new file mode 100644 index 000000000..af4483bd3 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/06-publish-an-app-template.adoc @@ -0,0 +1,47 @@ +--- +title: "上架应用模板" +weight: 06 +--- + +:ks_permission: **应用商店管理** +:ks_navigation: **应用** + + +本节介绍如何上架应用模板。 + +[.admon.attention,cols="a"] +|=== +|注意 + +| +在上架应用模板之前，其所包含的应用版本必须至少有一个是**已发布**状态。 +|=== + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] + +. 在应用模板详情页面左上角点击**上架**。 ++ +应用成功上架后，可在页面左上角的**应用商店**页面查看该应用。{ks_product_right}平台的所有项目都可以安装该应用。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/08-cancel-release-an-app-version.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/08-cancel-release-an-app-version.adoc new file mode 100644 index 000000000..dbc9d2dd3 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/08-cancel-release-an-app-version.adoc @@ -0,0 +1,44 @@ +--- +title: "取消发布应用版本" +weight: 08 +--- + +:ks_permission: **应用商店管理** +:ks_navigation: **应用** + + +本节介绍如何取消发布应用版本。 + +应用模板上架后，若取消发布其中的应用版本，该版本将被从应用商店中移除。若应用模板中的应用版本均为**取消发布**状态，该应用模板将自动下架。 + +应用版本取消发布后，应用商店管理员和企业空间成员可以删除该应用版本。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] + ++ + +. 在应用模板详情页面右侧的**版本**页签，点击需要操作的应用版本，在展开的区域点击**取消发布**，然后在弹出的对话框中点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/09-delete-an-app-version.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/09-delete-an-app-version.adoc new file mode 100644 index 000000000..bc24f465b --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/09-delete-an-app-version.adoc @@ -0,0 +1,40 @@ +--- +title: "删除应用版本" +weight: 08 +--- + +:ks_permission: **应用商店管理** +:ks_navigation: **应用** + + +本节介绍如何删除应用商店中的应用版本。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] + ++ + +. 在应用模板详情页面右侧的**版本**页签，点击需要操作的应用版本，在展开的区域点击**删除**，然后在弹出的对话框中点击**确定**。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/10-suspend-an-app-template.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/10-suspend-an-app-template.adoc new file mode 100644 index 000000000..46e20d13e --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/10-suspend-an-app-template.adoc @@ -0,0 +1,45 @@ +--- +title: "下架应用模板" +keywords: "Kubernetes, {ks_product}, 应用商店管理, 应用, 下架应用模板" +description: "介绍如何下架应用模板。" +weight: 10 +--- + +:ks_permission: **应用商店管理** +:ks_navigation: **应用** + + + +本节介绍如何下架应用模板。 + +应用模板下架后，应用模板及其中所有的应用版本将被从应用商店移除，同时应用商店管理员和企业空间成员可以删除整个应用模板或其中的某一个应用版本。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-oper-openDetailsPage.adoc[] + ++ + +. 在应用模板详情页面左上角点击**下架**，然后在弹出的对话框中点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/12-delete-an-app-template.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/12-delete-an-app-template.adoc new file mode 100644 index 000000000..a9d97ba9e --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/12-delete-an-app-template.adoc @@ -0,0 +1,36 @@ +--- +title: "删除应用模板" +weight: 12 +--- + +:ks_permission: **应用商店管理** +:ks_navigation: **应用** + + +本节介绍如何删除应用商店中的应用模板。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + +. 在需要编辑的应用模板右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除应用模板**对话框，输入应用模板的名称，然后点击**确定**。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/_index.adoc new file mode 100644 index 000000000..aa8dd54a3 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/01-apps/_index.adoc @@ -0,0 +1,9 @@ +--- +title: "应用" +keywords: "Kubernetes, {ks_product}, 平台管理, 应用商店管理, 应用" +description: "介绍如何管理应用商店中的应用。" +weight: 01 +--- + + +本节介绍如何管理应用商店中的应用模板。您可以查看、编辑应用的信息，并上架或下架应用。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/02-app-categories/01-manage-app-categories.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/02-app-categories/01-manage-app-categories.adoc new file mode 100644 index 000000000..98f72b0a8 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/02-app-categories/01-manage-app-categories.adoc @@ -0,0 +1,56 @@ +--- +title: "管理应用分类" +keywords: "Kubernetes, {ks_product}, 应用商店管理, 应用分类, 管理应用分类" +description: "介绍如何创建、编辑和删除应用分类。" +weight: 01 +--- + +:ks_permission: **应用商店管理** +:ks_navigation: **应用分类** + + +本节介绍如何创建、编辑和删除应用分类。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**应用分类**页面，根据需要创建、编辑或删除应用分类。 ++ +==== +* 在应用分类列表右上角点击image:/images/ks-qkcp/zh/icons/add-light.svg[add,18,18]，在弹出的对话框设置应用分类的名称和图标，然后点击**确定**可创建应用分类。 + +* 在已有的应用分类右侧点击image:/images/ks-qkcp/zh/icons/pen-light.svg[pen,18,18]，可编辑应用分类名称和图标。 + +* 在已有的应用分类右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]，然后在弹出的对话框中点击**确定**可删除应用分类。 ++ +-- +// Note +include::../../../../../../_ks_components/admonitions/note.adoc[] + +删除应用分类前，您需要先将分类中的应用分配到其他分类或设置为**未分类**。 + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/02-app-categories/02-set-the-category-of-an-app.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/02-app-categories/02-set-the-category-of-an-app.adoc new file mode 100644 index 000000000..125229f4d --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/02-app-categories/02-set-the-category-of-an-app.adoc @@ -0,0 +1,42 @@ +--- +title: "设置应用所属的分类" +keywords: "Kubernetes, {ks_product}, 应用商店管理, 应用分类, 设置应用所属的分类" +description: "介绍如何设置应用的分类。" +weight: 02 +--- + +:ks_permission: **应用商店管理** +:ks_navigation: **应用分类** + + + +本节介绍如何设置应用所属的分类。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在应用模板列表中，选择需要操作的应用模板左侧的复选框，然后在列表上方点击**更改分类**。 + +. 在**更改分类**对话框，设置应用的分类，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/02-app-categories/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/02-app-categories/_index.adoc new file mode 100644 index 000000000..90803c8f9 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/02-app-categories/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "应用分类" +keywords: "Kubernetes, {ks_product}, 平台管理, 应用商店管理, 应用分类" +description: "介绍如何管理应用分类。" +weight: 02 +--- + + + +本节介绍如何管理应用分类。 + +您可以根据需要将应用模板分配到一个分类中以便于管理。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/03-app-review/01-review-an-app-version.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/03-app-review/01-review-an-app-version.adoc new file mode 100644 index 000000000..fa4f788b9 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/03-app-review/01-review-an-app-version.adoc @@ -0,0 +1,54 @@ +--- +title: "审核应用版本" +keywords: "Kubernetes, {ks_product}, 应用商店, 应用审核, 审核应用版本" +description: "介绍如何审核提交到应用商店的应用版本。" +weight: 01 +--- + +:ks_menu: **平台管理 > 应用商店管理** +:ks_navigation: **应用审核** +:ks_permission: **应用商店管理** + + +本节介绍如何审核提交到应用商店的应用版本。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + +* 企业空间成员已提交应用版本并且应用版本尚未被审核。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**新提交**页签，点击需要审核的应用版本的名称。 + +. 在**应用详情**区域，查看应用的相关信息，然后根据需要点击**拒绝**或**批准**。 ++ +-- +// Note +include::../../../../../../_ks_components/admonitions/note.adoc[] + +* 如果点击**拒绝**，您需要在**拒绝原因**对话框进一步输入拒绝应用发布的原因，然后点击**确定**。 + +* 应用版本审核通过后，还需要应用商店管理员将其上架，才能将应用版本发布到应用商店。 + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/03-app-review/02-view-app-review-records.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/03-app-review/02-view-app-review-records.adoc new file mode 100644 index 000000000..d8ebed804 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/03-app-review/02-view-app-review-records.adoc @@ -0,0 +1,76 @@ +--- +title: "查看应用版本审核记录" +keywords: "Kubernetes, {ks_product}, 应用商店, 应用审核, 查看应用版本审核记录" +description: "介绍如何查看应用版本审核记录。" +weight: 02 +--- + +:ks_menu: **平台管理 > 应用商店管理** +:ks_navigation: **应用审核** +:ks_permission: **应用商店管理** + + +本节介绍如何查看应用版本审核记录。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**应用审核**页面，点击**新提交**、**已完成**或**全部**页签，查看应用版本的审核记录。 ++ +==== +* **应用审核**页面提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|应用版本名称、图标、Helm Chart 版本。 + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-workspace.adoc[] + +|提交者 +|提交应用版本的用户。 + +|状态 +|应用版本当前的审核状态。 + +* **待审核**：企业空间成员已提交应用版本，应用商店管理员尚未进行审核。 + +* **已发布**：应用商店管理员已批准应用发布。 + +* **已拒绝**：应用商店管理员已拒绝应用发布。 + +include::../../../../../_custom/workspaceManagement/appTemplates/appTemplates-para-versionUpdateTime.adoc[] +|=== +-- + +* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的应用版本。 + +include::../../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/03-app-review/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/03-app-review/_index.adoc new file mode 100644 index 000000000..61ea04d4d --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/03-app-review/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "应用审核" +keywords: "Kubernetes, {ks_product}, 平台管理, 应用商店管理, 应用审核" +description: "介绍如何审校提交到应用商店的应用版本。" +weight: 03 +--- + + + +本节介绍如何对企业空间成员提交的应用模板进行审核。 + +企业空间成员可以在创建应用模板后将应用模板提交到应用商店，由平台级别具有**应用管理**权限的用户对应用模板进行审核。应用模板审核通过后可以上架到应用商店。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/01-add-an-app-repository.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/01-add-an-app-repository.adoc new file mode 100644 index 000000000..6b2e6c74c --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/01-add-an-app-repository.adoc @@ -0,0 +1,48 @@ +--- +title: "添加应用仓库" +keywords: "Kubernetes, {ks_product}, 平台, 应用仓库, 添加应用仓库" +description: "介绍如何添加应用仓库。" +weight: 01 +--- + +:ks_permission: **应用商店管理** +:ks_navigation: **应用仓库** + + +本节介绍如何为{ks_product_both}平台添加应用仓库。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + +* 已提前创建 Helm Chart 仓库。有关如何创建 Helm Chart 仓库，请参阅 link:https://helm.sh/zh/docs/topics/chart_repository/[Helm 官方文档]。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在页面点击**添加**。 + +. 在**添加应用仓库**对话框，设置应用仓库的参数，然后点击**确定**。 ++ +-- +include::../../../../../_custom/workspaceManagement/appRepositories/appRepositories-para-createAppRepository.adoc[] + +应用仓库创建完成后将显示在应用仓库列表中。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/02-view-an-app-repository-list.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/02-view-an-app-repository-list.adoc new file mode 100644 index 000000000..4de1b2653 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/02-view-an-app-repository-list.adoc @@ -0,0 +1,69 @@ +--- +title: "查看应用仓库列表" +keywords: "Kubernetes, {ks_product}, 企业空间, 应用仓库, 查看应用仓库列表" +description: "介绍如何查看应用模板列表。" +weight: 02 +--- + +:ks_permission: **应用商店管理** +:ks_navigation: **应用仓库** + + +本节介绍如何查看应用仓库列表。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] ++ +==== +* 应用仓库列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|应用仓库的名称和描述信息。 + +|状态 +|应用仓库当前的状态。 + +* **成功**：应用仓库已添加并同步成功。 + +* **同步中**：应用仓库正在与 Helm Chart 仓库同步中。 + +* **不同步**：同步间隔时间设置为 0 时，应用仓库不与 Helm Chart 仓库同步。 + +* **失败**：应用仓库与 Helm Chart 仓库同步失败。 + +|URL +|Helm Chart 仓库的 URL。 + +|=== +-- + +* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的应用仓库。 + +include::../../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/03-edit-an-app-repository.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/03-edit-an-app-repository.adoc new file mode 100644 index 000000000..3fa86a108 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/03-edit-an-app-repository.adoc @@ -0,0 +1,44 @@ +--- +title: "编辑应用仓库" +keywords: "Kubernetes, {ks_product}, 企业空间, 应用仓库, 编辑应用仓库" +description: "介绍如何编辑应用仓库。" +weight: 03 +--- + +:ks_permission: **应用商店管理** +:ks_navigation: **应用仓库** + + +本节介绍如何编辑应用仓库。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要编辑的应用仓库右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑**。 + +. 在**编辑应用仓库**对话框，设置应用仓库的参数，然后点击**确定**。 ++ +-- +include::../../../../../_custom/workspaceManagement/appRepositories/appRepositories-para-createAppRepository.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/05-delete-an-app-repository.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/05-delete-an-app-repository.adoc new file mode 100644 index 000000000..36aff009d --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/05-delete-an-app-repository.adoc @@ -0,0 +1,47 @@ +--- +title: "删除应用仓库" +keywords: "Kubernetes, {ks_product}, 企业空间, 应用仓库, 删除应用仓库" +description: "介绍如何删除应用仓库。" +weight: 05 +--- + +:ks_permission: **应用商店管理** +:ks_navigation: **应用仓库** + + +本节介绍如何删除应用仓库。 + +// Warning +include::../../../../../../_ks_components/admonitions/warning.adoc[] + +应用仓库删除后，用户将不能从应用仓库安装应用，请谨慎执行此操作。 + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要删除的应用仓库右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除应用仓库**对话框，输入应用仓库的名称，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/_index.adoc new file mode 100644 index 000000000..f451662ec --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/04-app-repositories/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "应用仓库" +keywords: "Kubernetes, {ks_product}, 企业空间, 应用管理, 应用仓库" +description: "介绍如何添加和管理应用仓库以部署和管理应用。" +weight: 04 +--- + + + +本节介绍如何管理{ks_product_both}平台的应用仓库。 + +将 Helm Chart 仓库作为应用仓库添加到{ks_product_both}平台，从而在所有项目中安装应用仓库中的应用。有关如何创建 Helm Chart 仓库，请参阅 link:https://helm.sh/zh/docs/topics/chart_repository/[Helm 官方文档]。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/01-view-an-app-list.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/01-view-an-app-list.adoc new file mode 100644 index 000000000..30bc401a7 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/01-view-an-app-list.adoc @@ -0,0 +1,69 @@ +--- +title: "查看应用列表" +weight: 01 +--- + +:ks_permission: **应用商店管理** +:ks_navigation: **部署管理** + +本节介绍如何查看已部署的应用列表。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] ++ +==== +* 应用列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|应用的名称。 + +include::../../../../../_custom/projectManagement/apps/apps-para-status_v4.adoc[] + +|应用类型 +|应用模板的类型，如 **helm 应用**或 **yaml 应用**。 + +|应用模板 +|创建应用所使用的应用模板。仅对基于模板的应用显示。 + +|版本 +|应用的版本号。 + +* 对于基于模板的应用，显示 Helm Chart 的版本。 + +// * 对于自制应用，显示用户自定义的版本号。 + +|更新时间 +|应用的更新时间。 +|=== +-- + +* 在列表上方点击搜索框并输入关键字，可按名称搜索应用。 + +include::../../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../../_ks_components/oper-customizeColumns.adoc[] +==== \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/02-view-app-instance-details.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/02-view-app-instance-details.adoc new file mode 100644 index 000000000..43fc7f498 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/02-view-app-instance-details.adoc @@ -0,0 +1,82 @@ +--- +title: "查看应用详情" +weight: 02 +--- + +:ks_permission: **应用商店管理** +:ks_navigation: **部署管理** + +本节介绍如何查看已部署应用的详情。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**部署管理**页面，点击一个应用的名称打开其详情页面。 + +. 在应用详情页面左侧的**属性**区域查看应用的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群 +|应用所属的集群。 + +|项目 +|应用所属的项目。 + +include::../../../../../_custom/projectManagement/apps/apps-para-status_v4.adoc[] + +|应用 +|应用所使用的应用模板。 + +include::../../../../../_custom/projectManagement/apps/apps-para-details2.adoc[] +|=== +-- + ++ + +include::../../../../../_custom/projectManagement/apps/apps-oper-viewResourceStatus_v4.adoc[] + ++ + +. 在应用详情页面右侧点击**应用模板**查看应用模板的信息。 ++ +-- +* 点击**应用描述**可查看应用的介绍信息。 + +* 点击 **Chart 文件**可查看 Helm Chart 压缩包中的文件。在 **Chart 文件**右侧点击下拉列表可选择需要查看的文件。点击image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download,18,18]可将文件下载到本地。 +-- + +. 在应用详情页面右侧点击**应用设置**查看应用的设置信息。 ++ +-- +// Note +include::../../../../../../_ks_components/admonitions/note.adoc[] + +应用的默认设置保存在 Helm Chart 压缩包中的 **values.yaml** 文件中。**应用设置**页面显示的是用户在安装应用时自定义的设置。 + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/04-edit-an-app-information.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/04-edit-an-app-information.adoc new file mode 100644 index 000000000..9827feafa --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/04-edit-an-app-information.adoc @@ -0,0 +1,38 @@ +--- +title: "编辑应用信息" +weight: 04 +--- + +:ks_permission: **应用商店管理** +:ks_navigation: **部署管理** + +本节介绍如何编辑已部署应用的信息。 + +您可以编辑应用的别名和描述。{ks_product_right}不支持编辑已部署应用的名称。 + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要编辑的应用右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框设置应用的别名和描述，然后点击**确定**。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/06-delete-an-app-instance.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/06-delete-an-app-instance.adoc new file mode 100644 index 000000000..aa61733b2 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/06-delete-an-app-instance.adoc @@ -0,0 +1,37 @@ +--- +title: "删除应用" +weight: 06 +--- + +:ks_permission: **应用商店管理** +:ks_navigation: **部署管理** + +本节介绍如何删除已部署的应用实例。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要删除的应用右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除应用**对话框输入应用名称，然后点击**确定**。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/08-deploy-an-app-from-the-app-store.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/08-deploy-an-app-from-the-app-store.adoc new file mode 100644 index 000000000..859033f9d --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/08-deploy-an-app-from-the-app-store.adoc @@ -0,0 +1,70 @@ +--- +title: "从应用商店部署应用" +weight: 08 +--- + +:ks_permission: **应用商店管理** +:ks_navigation: **部署管理** + + +本节介绍如何在应用商店管理页面从应用商店部署应用。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_ks_components/oper-clickCreate.adoc[] + + ++ + +. 在**创建应用**对话框点击**从应用商店**。 + +. 在应用商店中，点击需要使用的应用模板，然后在右上角点击**部署**。 ++ +-- +// Note +include::../../../../../../_ks_components/admonitions/note.adoc[] + +如果弹出**部署须知**对话框，请仔细阅读相关内容，然后点击**同意**。 + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +. 在弹出的**位置**对话框，选择应用的安装位置，然后点击**确定**。 + ++ + +include::../../../../../_custom/projectManagement/apps/apps-oper-installApp.adoc[] + ++ +-- +// Note +include::../../../../../../_ks_components/admonitions/note.adoc[] + +应用商店中的应用由具有相关权限的企业空间成员发布或由第三方提供。有关应用功能参数的更多信息，请联系相关企业空间成员或应用的提供方。 + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] + +应用创建完成后将显示在应用列表中。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/10-deploy-an-app-using-an-app-template.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/10-deploy-an-app-using-an-app-template.adoc new file mode 100644 index 000000000..c4ef75a58 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/10-deploy-an-app-using-an-app-template.adoc @@ -0,0 +1,70 @@ +--- +title: "从应用模板部署应用" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用, 从应用模板安装应用" +description: "介绍如何从应用模板安装应用。" +weight: 10 +--- + +:ks_permission: **应用商店管理** +:ks_navigation: **部署管理** + + +本节介绍如何在应用商店管理页面从应用模板部署应用。 + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 应用商店管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择**应用商店管理**。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**创建应用**对话框点击**从应用模板**。 + +. 在**应用模板**页面，点击**当前企业空间**下拉列表，选择**当前企业空间**或一个应用仓库。 + +. 点击需要使用的应用模板，然后点击**安装**。 ++ +-- +// Note +include::../../../../../../_ks_components/admonitions/note.adoc[] + +应用模板由具有相关权限的企业空间成员创建，应用仓库由应用商店管理员创建。 +有关更多信息，请参阅link:../../../02-app-management/01-app-templates/01-create-an-app-template/[创建应用模板]和link:../../../03-app-store-management/04-app-repositories/01-add-an-app-repository/[添加应用仓库]。 + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + ++ + +include::../../../../../_custom/projectManagement/apps/apps-oper-installApp.adoc[] ++ +-- +// Note +include::../../../../../../_ks_components/admonitions/note.adoc[] + +有关应用功能参数的更多信息，请联系相关企业空间成员或应用的提供方。 + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] + +应用创建完成后将显示在应用列表中。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/_index.adoc new file mode 100644 index 000000000..5036869de --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/05-app-deployment/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "部署管理" +keywords: "Kubernetes, {ks_product}, 平台管理, 应用, 应用管理, 应用部署" +description: "介绍如何管理所有已部署的应用实例，以及如何直接部署应用到项目。" +weight: 05 +--- + + + +本节介绍如何管理{ks_product_both}平台中所有已部署的应用实例，以及如何直接部署应用到项目。 diff --git a/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/_index.adoc new file mode 100644 index 000000000..270e099d4 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/03-app-store-management/_index.adoc @@ -0,0 +1,16 @@ +--- +title: "应用商店管理" +keywords: "Kubernetes, {ks_product}, 平台管理, 应用商店管理" +description: "介绍如何对企业空间成员提交的应用发布请求进行审核。" +weight: 03 +--- + + + +本节介绍如何管理应用商店。 + +应用商店提供了基于 Helm Chart 的应用模板，{ks_product_right}平台所有项目的成员都可以访问应用商店。 + +应用商店管理员可以对应用商店中的应用模板进行分类、审核、上架、下架等操作，管理平台的应用仓库和所有已部署的应用实例，并直接部署应用到项目。 + +安装“KubeSphere 应用商店管理”扩展组件后，在页面右上角点击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/11-use-extensions/02-app-store/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/02-app-store/_index.adoc new file mode 100644 index 000000000..0bb19c681 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/02-app-store/_index.adoc @@ -0,0 +1,17 @@ +--- +title: "KubeSphere 应用商店管理" +weight: 02 +--- + + +本节介绍如何使用“KubeSphere 应用商店管理”扩展组件。 + +安装“KubeSphere 应用商店管理”扩展组件后，企业空间左侧导航栏的**应⽤管理**菜单下将显⽰**应用模板**选项，页面右上角的扩展组件快捷入口中将显⽰**应⽤商店管理**选项。 + +使用该扩展组件： + +- 企业空间管理员可以管理应用模板，提交应用模板中定义的应用到应用商店。待应用商店管理员审批通过并上架后，即可发布应用程序到应用商店，供{ks_product_both}平台的所有项目安装该应用。 + +- 应用商店管理员可以对应用商店中的应用模板进行分类、审核、上架、下架等操作，管理平台的应用仓库和所有已部署的应用实例，并直接部署应用到项目。 + + diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/03-manually-compose-an-app.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/03-manually-compose-an-app.adoc new file mode 100644 index 000000000..c649c57bf --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/03-manually-compose-an-app.adoc @@ -0,0 +1,66 @@ +--- +title: "创建自制应用" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用, 创建自制应用" +description: "介绍如何创建自制应用。" +weight: 03 +--- + +:ks_permission: ** Service Mesh 管理** +:ks_navigation: **服务网格 > 自制应用** + + +本节介绍如何创建自制应用。 + +include::../../../../_custom/projectManagement/apps/apps-compose-description.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + +. 在**基本信息**页签，设置应用的基本信息，然后点击**下一步**。 ++ +-- +include::../../../../_custom/projectManagement/apps/apps-basic-para.adoc[] +-- + +. 在**服务设置**页签，点击**创建服务**，选择**有状态服务**或**无状态服务**为应用创建服务，然后点击**下一步**。 ++ +-- +include::../../../../_custom/clusterManagement/services/services-para-statelessStatefulExternal.adoc[] + +ifeval::["{file_output_type}" == "html"] +有关**有状态服务**和**无状态服务**的参数设置，请参阅link:../../../../09-project-management/03-application-workloads/02-services/01-create-a-service/01-create-a-stateful-or-stateless-service/#_参数描述[创建有状态服务或无状态服务]。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +有关**有状态服务**和**无状态服务**的参数设置，请参阅《{ks_product_right}项目管理指南》的“创建有状态服务或无状态服务”章节。 +endif::[] +-- + +. 在**路由设置**页签，点击**添加路由规则**为应用创建路由规则，然后点击**创建**。 ++ +-- +include::../../../../_custom/clusterManagement/routes/routes-para-routingRules.adoc[] + +应用创建完成后将显示在**自制应用**页面。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/04-view-an-app-list.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/04-view-an-app-list.adoc new file mode 100644 index 000000000..c391c9fec --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/04-view-an-app-list.adoc @@ -0,0 +1,68 @@ +--- +title: "查看自制应用列表" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用, 查看应用列表" +description: "介绍如何查看应用列表。" +weight: 04 +--- + +:ks_permission: ** Service Mesh 查看** +:ks_navigation: **服务网格 > 自制应用** + + +本节介绍如何查看自制应用列表。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**自制应用**页面，查看应用列表。 ++ +==== +* 应用列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|应用的名称。 + +include::../../../../_custom/projectManagement/apps/apps-para-status_v4.adoc[] + +|版本 +|应用的版本号。 + +// * 对于基于模板的应用，显示 Helm Chart 的版本。 + +* 对于自制应用，显示用户自定义的版本号。 + +|创建时间 +|应用的创建时间。 +|=== +-- + +* 在列表上方点击搜索框并输入关键字，可按名称搜索应用。 + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/05-view-composed-app-details.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/05-view-composed-app-details.adoc new file mode 100644 index 000000000..288817e91 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/05-view-composed-app-details.adoc @@ -0,0 +1,124 @@ +--- +title: "查看自制应用详情" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用, 查看自制应用详情" +description: "介绍如何查看自制应用详情。" +weight: 05 +--- + +:ks_permission: ** Service Mesh 查看** +:ks_navigation: **服务网格 > 自制应用** + + +本节介绍如何查看自制应用详情。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**自制应用**页面，点击一个应用的名称打开其详情页面。 + +. 在应用详情页面左侧的**属性**区域查看应用的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../_custom/projectManagement/apps/apps-para-details1.adoc[] + +include::../../../../_custom/projectManagement/apps/apps-para-details2.adoc[] + +|应用治理 +|应用是否已启用应用治理。应用治理启用后，您可以使用流量监控、灰度发布和链路追踪功能。 +|=== +-- + ++ + +include::../../../../_custom/projectManagement/apps/apps-oper-viewResourceStatus.adoc[] + ++ + +. 在应用详情页面右侧点击**流量监控**查看应用的流量信息。 ++ +-- +点击图形面板中的服务，在页面右侧，查看服务的流量监控信息、相关的容器组信息，并进行**流量管理**。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|流量策略 > 负载均衡 +|负载均衡算法 + +* **轮询**：将客户端请求轮流发送给各个后端。 +* **最少请求**：随机选择两个健康的后端，并将客户端请求发送给请求数较少的后端。 +* **随机**：将客户端请求发送给一个随机的健康后端。 +* **透传**：将连接直接转发给调用者请求的原始 IP 地址，而不进行任何形式的负载均衡。用于高级配置，请谨慎使用。 + +|流量策略 > 会话保持 +| +根据特定的标识（例如 HTTP header、Cookie、查询参数等）将请求映射到后端服务器，以实现请求的均衡分发和负载分担。 + +* **基于 HTTP Header 哈希**：基于特定的 HTTP header 进行哈希。 +* **基于 HTTP Cookie 哈希**：基于 HTTP cookie 进行哈希。 +* **基于 HTTP 查询参数哈希**：基于特定的 HTTP 查询参数进行哈希。 +* **基于源 IP 地址哈希**：基于源 IP 地址进行哈希。适用于 TCP 和 HTTP 连接。 +* **基于 ring/modulo 哈希**：ring/modulo 哈希负载均衡器使用一致性哈希算法对后端主机进行哈希。 +* **基于 Maglev 哈希**：Maglev 哈希负载均衡器使用一致性哈希算法对后端主机进行哈希。 + +有关更多信息，请参阅link:https://istio.io/v1.16/zh/docs/reference/config/networking/destination-rule/#LoadBalancerSettings-ConsistentHashLB[此文档]。 + +|连接池 +|为应用程序创建固定数量的连接对象， 并将其存储在一个连接池中供重复使用。每次请求都从连接池中获取连接对象，并在使用后将连接对象返还到连接池。 + +启用后，需设置最大连接数、每个连接最大请求数、最大重试次数、连接超时、最大请求数量、最大等待请求数量。 + +|熔断器 +|如果服务无法访问并且符合指定的条件， 熔断器会将服务标记为不可用，并在指定时间范围内直接向返回客户端错误响应。 + +启用后，需设置连续 5XX 错误数量、检查间隔（秒）、最大排除比例（%）、排除时间（秒）。 +|=== + +-- + +. 在应用详情页面右侧点击**灰度发布**查看应用的灰度发布信息。有关更多信息，请参阅link:../../02-grayscale-release/[灰度发布]。 ++ +-- +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +如需使用**流量监控**和**灰度发布**功能，您需要在创建自制应用时启用应用治理功能。有关更多信息，请参阅link:../03-manually-compose-an-app/[创建自制应用]。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +. 在应用详情页面右侧点击**链路追踪**查看应用请求链路信息。 ++ +-- +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +* 如需使用**链路追踪**功能，您需要在创建自制应用时启用应用治理功能。有关更多信息，请参阅link:../03-manually-compose-an-app/[创建自制应用]。 + +* 同时需要启用项目网关，并为项目网关启用**链路追踪**功能。有关更多信息，请参阅link:../../../12-gateway/01-project-gateway/01-enable-a-project-gateway[启用项目网关]。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/06-edit-app-information.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/06-edit-app-information.adoc new file mode 100644 index 000000000..dcaed5391 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/06-edit-app-information.adoc @@ -0,0 +1,38 @@ +--- +title: "编辑自制应用信息" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用, 编辑应用信息" +description: "介绍如何编辑应用信息。" +weight: 06 +--- + +:ks_permission: ** Service Mesh 管理** +:ks_navigation: **服务网格 > 自制应用** + + +本节介绍如何编辑自制应用信息。 + +您可以编辑应用的别名和描述。{ks_product_right}不支持编辑已创建应用的名称。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/projectManagement/apps/apps-oper-editAppInformation.adoc[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/07-add-a-service.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/07-add-a-service.adoc new file mode 100644 index 000000000..49b387704 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/07-add-a-service.adoc @@ -0,0 +1,72 @@ +--- +title: "为自制应用添加服务" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用, 编辑应用设置" +description: "介绍如何为自制应用添加服务。" +weight: 07 +--- + +:ks_permission: ** Service Mesh 管理** +:ks_navigation: **服务网格 > 自制应用** + + +本节介绍如何为自制应用添加有状态或无状态服务。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**自制应用**页面，点击一个应用的名称打开其详情页面。 + +. 在应用详情页面左上角选择**更多操作 > 添加服务**。 + +. 在**创建服务**对话框，根据需要选择**有状态服务**或**无状态服务**。 ++ +-- +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +include::../../../../_custom/clusterManagement/services/services-para-statelessStatefulExternal.adoc[] + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + ++ + +include::../../../../_custom/projectManagement/services/services-oper-setBasicInformation.adoc[] + ++ + +. 在**容器组设置**页签，为服务后端工作负载管理的容器组设置副本数量、容器、更新策略、安全上下文、调度规则和元数据，然后点击**下一步**。 + ++ + +include::../../../../_custom/projectManagement/services/services-oper-setStorageAdvanced.adoc[] ++ +-- +ifeval::["{file_output_type}" == "html"] +有关**有状态服务**和**无状态服务**的参数设置，请参阅link:../../../../09-project-management/03-application-workloads/02-services/01-create-a-service/01-create-a-stateful-or-stateless-service/#_参数描述[创建有状态服务或无状态服务]。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +有关**有状态服务**和**无状态服务**的参数设置，请参阅《{ks_product_right}项目管理指南》的“创建有状态服务或无状态服务”章节。 +endif::[] +-- + diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/08-add-an-app-route.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/08-add-an-app-route.adoc new file mode 100644 index 000000000..44bbd0526 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/08-add-an-app-route.adoc @@ -0,0 +1,42 @@ +--- +title: "为自制应用添加应用路由" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 应用, 编辑应用设置" +description: "介绍如何为自制应用添加应用路由。" +weight: 07 +--- + +:ks_permission: ** Service Mesh 管理** +:ks_navigation: **服务网格 > 自制应用** + + +本节介绍如何为自制应用添加应用路由。 + + +== 前提条件 + + +:relfileprefix: ../../../../ + +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**自制应用**页面，点击一个应用的名称打开其详情页面。 + +. 在应用详情页面左上角选择**更多操作 > 添加应用路由**。 + ++ + +include::../../../../_custom/clusterManagement/routes/routes-oper-createARoute.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/10-delete-apps.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/10-delete-apps.adoc new file mode 100644 index 000000000..bb5011f89 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/10-delete-apps.adoc @@ -0,0 +1,61 @@ +--- +title: "删除自制应用" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用, 删除应用" +description: "介绍如何删除应用。" +weight: 10 +--- + +:ks_permission: ** Service Mesh 管理** +:ks_navigation: **服务网格 > 自制应用** + + +本节介绍如何删除自制应用。 + + +== 前提条件 + + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +* {ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 + + +== 删除单个应用 +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ +. 在**自制应用**页面，查看应用列表。 + +. 在需要删除的应用右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除应用**对话框，输入应用的名称，然后点击**确定**。 + + +== 批量删除应用 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**自制应用**页面，查看应用列表。 + +. 选择需要删除的应用左侧的复选框，然后在应用列表上方点击**删除**。 + +. 在**批量删除应用**对话框，输入应用的名称，然后点击**确定**。 ++ +-- +include::../../../../_custom/note-separateNamesByComma.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/_index.adoc new file mode 100644 index 000000000..542bf5e10 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/01-apps/_index.adoc @@ -0,0 +1,29 @@ +--- +title: "自制应用" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用" +description: "介绍如何管理项目中安装的应用。" +weight: 01 +--- + + +本节介绍如何管理自制应用。 + +include::../../../../_custom/projectManagement/apps/apps-types.adoc[] + +ifeval::["{file_output_type}" == "html"] +[.admon.note,cols="a"] +|=== +|说明 + +|有关基于模板的应用的更多信息，请参阅link:../../../09-project-management/03-application-workloads/01-apps[应用]。 +|=== +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +[.admon.note,cols="a"] +|=== +|说明 + +|有关基于模板的应用的更多信息，请参阅《{ks_product_right}项目管理指南》的“应用负载 > 应用”章节。 +|=== +endif::[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/01-create-a-grayscale-release-task.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/01-create-a-grayscale-release-task.adoc new file mode 100644 index 000000000..e9ffd443f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/01-create-a-grayscale-release-task.adoc @@ -0,0 +1,201 @@ +--- +title: "创建灰度发布任务" +keywords: "Kubernetes, {ks_product}, 项目管理, 灰度发布, 创建灰度发布任务" +description: "介绍如何创建灰度发布任务。" +weight: 01 +--- + +:ks_permission: ** Service Mesh 管理** +:ks_navigation: **服务网格 > 灰度发布** + + +本节介绍如何创建灰度发布任务。 + + +== 前提条件 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 + +* 提前准备新版本的容器镜像并上传到容器镜像服务，同时确保存容器镜像服务与{ks_product_both}网络连接正常。 + + +== 操作步骤 + +请参阅link:#_参数描述[参数描述]设置灰度发布任务的参数。 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 根据需要创建灰度发布任务类型，将光标悬停在**蓝绿部署**、**金丝雀发布**或**流量镜像**区域，然后点击**创建**。 + +. 在**基本信息**页签，设置灰度发布任务的名称，然后点击**下一步**。 + +. 在**服务设置**页签，选择需要进行灰度发布的应用和服务，然后点击**下一步**。 + +. 在**新版本设置**页签，设置新版本的服务版本号、容器组副本数量和容器，然后点击**下一步**。 + +. 在**策略设置**页签，设置灰度发布任务的流量转发策略，然后点击**创建**。 ++ +-- +灰度发布任务创建完成后将显示在**灰度发布**页面的**发布任务**页签。 +-- + + +== 参数描述 + +以下介绍如何设置灰度发布任务的参数。 + +* 基本信息 ++ +-- +设置任务的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 253 个字符。 +-- + +* 服务设置 ++ +-- +选择需要进行灰度发布的自制应用和服务。 + +* 点击下拉列表选择一个自制应用。 + +* 在需要进行灰度发布的服务右侧点击**选择**。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +灰度发布仅支持自制应用，不支持基于模板的应用。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +* 新版本设置 ++ +-- +设置新版本的服务版本号、容器组副本数量和容器。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|新版本号 +|新版本的服务版本号。新版本号只能包含小写字母和数字, 最长 16 个字符。 + +|副本 +| +新版本的容器组副本数量。点击image:/images/ks-qkcp/zh/icons/chevron-up.svg[chevron-up,18,18]/image:/images/ks-qkcp/zh/icons/chevron-down.svg[chevron-down,18,18]可增加/减少容器组副本的数量。 + +|添加容器 +| +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] + +* 直接在文本框中输入容器镜像的 URL 可替换旧版本的容器镜像，同时保持其他容器设置不变。 +|=== +-- + +* 新版本设置 > 添加容器 > 容器设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] + +|CPU 预留 +|为容器预留的 CPU 资源，单位为核。 + +|CPU 上限 +|允许容器使用的 CPU 资源上限，单位为核。 + +|内存预留 +|为容器预留的内存资源，单位为 MiB。 + +|内存上限 +|允许容器使用的内存资源上限，单位为 MiB。 +|=== +-- + +* 新版本设置 > 添加容器 > 端口设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] +-- + +* 新版本设置 > 添加容器 > 镜像拉取策略 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] +-- + +* 新版本设置 > 添加容器 > 健康检查 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] +-- + +* 新版本设置 > 添加容器 > 健康检查 > 添加探针 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc[] +-- + +* 新版本设置 > 添加容器 > 生命周期管理 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] +-- + +* 新版本设置 > 添加容器 > 生命周期管理 > 添加动作 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] +-- + +* 新版本设置 > 添加容器 > 启动命令 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] +-- + +* 新版本设置 > 添加容器 > 环境变量 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] +-- + +* 新版本设置 > 添加容器 > 容器组安全上下文 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] +-- + +* 新版本设置 > 添加容器 > 同步主机时区 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] +-- + +* 策略设置 ++ +==== +设置灰度发布任务的业务流量转发策略。 + +include::../../../../_custom/projectManagement/grayscaleRelease/grayscaleRelease-para-strategySettings.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/02-view-a-grayscale-release-task-list.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/02-view-a-grayscale-release-task-list.adoc new file mode 100644 index 000000000..bfe9cc2c1 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/02-view-a-grayscale-release-task-list.adoc @@ -0,0 +1,52 @@ +--- +title: "查看灰度发布任务列表" +keywords: "Kubernetes, {ks_product}, 项目管理, 灰度发布, 查看灰度发布任务列表" +description: "介绍如何查看灰度发布任务列表。" +weight: 02 +--- + +:ks_permission: ** Service Mesh 查看** +:ks_navigation: **服务网格 > 灰度发布** + + +本节介绍如何查看灰度发布任务列表。 + + +== 前提条件 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**灰度发布**页面，点击**发布任务**打开灰度发布任务列表。 ++ +-- +灰度发布任务列表提供以下信息： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|灰度发布任务的名称、应用、发布模式和服务。 + +|版本 +|新旧版本的版本号和容器组副本数量。 + +include::../../../../_custom/projectManagement/grayscaleRelease/grayscaleRelease-para-trafficSuccessLatency.adoc[] +|=== +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/03-view-grayscale-release-task-details.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/03-view-grayscale-release-task-details.adoc new file mode 100644 index 000000000..5300c1e3a --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/03-view-grayscale-release-task-details.adoc @@ -0,0 +1,61 @@ +--- +title: "查看灰度发布任务详情" +keywords: "Kubernetes, {ks_product}, 项目管理, 灰度发布, 查看灰度发布任务详情" +description: "介绍如何查看灰度发布任务详情。" +weight: 03 +--- + +:ks_permission: ** Service Mesh 查看** +:ks_navigation: **服务网格 > 灰度发布** + + +本节介绍如何查看灰度发布任务详情。 + + +== 前提条件 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/projectManagement/grayscaleRelease/grayscaleRelease-oper-openDetailsPage.adoc[] ++ +-- +灰度发布任务详情页面提供以下信息： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|灰度发布任务的名称和发布模式。 + +|版本 +|新旧版本的容器组副本数量、容器组名称、CPU 用量和内存用量。 + +|流量分配 +| +* 对于蓝绿部署，显示当前接收全部流量的服务版本。 + +* 对于金丝雀发布，显示新旧版本的流量接收比例。 + +* 对于流量镜像，显示旧版本接收新版本流量的相同副本。 + +include::../../../../_custom/projectManagement/grayscaleRelease/grayscaleRelease-para-trafficSuccessLatency.adoc[] +|=== +-- + diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/04-switch-versions-blue-green-deployment.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/04-switch-versions-blue-green-deployment.adoc new file mode 100644 index 000000000..777f75aed --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/04-switch-versions-blue-green-deployment.adoc @@ -0,0 +1,38 @@ +--- +title: "切换上线版本（蓝绿部署）" +keywords: "Kubernetes, {ks_product}, 项目管理, 灰度发布, 切换上线版本（蓝绿部署）" +description: "介绍如何为蓝绿部署任务切换上线版本。" +weight: 04 +--- + +:ks_permission: ** Service Mesh 管理** +:ks_navigation: **服务网格 > 灰度发布** + +本节介绍如何为蓝绿部署任务切换上线版本。 + +根据业务需要，您可以一键设置蓝绿部署任务中的新版本或旧版本立即接管全部业务流量。 + + +== 前提条件 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**灰度发布**页面，点击**发布任务**，然后点击一个蓝绿部署任务的名称打开其详情页面。 + +. 在**版本**区域，在一个版本右上角点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**接管**可设置该版本立即接管全部业务流量。 diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/05-adjust-traffic-distribution-ratio-canary-release.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/05-adjust-traffic-distribution-ratio-canary-release.adoc new file mode 100644 index 000000000..1c26d530a --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/05-adjust-traffic-distribution-ratio-canary-release.adoc @@ -0,0 +1,40 @@ +--- +title: "调整流量分配比例（金丝雀发布）" +keywords: "Kubernetes, {ks_product}, 项目管理, 灰度发布, 调整流量分配比例（金丝雀发布）" +description: "介绍如何为金丝雀发布任务调整流量分配比例。" +weight: 05 +--- + +:ks_permission: ** Service Mesh 管理** +:ks_navigation: **服务网格 > 灰度发布** + +本节介绍如何为金丝雀发布任务调整流量分配比例。 + +根据业务需要，您可以手动调整金丝雀发布任务中的新版本和旧版本接收业务流量的分配比例。 + + +== 前提条件 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**灰度发布**页面，点击**发布任务**，然后点击一个金丝雀发布任务的名称打开其详情页面。 + +. 在**流量分配**区域，拖动滑块调整新旧版本接收流量的比例，然后在弹出的对话框中点击**确定**。系统将按照设置的比例在新旧版本之间分配业务流量。 + +. （可选）在**版本**区域，在一个版本右上角点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**接管**可设置该版本立即接管全部业务流量。 diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/06-edit-settings-of-a-grayscale-release-task.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/06-edit-settings-of-a-grayscale-release-task.adoc new file mode 100644 index 000000000..ce5400d0f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/06-edit-settings-of-a-grayscale-release-task.adoc @@ -0,0 +1,56 @@ +--- +title: "编辑灰度发布任务设置" +keywords: "Kubernetes, {ks_product}, 项目管理, 灰度发布, 编辑灰度发布任务设置" +description: "介绍如何编辑灰度发布任务设置。" +weight: 06 +--- + +:ks_permission: ** Service Mesh 管理** +:ks_navigation: **服务网格 > 灰度发布** + + +本节介绍如何编辑灰度发布任务设置。 + + +== 前提条件 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/projectManagement/grayscaleRelease/grayscaleRelease-oper-openDetailsPage.adoc[] + ++ + +. 在**版本**区域，在新版本右上角点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑**。 + +. 在**新版本设置**页签，点击image:/images/ks-qkcp/zh/icons/chevron-up.svg[chevron-up,18,18]/image:/images/ks-qkcp/zh/icons/chevron-down.svg[chevron-down,18,18]可增加/减少容器组副本的数量。 ++ +-- +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +灰度发布不支持修改新版本的版本号和容器镜像。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +. 点击**策略设置**页签，设置灰度发布任务的流量转发策略，然后点击**确定**。 ++ +==== +include::../../../../_custom/projectManagement/grayscaleRelease/grayscaleRelease-para-strategySettings.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/07-delete-a-grayscale-release-task.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/07-delete-a-grayscale-release-task.adoc new file mode 100644 index 000000000..7937a5cce --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/07-delete-a-grayscale-release-task.adoc @@ -0,0 +1,52 @@ +--- +title: "删除灰度发布任务" +keywords: "Kubernetes, {ks_product}, 项目管理, 灰度发布, 删除灰度发布任务" +description: "介绍如何删除灰度发布任务。" +weight: 07 +--- + +:ks_permission: ** Service Mesh 管理** +:ks_navigation: **服务网格 > 灰度发布** + + +本节介绍如何删除灰度发布任务。 + +// Warning +include::../../../../../_ks_components/admonitions/warning.adoc[] + +只有在新旧版本之一已接管全部业务流量时才能删除灰度发布任务。灰度发布任务删除后，未接管业务流量的版本（服务、工作负载和容器组）也将被删除。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 + +* 新旧版本之一已接管全部业务流量。有关更多信息，请参阅link:../04-switch-versions-blue-green-deployment/[切换上线版本（蓝绿部署）]和link:../05-adjust-traffic-distribution-ratio-canary-release/[调整流量分配比例（金丝雀发布）]。 + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/projectManagement/grayscaleRelease/grayscaleRelease-oper-openDetailsPage.adoc[] + ++ + +. 在灰度发布详情页面右上角，点击**删除**。 ++ +-- +系统将删除灰度发布任务，同时删除未接管业务流量的版本。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/_index.adoc new file mode 100644 index 000000000..9b243ba43 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/02-grayscale-release/_index.adoc @@ -0,0 +1,26 @@ +--- +title: "灰度发布" +keywords: "Kubernetes, {ks_product}, 项目管理, 灰度发布" +description: "介绍如何管理灰度发布任务。" +weight: 02 +--- + + +本节介绍如何使用灰度发布功能。 + +当容器的版本需要更新时，如果新版本未经充分测试而直接发布到生产环境，可能会给业务带来很大风险。使用灰度发布功能将生产环境的业务流量转发给测试中的新版本，从而在新版本正式发布前充分暴露并及时修复新版本可能存在的问题。 + +{ks_product_right}支持以下灰度发布模式： + +* 蓝绿部署：将业务流量发送给新版本进行测试。如果新版本运行不正常，可立即将业务流量切换给旧版本。 + +* 金丝雀发布：将业务流量按一定比例分配给新版本和旧版本，在测试新版本的同时保证业务连续性。 + +* 流量镜像：将业务流量的副本发送给新版本进行测试，而不实际暴露新版本。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +灰度发布仅支持自制应用，不支持基于模板的应用。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/_index.adoc new file mode 100644 index 000000000..513fba705 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/03-service-mesh/_index.adoc @@ -0,0 +1,24 @@ +--- +title: "KubeSphere 服务网格" +keywords: "Kubernetes, {ks_product}, 服务网格" +description: "介绍如何使用 KubeSphere 服务网格组件。" +weight: 03 +--- + +本节介绍如何使用“KubeSphere 服务网格”扩展组件。 + +“KubeSphere 服务网格”扩展组件用于启用{ks_product_both}平台的服务网格功能，基于开源项目 Istio 构建，将微服务治理和流量管理可视化。它拥有强大的工具包，包括熔断机制、蓝绿部署、金丝雀发布、流量镜像、链路追踪、可观测性和流量控制等。 + +// 服务网格支持代码无侵入的微服务治理，帮助开发者快速上手，Istio 的学习曲线也极大降低。其中，灰度发布策略为用户在不影响微服务之间通信的情况下测试和发布新的应用版本发挥了重要作用。 + +安装“KubeSphere 服务网格”扩展组件后，项⽬左侧导航栏将显⽰**服务网格**选项，支持创建自制应用、管理自制应用的灰度发布。 + +// ⾃制应⽤详情⻚⾯将显⽰**流量监控**、**灰度发布**和**链路追踪**⻚签。在创建自制应用时，启用应用治理可使用流量监控、灰度发布和链接追踪功能。 + +[.admon.attention,cols="a"] +|=== +|注意 + +| +安装 KubeSphere 服务网格前，需要在扩展组件配置中设置可用的 Prometheus 服务和 OpenSearch 服务。有关组件配置的更多信息，请参阅扩展中心“KubeSphere 服务网格”扩展组件的详情页说明。 +|=== \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/00-web-console/01-log-in-and-go-to-a-project.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/00-web-console/01-log-in-and-go-to-a-project.adoc new file mode 100644 index 000000000..847e0420e --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/00-web-console/01-log-in-and-go-to-a-project.adoc @@ -0,0 +1,40 @@ +--- +title: "登录并进入联邦项目" +keywords: "Kubernetes, {ks_product}, 项目管理, Web 控制台, 联邦项目" +description: "介绍如何登录{ks_product_left} Web 控制台并进入联邦项目。" +weight: 01 +--- + + + +本节介绍如何登录{ks_product_left} Web 控制台并进入联邦项目。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* 您需要获取联邦项目成员用户名和密码。 + +include::../../../../_custom/workspaceManagement/webConsole/webConsole-prer-logIn.adoc[] + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/webConsole/webConsole-oper-logIn.adoc[] ++ +-- +[.admon.note,cols="a"] +|=== +|说明 + +| +include::../../../../_custom/workspaceManagement/webConsole/webConsole-note-firstLogin.adoc[] +|=== +-- + +. 点击**企业空间管理**，然后点击一个企业空间的名称进入企业空间。 + +. 在左侧导航栏选择**项目**，然后点击**联邦项目**进入联邦项目列表页面。 + +. 在**联邦项目**页面，点击一个联邦项目的名称进入联邦项目。 diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/00-web-console/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/00-web-console/_index.adoc new file mode 100644 index 000000000..015e1a463 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/00-web-console/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Web 控制台" +keywords: "Kubernetes, {ks_product}, 联邦项目, Web 控制台" +description: "介绍如何登录{ks_product_left} Web 控制台并进入联邦项目，以及修改用户的邮箱、语言和密码。" +weight: 01 +--- + + + +本节介绍如何登录{ks_product_left} Web 控制台并进入联邦项目。 diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/01-create-a-project.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/01-create-a-project.adoc new file mode 100644 index 000000000..9d650644f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/01-create-a-project.adoc @@ -0,0 +1,57 @@ +--- +title: "创建联邦项目" +keywords: "Kuberentes, {ks_product}, 企业空间管理, 联邦项目, 创建联邦项目" +description: "介绍如何创建联邦项目。" +weight: 01 +--- + + +:ks_permission: **联邦项目管理** +:ks_navigation: **项目 > 联邦项目** + + +本节介绍如何创建联邦项目。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在弹出的对话框，设置项目的参数，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../_custom/clusterManagement/projects/projects-para-name.adoc[] + +include::../../../../_custom/clusterManagement/projects/projects-para-aliasDescription.adoc[] + +|集群 +|可供项目使用的集群。项目中的资源运行在此处选择的集群中。创建联邦项目时，可点击**添加**选择多个集群从而使项目中的资源运行不同的集群中。 +|=== + +项目创建完成后，您可以邀请用户加入项目并在项目中部署业务。 + +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/02-view-a-project-list.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/02-view-a-project-list.adoc new file mode 100644 index 000000000..85d0a36ef --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/02-view-a-project-list.adoc @@ -0,0 +1,69 @@ +--- +title: "查看联邦项目列表" +keywords: "Kuberentes, {ks_product}, 企业空间管理, 联邦项目, 介绍如何查看项目列表" +description: "介绍如何查看项目列表。" +weight: 02 +--- + +:ks_permission: **联邦项目查看** +:ks_navigation: **项目 > 联邦项目** + + +include::../../../../_custom/workspaceManagement/projects/projects-desc-viewProjectList.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ +==== +* 项目列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|项目的名称和描述信息。 + +|状态 +|项目当前所处的状态。 + +* **活跃**：项目状态正常。 +* **删除中**：项目正在删除中。 + +|集群 +|可供项目使用的集群。 + +|创建时间 +|项目的创建时间。 +|=== +-- + +include::../../../../_custom/workspaceManagement/projects/projects-oper-searchForProjects.adoc[] + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] + + +* 在列表中点击一个项目的名称可打开项目管理页面。您可以在项目管理页面查看和管理项目中的资源。 + +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/03-edit-project-information.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/03-edit-project-information.adoc new file mode 100644 index 000000000..4766f1e9f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/03-edit-project-information.adoc @@ -0,0 +1,40 @@ +--- +title: "编辑联邦项目信息" +keywords: "Kuberentes, {ks_product}, 企业空间管理, 联邦项目, 编辑项目信息" +description: "介绍如何编辑项目信息。" +weight: 03 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **项目 > 联邦项目** + + +include::../../../../_custom/clusterManagement/projects/projects-desc-editInformation.adoc[] + +include::../../../../_custom/clusterManagement/projects/projects-note-editInformation.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ +// * 如需编辑联邦项目信息，您需要确保企业空间中存在联邦项目。 + + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/projects/projects-oper-editInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/04-edit-project-annotations.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/04-edit-project-annotations.adoc new file mode 100644 index 000000000..2870d1c16 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/04-edit-project-annotations.adoc @@ -0,0 +1,48 @@ +--- +title: "编辑联邦项目注解" +keywords: "Kuberentes, {ks_product}, 企业空间管理, 联邦项目, 编辑项目注解" +description: "介绍如何编辑项目注解。" +weight: 04 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **项目 > 联邦项目** + + +本节介绍如何编辑项目注解。 + +项目注解是为项目添加额外的元数据或描述性信息的键值对。 + + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + + +. 在需要操作的项目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑注解**。 + +. 在**编辑注解**对话框，设置注解键值对，然后点击**确定**。 ++ +-- +* 点击**添加**可设置多条注解。 + +* 在已创建的注解右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除注解。 +-- + diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/05-add-a-cluster.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/05-add-a-cluster.adoc new file mode 100644 index 000000000..b4a180d13 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/05-add-a-cluster.adoc @@ -0,0 +1,59 @@ +--- +title: "为联邦项目添加集群" +keywords: "Kuberentes, {ks_product}, 企业空间管理, 联邦项目, 为联邦项目添加集群" +description: "介绍如何为联邦项目添加集群。" +weight: 05 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **项目 > 联邦项目** + + +本节介绍如何为联邦项目添加集群。 + +联邦项目是基于多个集群创建的项目。联邦项目中的资源可运行在不同集群上。 + +[.admon.note,cols="a"] +|=== +|说明 + +| +ifeval::["{file_output_type}" == "html"] +若要联邦项目运行在多个集群上，联邦项目所属的企业空间必须获得多个集群的授权。有关更多信息，请参阅link:../../../../08-workspace-management/02-workspaces/01-create-a-workspace[创建企业空间]。 + +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +若要联邦项目运行在多个集群上，联邦项目所属的企业空间必须获得多个集群的授权。有关更多信息，请参阅《{ks_product_right}企业空间管理指南》的“创建企业空间”章节。 + +endif::[] +|=== + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + +. 在需要操作的项目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**添加集群**。 + +. 在**添加集群**对话框，从下拉列表中选择集群，然后点击**确定**。 ++ +-- +* 点击**添加**可添加多个集群。 + +* 在已添加的集群右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可取消添加该集群。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/06-delete-projects.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/06-delete-projects.adoc new file mode 100644 index 000000000..a9c564f89 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/06-delete-projects.adoc @@ -0,0 +1,49 @@ +--- +title: "删除联邦项目" +keywords: "Kuberentes, {ks_product}, 企业空间管理, 联邦项目, 删除项目" +description: "介绍如何编辑删除项目。" +weight: 06 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **项目 > 联邦项目** + + +include::../../../../_custom/clusterManagement/projects/projects-desc-deleteProjects.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + +== 删除单个项目 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/projects/projects-oper-deleteASingleProject.adoc[] + + +== 批量删除项目 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/projects/projects-oper-deleteMultipleProjects.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/_index.adoc new file mode 100644 index 000000000..660ca1075 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/01-manage-multi-project/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "管理联邦项目" +keywords: "Kuberentes, {ks_product}, 企业空间管理, 联邦项目" +description: "介绍如何查看联邦项目信息以及管理联邦项目。" +weight: 01.5 +--- + + + +本节介绍如何管理联邦项目。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/02-overview/01-view-project-overall-information.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/02-overview/01-view-project-overall-information.adoc new file mode 100644 index 000000000..4e7dc0570 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/02-overview/01-view-project-overall-information.adoc @@ -0,0 +1,54 @@ +--- +title: "查看联邦项目概览信息" +keywords: "Kubernetes, {ks_product}, 联邦项目, 概览, 查看联邦项目概览信息" +description: "介绍如何查看联邦项目概览信息。" +weight: 01 +--- + +:ks_permission: **联邦项目查看** +:ks_navigation: **概览** + + +本节介绍如何查看联邦项目概览信息。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +-- +**概览**页面提供以下信息： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|企业空间 +|联邦项目所属的企业空间。 + +|创建者 +|创建联邦项目的用户。 + +|资源状态 +|联邦项目中已创建的应用资源和已使用的物理资源。在右上角点击下拉列表可选择联邦项目所在的某一集群和数据的时间范围。 + +* **应用资源**：联邦项目中已创建的部署、有状态副本集、持久卷声明、服务和应用路由的数量。 + +* **物理资源**：联邦项目的 CPU 和内存使用量。 + +|资源用量 Top 5 +|联邦项目中特定资源用量最高的 5 个工作负载。点击下拉列表可选择联邦项目所在的某一集群，并按 CPU、内存、出站流量或入站流量排序。 +|=== +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/02-overview/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/02-overview/_index.adoc new file mode 100644 index 000000000..15ac15b9d --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/02-overview/_index.adoc @@ -0,0 +1,8 @@ +--- +title: "概览" +keywords: "Kubernetes, {ks_product}, 联邦项目, 概览" +description: "介绍如何查看联邦项目概览信息。" +weight: 02 +--- + + diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/01-compose-an-app.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/01-compose-an-app.adoc new file mode 100644 index 000000000..e25e39b6e --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/01-compose-an-app.adoc @@ -0,0 +1,67 @@ +--- +title: "创建自制应用" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用, 创建应用" +description: "介绍如何在联邦项目中创建应用。" +weight: 01 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **应用负载 > 自制应用** + + +本节介绍如何在联邦项目中创建自制应用。 + +include::../../../../../_custom/projectManagement/apps/apps-compose-description.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* 如需为应⽤启⽤应⽤治理功能，{ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**应用**页面，点击**创建**。 + +. 在**基本信息**页签，设置应用的基本信息，然后点击**下一步**。 ++ +-- +include::../../../../../_custom/projectManagement/apps/apps-basic-para.adoc[] +-- + +. 在**服务设置**页签，点击**创建服务**，选择**有状态服务**或**无状态服务**为应用创建服务，然后点击**下一步**。 ++ +-- +include::../../../../../_custom/clusterManagement/services/services-para-statelessStatefulExternal.adoc[] + +[.admon.note,cols="a"] +|=== +|说明 + +| +有关更多信息，请参阅link:../../02-services/01-create-a-stateful-or-stateless-service[创建有状态或无状态服务]。 +|=== +-- + +. 在**路由设置**页签，点击**添加路由规则**为应用创建路由规则，然后点击**创建**。 ++ +-- +include::../../../../../_custom/multi-clusterProjectManagement/routes/routes-create-ClusterDiff.adoc[] + +include::../../../../../_custom/clusterManagement/routes/routes-para-routingRules.adoc[] + +应用创建完成后将显示在应用列表页面。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/02-view-an-app-list.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/02-view-an-app-list.adoc new file mode 100644 index 000000000..bf7a97343 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/02-view-an-app-list.adoc @@ -0,0 +1,73 @@ +--- +title: "查看自制应用列表" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用, 查看应用列表" +description: "介绍如何在联邦项目中查看应用列表。" +weight: 02 +--- + +:ks_permission: **联邦项目查看** +:ks_navigation: **应用负载 > 自制应用** + + +本节介绍如何在联邦项目中查看应用列表。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**应用**页面，查看当前联邦项目中已创建的应用列表。 ++ +==== +* 应用列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|应用的名称。 + +|状态 +|联邦应用当前的状态。 + +* **等待中**：系统正在创建应用。 + +* **运行中**：应用运行正常。 + +* **更新中**：系统正在更新应用版本。 + +* **删除中**：系统正在删除应用。 + +* **失败**：应用创建失败。 + + +|版本 +|应用的版本号。对于自制应用，显示用户自定义的版本号。 + +|创建时间 +|应用的创建时间。 +|=== +-- + +* 在列表上方点击搜索框并输入关键字，可按名称搜索应用。 + +include::../../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/03-view-app-details.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/03-view-app-details.adoc new file mode 100644 index 000000000..1590f3e59 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/03-view-app-details.adoc @@ -0,0 +1,82 @@ +--- +title: "查看自制应用详情" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用, 查看应用详情" +description: "介绍如何在联邦项目中查看应用详情。" +weight: 03 +--- + +:ks_permission: **联邦项目查看** +:ks_navigation: **应用负载 > 自制应用** + + +本节介绍如何在联邦项目中查看应用详情。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**应用**页面，点击一个应用的名称打开其详情页面。 + +. 在应用详情页面左侧的**属性**区域查看应用的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../../_custom/multi-clusterProjectManagement/apps/apps-para-details.adoc[] + +|=== +-- + ++ + +include::../../../../../_custom/multi-clusterProjectManagement/apps/apps-oper-viewResourceStatus.adoc[] + ++ + +. 在应用详情页面右侧点击**外部访问**查看应用的外部访问模式。 + +. 在应用详情页面右侧点击**流量管理**查看应用的流量信息。 ++ +-- +// Note +include::../../../../../../_ks_components/admonitions/note.adoc[] + +* 在**集群**区域，可选择应用所在的某一集群，查看指定集群的应用流量信息。 + +* 如需使用**流量监控**功能，{ks_product_right}平台需要安装并启用 KubeSphere 服务网格扩展组件，同时您需要在创建应用时启用应用治理功能。有关更多信息，请参阅link:../01-compose-an-app/[创建自制应用]。 + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +. 在应用详情页面右侧点击**链路追踪**查看应用请求链路信息。 ++ +-- +// Note +include::../../../../../../_ks_components/admonitions/note.adoc[] + +* 在**集群**区域，可选择应用所在的某一集群，查看指定集群的应用请求链路信息。 + +* 如需使用**链路追踪**功能，{ks_product_right}平台需要安装并启用 KubeSphere 服务网格扩展组件，同时您需要进行以下操作： + +** 创建应用时启用应用治理功能。有关更多信息，请参阅link:../01-compose-an-app/[创建自制应用]。 + +** 启用项目网关，并为项目网关启用链路追踪功能。有关更多信息，请参阅link:../../../../12-gateway/01-project-gateway/01-enable-a-project-gateway[启用项目网关]。 +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/04-delete-apps.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/04-delete-apps.adoc new file mode 100644 index 000000000..e73b3d0b3 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/04-delete-apps.adoc @@ -0,0 +1,44 @@ +--- +title: "删除自制应用" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用, 删除应用" +description: "介绍如何从联邦项目中删除应用。" +weight: 04 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **应用负载 > 自制应用** + + +本节介绍如何从联邦项目中删除应用。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**应用**页面，找到需要删除的应用，点击右侧的 image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除应用**对话框，输入应用的名称，然后点击**确定**。 ++ +-- +// Warning +include::../../../../../../_ks_components/admonitions/warning.adoc[] + +应用删除后无法恢复，请谨慎执行此操作。 + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/_index.adoc new file mode 100644 index 000000000..0c599bb3f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/01-apps/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "自制应用" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用, 管理" +description: "介绍如何管理联邦项目中安装的自制应用。" +weight: 01 +--- + + + +本节介绍如何管理联邦项目中安装的应用。联邦项目中仅支持创建自制应用，不支持创建基于模板的应用。 + +include::../../../../../_custom/projectManagement/apps/apps-types.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/01-create-a-stateful-or-stateless-service.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/01-create-a-stateful-or-stateless-service.adoc new file mode 100644 index 000000000..670ef0460 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/01-create-a-stateful-or-stateless-service.adoc @@ -0,0 +1,299 @@ +--- +title: "创建有状态或无状态服务" +keywords: "Kubernetes, {ks_product}, 联邦项目, 工作负载, 服务, 创建服务, 创建有状态或无状态服务" +description: "介绍如何创建有状态或无状态服务。" +weight: 01 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **应用负载 > 服务** + + +本节介绍如何在联邦项目中创建有状态或无状态服务。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +请参阅link:#_参数描述[参数描述]设置服务的参数。 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**创建服务**对话框，根据需要选择**有状态服务**或**无状态服务**。 ++ +-- +// Note +include::../../../../../../_ks_components/admonitions/note.adoc[] + +include::../../../../../_custom/clusterManagement/services/services-para-statelessStatefulExternal.adoc[] + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + ++ + +include::../../../../../_custom/projectManagement/services/services-oper-setBasicInformation.adoc[] + ++ + +. 在**容器组设置**页签，为服务后端工作负载管理的容器组设置集群中的副本数量、容器、更新策略、安全上下文、调度规则和元数据，然后点击**下一步**。 + ++ + +include::../../../../../_custom/multi-clusterProjectManagement/services/services-oper-setStorageAdvancedDiff.adoc[] + + +== 参数描述 + +以下介绍如何设置有状态服务和无状态服务的参数。 + +* 基本信息 ++ +-- +include::../../../../../_custom/projectManagement/services/services-para-setServiceInformation.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../../_custom/clusterManagement/services/services-para-serviceName.adoc[] + +include::../../../../../_custom/clusterManagement/services/services-para-serviceAlias.adoc[] + +include::../../../../../_custom/projectManagement/services/services-para-serviceVersion.adoc[] + +include::../../../../../_custom/clusterManagement/services/services-para-serviceDescription.adoc[] +|=== +-- + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podReplicas.adoc[] + +* 容器组设置 > 添加容器 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] +-- + +* 容器组设置 > 添加容器 > 容器设置 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] + +include::../../../../../_custom/clusterManagement/projects/projects-para-containerQuotas.adoc[] +|=== +-- + +* 容器组设置 > 添加容器 > 端口设置 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] +-- + +* 容器组设置 > 添加容器 > 镜像拉取策略 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] +-- + +* 容器组设置 > 添加容器 > 健康检查 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] +-- + +* 容器组设置 > 添加容器 > 健康检查 > 添加探针 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc[] +-- + +* 容器组设置 > 添加容器 > 生命周期管理 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] +-- + +* 容器组设置 > 添加容器 > 生命周期管理 > 添加动作 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] +-- + +* 容器组设置 > 添加容器 > 启动命令 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] +-- + +* 容器组设置 > 添加容器 > 环境变量 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] +-- + +* 容器组设置 > 添加容器 > 容器组安全上下文 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] +-- + +* 容器组设置 > 添加容器 > 同步主机时区 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] +-- + +* 容器组设置 > 更新策略 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc[] +-- + +* 容器组设置 > 更新策略 > 滚动更新设置 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc[] +-- + +* 容器组设置 > 容器组安全上下文 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSecurityContext.adoc[] +-- + +* 容器组设置 > 容器组调度规则 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc[] +-- + +* 容器组设置 > 容器组调度规则 > 自定义规则 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc[] +-- + +* 容器组设置 > 容器组优雅终止 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc[] +-- + +* 容器组设置 > 添加元数据 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodMetadata.adoc[] +-- + +* 存储设置 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] +|=== + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume.adoc[] +-- + +* 存储设置 > 添加持久卷声明模板 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc[] +-- + +* 存储设置 > 挂载卷 > 持久卷 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] +-- + +* 存储设置 > 挂载卷 > 临时卷 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume.adoc[] +-- + +* 存储设置 > 挂载卷 > HostPath 卷 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] +-- + +* 存储设置 > 挂载配置字典或保密字典 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] +-- + +* 高级设置 ++ +-- +// include::../../../../../_custom/projectManagement/services/services-desc-setLabelsAnnotations.adoc[] + +为服务后端工作负载管理的容器组指定节点，设置服务的外部访问模式、会话保持设置和元数据。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podIpPool.adoc[] + +include::../../../../../_custom/clusterManagement/services/services-para-externalAccess.adoc[] + +include::../../../../../_custom/clusterManagement/services/services-para-sessionPersistence.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc[] + +|添加元数据 +| +include::../../../../../_custom/projectManagement/services/services-desc-setServiceLabelWorkloadAnnotation.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc[] +|=== +-- + +* 集群差异设置 ++ +-- +为不同集群中的服务基于容器、端口和环境变量进行差异化设置。 + +include::../../../../../_custom/multi-clusterProjectManagement/services/services-oper-setClusterDiff.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/02-view-a-service-list.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/02-view-a-service-list.adoc new file mode 100644 index 000000000..60e3a54d5 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/02-view-a-service-list.adoc @@ -0,0 +1,74 @@ +--- +title: "查看服务列表" +keywords: "Kubernetes, {ks_product}, 项目管理, 工作负载, 服务, 查看服务列表" +description: "介绍如何查看服务列表。" +weight: 02 +--- + +:ks_permission: **联邦项目查看** +:ks_navigation: **应用负载 > 服务** + + +include::../../../../../_custom/clusterManagement/services/services-desc-viewServiceList.adoc[] + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] ++ +==== +* 服务列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../../_custom/clusterManagement/services/services-para-name.adoc[] + +|状态 +|服务的状态，**运行中**或**删除中**。 + +|服务类型 +|服务的类型。取决于服务的创建方式，{ks_product_right}将服务划分为以下类型： + +include::../../../../../_custom/clusterManagement/services/services-para-statelessStatefulExternal.adoc[] + +// * **外部服务**：服务将业务流量转发给集群外部的其他服务。系统不为服务分配虚拟 IP 地址，可通过 .**.svc.cluster.local** 格式的域名从集群内部访问。 + +// * **自定义服务**：用户通过自定义服务的内部访问模式和后端工作负载创建的服务。 + +|应用 +|服务所属的应用。 + +// |内部访问 +// | +// include::../../../../../_custom/clusterManagement/services/services-para-internalAccess.adoc[] + +// include::../../../../../_custom/clusterManagement/services/services-para-virtualip-headless.adoc[] + +// include::../../../../../_custom/clusterManagement/services/services-para-externalName.adoc[] + +// include::../../../../../_custom/clusterManagement/services/services-para-externalAccess.adoc[] + +include::../../../../../_custom/clusterManagement/services/services-para-creationTime.adoc[] +|=== +-- + +include::../../../../../_custom/clusterManagement/services/services-oper-searchForServices.adoc[] + +include::../../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/03-view-service-details.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/03-view-service-details.adoc new file mode 100644 index 000000000..eeff71bc7 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/03-view-service-details.adoc @@ -0,0 +1,37 @@ +--- +title: "查看服务详情" +keywords: "Kubernetes, {ks_product}, 项目管理, 工作负载, 服务, 查看服务详情" +description: "介绍如何查看服务详情。" +weight: 03 +--- + +:ks_permission: **联邦项目查看** +:ks_navigation: **应用负载 > 服务** + + +include::../../../../../_custom/clusterManagement/services/services-desc-viewServiceDetails.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/services/services-oper-openDetailsPage.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/services/services-oper-viewServiceDetails-for-kubefed.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/04-edit-service-information.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/04-edit-service-information.adoc new file mode 100644 index 000000000..d061f4d1d --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/04-edit-service-information.adoc @@ -0,0 +1,33 @@ +--- +title: "编辑服务信息" +keywords: "Kubernetes, {ks_product}, 项目管理, 工作负载, 服务, 编辑服务信息" +description: "介绍如何编辑服务信息。" +weight: 04 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **应用负载 > 服务** + + +include::../../../../../_custom/clusterManagement/services/services-desc-editServiceInformation.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/services/services-oper-editServiceInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/05-edit-service-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/05-edit-service-settings.adoc new file mode 100644 index 000000000..9ac141774 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/05-edit-service-settings.adoc @@ -0,0 +1,33 @@ +--- +title: "编辑服务设置" +keywords: "Kubernetes, {ks_product}, 项目管理, 工作负载, 服务, 编辑服务设置" +description: "介绍如何编辑服务设置。" +weight: 05 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **应用负载 > 服务** + + +include::../../../../../_custom/clusterManagement/services/services-desc-editServiceSettings.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/services/services-oper-editServiceSettings-for-kubefed.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/06-edit-service-external-access-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/06-edit-service-external-access-settings.adoc new file mode 100644 index 000000000..d749d3c83 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/06-edit-service-external-access-settings.adoc @@ -0,0 +1,41 @@ +--- +title: "编辑服务外部访问设置" +keywords: "Kubernetes, {ks_product}, 项目管理, 工作负载, 服务, 编辑服务外部访问设置" +description: "介绍如何编辑服务外部访问设置。" +weight: 06 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **应用负载 > 服务** + + +include::../../../../../_custom/clusterManagement/services/services-desc-editServiceExternalAccessSettings.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/services/services-oper-openDetailsPage.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/services/services-oper-openServiceExternalAccessSettings.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/services/services-oper-editServiceExternalAccessSettings.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/07-delete-services.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/07-delete-services.adoc new file mode 100644 index 000000000..0978b10ad --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/07-delete-services.adoc @@ -0,0 +1,50 @@ +--- +title: "删除服务" +keywords: "Kubernetes, {ks_product}, 项目管理, 工作负载, 服务, 删除服务" +description: "介绍如何编辑服务外部访问设置。" +weight: 07 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **应用负载 > 服务** + + +include::../../../../../_custom/clusterManagement/services/services-desc-deleteServices.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 删除单个服务 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/services/services-oper-deleteASingleService.adoc[] + ++ + +. 在**删除服务**对话框，选择需要同时删除的工作负载，然后点击**确定**。 + + +== 批量删除服务 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/services/services-oper-deleteMultipleServices.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/_index.adoc new file mode 100644 index 000000000..f1cfce649 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/02-services/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "服务" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用负载, 服务" +description: "介绍如何管理联邦项目中的服务。" +weight: 02 +--- + + + +include::../../../../../_custom/clusterManagement/services/services-desc-services.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/01-create-a-workload.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/01-create-a-workload.adoc new file mode 100644 index 000000000..be52f122e --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/01-create-a-workload.adoc @@ -0,0 +1,290 @@ +--- +title: "创建工作负载" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用负载, 工作负载, 创建工作负载" +description: "介绍如何创建工作负载。" +weight: 01 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **应用负载 > 工作负载** + +:kubefed: + +include::../../../../../_custom/clusterManagement/workloads/workloads-desc-createAWorkload.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +请参阅link:#_参数描述[参数描述]设置工作负载的参数。 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-createAWorkload-ClusterDiff.adoc[] + + +== 参数描述 + +以下介绍如何设置工作负载的参数。 + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-basicInformation.adoc[] + + +* 容器组设置 > 副本调度模式 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|指定副本数量 +|手动设置每个集群的容器组副本数。 + +点击image:/images/ks-qkcp/zh/icons/add-light.svg[add,18,18]/image:/images/ks-qkcp/zh/icons/substract-light.svg[subtract,18,18]增加/减少容器组副本的数量，最小值为 **1**。 + +|指定权重 +|设置容器组副本总数和每个集群的权重。容器组副本将根据权重比例调度到每个集群。 + +点击image:/images/ks-qkcp/zh/icons/add-light.svg[add,18,18]/image:/images/ks-qkcp/zh/icons/substract-light.svg[subtract,18,18]增加/减少集群的权重，最小值为 **1**。 + +例如：如果容器组副本总数是 10，host 和 member 集群的权重分别为 3 和 2，那么 host 集群的容器组副本数为 6，member 集群的容器组副本数为 4。 +|=== +-- + +// include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podReplicas.adoc[] + +* 容器组设置 > 添加容器 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] +-- + +* 容器组设置 > 添加容器 > 容器设置 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] + +include::../../../../../_custom/clusterManagement/projects/projects-para-containerQuotas.adoc[] +|=== +-- + +* 容器组设置 > 添加容器 > 端口设置 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] +-- + +* 容器组设置 > 添加容器 > 镜像拉取策略 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] +-- + +* 容器组设置 > 添加容器 > 健康检查 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] +-- + +* 容器组设置 > 添加容器 > 健康检查 > 添加探针 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc[] +-- + +* 容器组设置 > 添加容器 > 生命周期管理 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] +-- + +* 容器组设置 > 添加容器 > 生命周期管理 > 添加动作 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] +-- + +* 容器组设置 > 添加容器 > 启动命令 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] +-- + +* 容器组设置 > 添加容器 > 环境变量 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] +-- + +* 容器组设置 > 添加容器 > 容器组安全上下文 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] +-- + +* 容器组设置 > 添加容器 > 同步主机时区 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] +-- + +* 容器组设置 > 更新策略 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc[] +-- + +* 容器组设置 > 更新策略 > 滚动更新设置 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc[] +-- + +* 容器组设置 > 容器组安全上下文 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSecurityContext.adoc[] +-- + +* 容器组设置 > 容器组调度规则 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc[] +-- + +* 容器组设置 > 容器组调度规则 > 自定义规则 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc[] +-- + +* 容器组设置 > 容器组优雅终止 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc[] +-- + +* 容器组设置 > 添加元数据 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodMetadata.adoc[] +-- + +* 存储设置 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc[] + +// include::../../../../../_custom/projectManagement/workloads/workloads-desc-enableLogCollectionProject.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] +|=== + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume.adoc[] +-- + +* 存储设置 > 添加持久卷声明模板 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc[] +-- + +* 存储设置 > 挂载卷 > 持久卷 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] +-- + +* 存储设置 > 挂载卷 > 临时卷 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume.adoc[] +-- + +* 存储设置 > 挂载卷 > HostPath 卷 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] +-- + +* 存储设置 > 挂载配置字典或保密字典 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] +-- + +* 高级设置 ++ +-- +为工作负载管理的容器组指定节点，并设置工作负载的元数据。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podIpPool.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-selectNode.adoc[] + +|添加元数据 +| +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setWorkloadMetadata.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Metadata.adoc[] +|=== +-- + +* 集群差异设置 ++ +-- +为不同集群中的工作负载基于容器、端口和环境变量进行差异化设置。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../../_custom/multi-clusterProjectManagement/workloads/workloads-oper-setClusterDiff.adoc[] + +|=== +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/02-view-a-workload-list.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/02-view-a-workload-list.adoc new file mode 100644 index 000000000..f6653fc37 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/02-view-a-workload-list.adoc @@ -0,0 +1,43 @@ +--- +title: "查看工作负载列表" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用负载, 工作负载, 查看工作负载列表" +description: "介绍如何查看工作负载列表。" +weight: 02 +--- + +:ks_permission: **联邦项目查看** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../../_custom/clusterManagement/workloads/workloads-desc-viewAWorkloadList.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc[] ++ +==== +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-multi-project-para-workloadList.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-searchForWorkloads.adoc[] + +include::../../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/03-view-workload-details.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/03-view-workload-details.adoc new file mode 100644 index 000000000..2f44a29e8 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/03-view-workload-details.adoc @@ -0,0 +1,41 @@ +--- +title: "查看工作负载详情" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用负载, 工作负载, 查看工作负载详情" +description: "介绍如何查看工作负载详情。" +weight: 03 +--- + +:ks_permission: **联邦项目查看** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../../_custom/clusterManagement/workloads/workloads-desc-viewWorkloadDetails.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc[] + ++ + +include::../../../../../_custom/multi-clusterProjectManagement/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../../_custom/multi-clusterProjectManagement/workloads/workloads-oper-viewWorkloadDetails_v4.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/04-edit-workload-information.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/04-edit-workload-information.adoc new file mode 100644 index 000000000..a0aed4b95 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/04-edit-workload-information.adoc @@ -0,0 +1,37 @@ +--- +title: "编辑工作负载信息" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用负载, 工作负载, 编辑工作负载信息" +description: "介绍如何编辑工作负载信息。" +weight: 04 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../../_custom/clusterManagement/workloads/workloads-desc-editWorkloadInformation.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/workloads/workloads-oper-editWorkloadInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/05-adjust-the-number-of-pod-replicas.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/05-adjust-the-number-of-pod-replicas.adoc new file mode 100644 index 000000000..826ea548a --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/05-adjust-the-number-of-pod-replicas.adoc @@ -0,0 +1,40 @@ +--- +title: "调整容器组副本数量" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用负载, 工作负载, 调整容器组副本数量" +description: "介绍如何调整容器组副本数量。" +weight: 05 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../../_custom/clusterManagement/workloads/workloads-desc-adjustTheNumberOfPodReplicas.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc[] + ++ + +include::../../../../../_custom/multi-clusterProjectManagement/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/workloads/workloads-oper-adjustTheNumberOfPodReplicas.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/06-stop-workloads.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/06-stop-workloads.adoc new file mode 100644 index 000000000..89292a8d1 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/06-stop-workloads.adoc @@ -0,0 +1,37 @@ +--- +title: "停止工作负载" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用负载, 工作负载, 停止工作负载" +description: "介绍如何停止工作负载。" +weight: 06 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../../_custom/clusterManagement/workloads/workloads-desc-stopWorkloads.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/workloads/workloads-oper-stopWorkloads.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/07-edit-workload-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/07-edit-workload-settings.adoc new file mode 100644 index 000000000..8a4c0545b --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/07-edit-workload-settings.adoc @@ -0,0 +1,225 @@ +--- +title: "编辑工作负载设置" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用负载, 工作负载, 编辑工作负载设置" +description: "介绍如何编辑工作负载设置。" +weight: 07 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../../_custom/clusterManagement/workloads/workloads-desc-editWorkloadSettings.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc[] + ++ + +include::../../../../../_custom/multi-clusterProjectManagement/workloads/workloads-oper-openDetailsPage.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/workloads/workloads-oper-editWorkloadSettings.adoc[] + ++ + +. 在**编辑设置**对话框，分别设置工作负载的更新策略、容器、存储、容器组调度规则（仅对部署可用）、容器组优雅终止、以及集群差异设置，然后点击**确定**。有关具体的参数设置方法，请参阅link:#_参数描述[参数描述]。 + +== 参数描述 + +* 更新策略 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc[] +-- + +* 更新策略 > 滚动更新设置 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc[] +-- + +* 容器 > 添加容器 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] +-- + +* 容器 > 添加容器 > 容器设置 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] + +include::../../../../../_custom/clusterManagement/projects/projects-para-containerQuotas.adoc[] +|=== +-- + +* 容器 > 添加容器 > 端口设置 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] +-- + +* 容器 > 添加容器 > 镜像拉取策略 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] +-- + +* 容器 > 添加容器 > 健康检查 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] +-- + +* 容器 > 添加容器 > 生命周期管理 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] +-- +* 容器 > 添加容器 > 生命周期管理 > 添加动作 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] +-- +* 容器 > 添加容器 > 启动命令 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] +-- + +* 容器 > 添加容器 > 环境变量 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] +-- + +* 容器 > 添加容器 > 容器安全上下文 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] +-- + +* 容器 > 添加容器 > 同步主机时区 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] +-- + +* 存储 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc[] + + +// :relfileprefix: ../../../../../ + +// include::../../../../../_custom/projectManagement/workloads/workloads-desc-enableLogCollectionProject.adoc[] + +// :relfileprefix: ./ + + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] +|=== + +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume_new.adoc[] +-- + +* 存储 > 挂载卷 > 持久卷 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] +-- + +* 存储 > 挂载卷 > 临时卷 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume.adoc[] +-- + +* 存储 > 挂载卷 > HostPath 卷 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] +-- + +* 存储 > 挂载配置字典或保密字典 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] +-- + +* 容器组调度规则（仅对部署可用） ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc[] +-- + +* 容器组调度规则 > 自定义规则 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc[] +-- + +* 容器组优雅终止 ++ +-- +include::../../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc[] +-- + +// * 容器组 IP 池 +// + +// -- +// 选择后将为容器组分配 IP 地址。 +// -- + +* 集群差异设置 ++ +-- +在**集群**区域，勾选项目所在的一个或多个集群，为指定集群中的工作负载基于容器、端口和环境变量进行差异化设置。 + +[%header, cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../../_custom/multi-clusterProjectManagement/workloads/workloads-oper-setClusterDiff.adoc[] + +|=== +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/08-delete-workloads.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/08-delete-workloads.adoc new file mode 100644 index 000000000..15f54224a --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/08-delete-workloads.adoc @@ -0,0 +1,59 @@ +--- +title: "删除工作负载" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用负载, 工作负载, 删除工作负载" +description: "介绍如何删除工作负载。" +weight: 08 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **应用负载 > 工作负载** + + +include::../../../../../_custom/clusterManagement/workloads/workloads-desc-deleteWorkloads.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 删除单个工作负载 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/workloads/workloads-oper-deleteASingleWorkload.adoc[] + ++ + +. 在**删除工作负载**对话框，选择需要同时删除的相关资源，然后点击**确定**。 + + + +== 批量删除工作负载 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/workloads/workloads-multi-project-oper-openListPage.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/workloads/workloads-oper-deleteMultipleWorkloads.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/_index.adoc new file mode 100644 index 000000000..8dbd28dd2 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/03-workloads/_index.adoc @@ -0,0 +1,26 @@ +--- +title: "工作负载" +keywords: "Kubernetes, {ks_product}, 项目管理, 应用负载, 工作负载" +description: "介绍如何管理联邦项目中的工作负载。" +weight: 03 +--- + +// include::../../../../../_custom/clusterManagement/workloads/workloads-desc-workloads.adoc[] + +本节介绍如何管理工作负载。 + +在{ks_product_both}平台，应用程序运行在容器组中。为确保单个容器组出现故障时业务不会中断，通常需要为一个应用程序创建多个容器组副本。工作负载是用于管理容器组副本的资源，负责对一个应用程序的多个容器组副本进行管理，主要提供以下功能： + +* 根据用户设定的条件自动扩缩容器组副本数量。 + +* 根据用户指定的更新策略自动更新容器组。 + +* 将容器组回滚到以前的版本。 + +联邦项目支持以下工作负载类型： + +* 部署：用于管理无状态应用。部署管理的多个容器组副本共用一个卷。当容器组副本重新创建时，新容器组副本和旧容器组副本的名称不同。 + +* 有状态副本集：用于管理有状态应用。有状态副本集管理的多个容器副本可以分别使用独立的卷。每个容器组副本的名称具有固定的序号，当容器组副本重新创建时，新容器组副本和旧容器组副本名称相同。 + +// * 守护进程集：用于管理守护进程。守护进程集确保所有或特定的节点都运行一个容器组副本。当新节点添加到集群时，如果新节点符合容器组调度规则，守护进程集会自动在新节点上创建一个容器组副本。 diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/01-create-a-route.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/01-create-a-route.adoc new file mode 100644 index 000000000..0b3dc1670 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/01-create-a-route.adoc @@ -0,0 +1,41 @@ +--- +title: "创建应用路由" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用负载, 应用路由, 创建应用路由" +description: "介绍如何创建应用路由。" +weight: 01 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **应用负载 > 应用路由** + + +include::../../../../../_custom/clusterManagement/routes/routes-desc-createARoute.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + +* 如需创建支持 HTTPS 协议的应用路由，您需要创建 **TLS 信息**类型的保密字典，保密字典中必须包含 Base64 编码的证书和私钥。有关更多信息，请参阅link:../../../05-configuration/01-secrets/01-create-a-secret/[创建保密字典]。 + +* 应用路由所属的项目中存在至少一个服务。有关更多信息，请参阅link:../../02-services/01-create-a-stateful-or-stateless-service/[创建有状态或无状态服务]。 + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/routes/routes-oper-createARoute.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/02-view-a-route-list.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/02-view-a-route-list.adoc new file mode 100644 index 000000000..c777075a8 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/02-view-a-route-list.adoc @@ -0,0 +1,39 @@ +--- +title: "查看应用路由列表" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用负载, 应用路由, 查看应用路由列表" +description: "介绍如何查看应用路由列表。" +weight: 02 +--- + +:ks_permission: **联邦项目查看** +:ks_navigation: **应用负载 > 应用路由** + + +include::../../../../../_custom/clusterManagement/routes/routes-desc-viewARouteList.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] ++ +==== +include::../../../../../_custom/multi-clusterProjectManagement/routes/routes-para-routeList.adoc[] + +include::../../../../../_custom/clusterManagement/routes/routes-oper-searchForRoutes.adoc[] + +include::../../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/03-view-route-details.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/03-view-route-details.adoc new file mode 100644 index 000000000..f91904592 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/03-view-route-details.adoc @@ -0,0 +1,37 @@ +--- +title: "查看应用路由详情" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用负载, 应用路由, 查看应用路由详情" +description: "介绍如何查看应用路由详情。" +weight: 03 +--- + +:ks_permission: **联邦项目查看** +:ks_navigation: **应用负载 > 应用路由** + + +include::../../../../../_custom/clusterManagement/routes/routes-desc-viewRouteDetails.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/routes/routes-oper-openDetailsPage.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/routes/routes-oper-viewRouteDetails-for-kubefed.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/04-edit-route-information.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/04-edit-route-information.adoc new file mode 100644 index 000000000..2fb3114b6 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/04-edit-route-information.adoc @@ -0,0 +1,33 @@ +--- +title: "编辑应用路由信息" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用负载, 应用路由, 编辑应用路由信息" +description: "介绍如何编辑应用路由信息。" +weight: 04 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **应用负载 > 应用路由** + + +include::../../../../../_custom/clusterManagement/routes/routes-desc-editRouteInformation.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/routes/routes-oper-editRouteInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/05-edit-routing-rules.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/05-edit-routing-rules.adoc new file mode 100644 index 000000000..3ef297850 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/05-edit-routing-rules.adoc @@ -0,0 +1,32 @@ +--- +title: "编辑路由规则" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用负载, 应用路由, 编辑路由规则" +description: "介绍如何编辑路由规则。" +weight: 05 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **应用负载 > 应用路由** + + +include::../../../../../_custom/clusterManagement/routes/routes-desc-editingRutingRules.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/routes/routes-oper-editRoutingRules.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/06-edit-route-annotations.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/06-edit-route-annotations.adoc new file mode 100644 index 000000000..e15829f4e --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/06-edit-route-annotations.adoc @@ -0,0 +1,33 @@ +--- +title: "编辑应用路由注解" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用负载, 应用路由, 编辑应用路由注解" +description: "介绍如何应用路由注解。" +weight: 06 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **应用负载 > 应用路由** + + +include::../../../../../_custom/clusterManagement/routes/routes-desc-editRouteAnnotations.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/routes/routes-oper-editRouteAnnotations.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/07-delete-routes.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/07-delete-routes.adoc new file mode 100644 index 000000000..2c71b6f85 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/07-delete-routes.adoc @@ -0,0 +1,45 @@ +--- +title: "删除应用路由" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用负载, 应用路由, 删除应用路由" +description: "介绍如何删除应用路由。" +weight: 07 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **应用负载 > 应用路由** + + +include::../../../../../_custom/clusterManagement/routes/routes-desc-deleteMultipleRoutes.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + +== 删除单个应用路由 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/routes/routes-oper-deleteASingleRoute.adoc[] + + +== 批量删除应用路由 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/routes/routes-oper-deleteRoutes.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/_index.adoc new file mode 100644 index 000000000..a144fb24d --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/04-routes/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "应用路由" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用负载, 应用路由" +description: "介绍如何管理联邦项目中的应用路由。" +weight: 04 +--- + + + +include::../../../../../_custom/clusterManagement/routes/routes-desc-routes.adoc[] + +有关集群网关和项目网关的更多信息，请参阅 link:../../../12-gateway/[KubeSphere 网关]。 diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/_index.adoc new file mode 100644 index 000000000..b4cd1fd56 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/03-application-workloads/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "应用负载" +keywords: "Kubernetes, {ks_product}, 联邦项目, 应用负载" +description: "介绍如何管理联邦项目中的应用负载。" +weight: 03 +--- + + + +本节介绍如何管理联邦项目中的应用、服务、工作负载和应用路由。 diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/01-create-a-persistent-volume-claim.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/01-create-a-persistent-volume-claim.adoc new file mode 100644 index 000000000..afd91fc97 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/01-create-a-persistent-volume-claim.adoc @@ -0,0 +1,37 @@ +--- +title: "创建持久卷声明" +keywords: "Kubernetes, {ks_product}, 联邦项目, 存储, 持久卷声明, 创建持久卷声明" +description: "介绍如何创建持久卷声明。" +weight: 01 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **持久卷声明** + + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAPersistentVolumeClaim.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAPersistentVolumeClaim-for-kubefed.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/02-view-a-persistent-volume-claim-list.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/02-view-a-persistent-volume-claim-list.adoc new file mode 100644 index 000000000..93bb188b3 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/02-view-a-persistent-volume-claim-list.adoc @@ -0,0 +1,39 @@ +--- +title: "查看持久卷声明列表" +keywords: "Kubernetes, {ks_product}, 联邦项目, 存储, 持久卷声明, 查看持久卷声明列表" +description: "介绍如何查看持久卷声明列表。" +weight: 02 +--- + +:ks_permission: **联邦项目查看** +:ks_navigation: **持久卷声明** +:kubefed: + +include::../../../../_custom/clusterManagement/pods/pods-desc-viewAPersistentVolumeList.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +==== +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-persistentVolumeClaimList.adoc[] + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-searchForPersistentVolumeClaims.adoc[] + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/03-view-persistent-volume-claim-details.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/03-view-persistent-volume-claim-details.adoc new file mode 100644 index 000000000..1c39a9a6e --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/03-view-persistent-volume-claim-details.adoc @@ -0,0 +1,38 @@ +--- +title: "查看持久卷声明详情" +keywords: "Kubernetes, {ks_product}, 联邦项目, 存储, 持久卷声明, 查看持久卷声明详情" +description: "介绍如何查看持久卷声明详情。" +weight: 03 +--- + +:ks_permission: **联邦项目查看** +:ks_navigation: **持久卷声明** + + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-viewPersistentVolumeClaimDetails.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-viewPersistentVolumeClaimDetails-for-kubefed.adoc[] + diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/04-edit-persistent-volume-claim-information.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/04-edit-persistent-volume-claim-information.adoc new file mode 100644 index 000000000..4e369aeae --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/04-edit-persistent-volume-claim-information.adoc @@ -0,0 +1,33 @@ +--- +title: "编辑持久卷声明信息" +keywords: "Kubernetes, {ks_product}, 联邦项目, 存储, 持久卷声明, 编辑持久卷声明信息" +description: "介绍如何编辑持久卷声明信息。" +weight: 04 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **持久卷声明** + + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-editPersistentVolumeClaimInformation.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-editPersistentVolumeClaimInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/05-delete-persistent-volume-claims.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/05-delete-persistent-volume-claims.adoc new file mode 100644 index 000000000..0575240da --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/05-delete-persistent-volume-claims.adoc @@ -0,0 +1,48 @@ +--- +title: "删除持久卷声明" +keywords: "Kubernetes, {ks_product}, 联邦项目, 存储, 持久卷声明, 删除持久卷声明" +description: "介绍如何删除持久卷声明。" +weight: 05 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **持久卷声明** + + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-deletePersistentVolumeClaims.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-backData.adoc[] + + +== 删除单个持久卷声明 + +include::../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteASinglePersistentVolumeClaim.adoc[] + + +== 批量删除持久卷声明 + +include::../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-deleteMultiplePersistentVolumeClaims.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/_index.adoc new file mode 100644 index 000000000..a64bcf90e --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/04-peristent-volume-claims/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "持久卷声明" +keywords: "Kubernetes, {ks_product}, 联邦项目, 存储, 持久卷声明" +description: "介绍如何管理联邦项目中的持久卷声明。" +weight: 04 +--- + + + +本节介绍如何管理持久卷声明。 + +系统根据持久卷声明中的参数，在后端存储系统中创建可供容器使用的存储区域，每个存储区域与{ks_product_both}平台上的一个持久卷对应。 diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/01-create-a-secret.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/01-create-a-secret.adoc new file mode 100644 index 000000000..9f8a7a91b --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/01-create-a-secret.adoc @@ -0,0 +1,37 @@ +--- +title: "创建保密字典" +keywords: "Kubernetes, {ks_product}, 联邦项目, 配置, 保密字典, 创建保密字典" +description: "介绍如何创建保密字典。" +weight: 01 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **配置 > 保密字典** + + +include::../../../../../_custom/clusterManagement/secrets/secrets-desc-createASecret.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/secrets/secrets-oper-createASecret.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/02-view-a-secret-list.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/02-view-a-secret-list.adoc new file mode 100644 index 000000000..195cc3023 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/02-view-a-secret-list.adoc @@ -0,0 +1,39 @@ +--- +title: "查看保密字典列表" +keywords: "Kubernetes, {ks_product}, 联邦项目, 配置, 保密字典, 查看保密字典列表" +description: "介绍如何查看保密字典列表。" +weight: 02 +--- + +:ks_permission: **联邦项目查看** +:ks_navigation: **配置 > 保密字典** +:kubefed: + +include::../../../../../_custom/clusterManagement/secrets/secrets-desc-viewASecretList.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] ++ +==== +include::../../../../../_custom/clusterManagement/secrets/secrets-para-secretList.adoc[] + +include::../../../../../_custom/clusterManagement/secrets/secrets-oper-searchForSecrets.adoc[] + +include::../../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/03-view-secret-details.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/03-view-secret-details.adoc new file mode 100644 index 000000000..7816abee9 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/03-view-secret-details.adoc @@ -0,0 +1,37 @@ +--- +title: "查看保密字典详情" +keywords: "Kubernetes, {ks_product}, 联邦项目, 配置, 保密字典, 查看保密字典详情" +description: "介绍如何查看保密字典详情。" +weight: 03 +--- + +:ks_permission: **联邦项目查看** +:ks_navigation: **配置 > 保密字典** + + +include::../../../../../_custom/clusterManagement/secrets/secrets-desc-viewSecretDetails.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/secrets/secrets-oper-openSecretDetailsPage.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/secrets/secrets-oper-viewSecretDetails-for-kubefed.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/04-edit-secret-information.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/04-edit-secret-information.adoc new file mode 100644 index 000000000..39ecaa1b7 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/04-edit-secret-information.adoc @@ -0,0 +1,33 @@ +--- +title: "编辑保密字典信息" +keywords: "Kubernetes, {ks_product}, 联邦项目, 配置, 保密字典, 编辑保密字典信息" +description: "介绍如何编辑保密字典的键值对数据。" +weight: 04 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **配置 > 保密字典** + + +include::../../../../../_custom/clusterManagement/secrets/secrets-desc-editSecretInformation.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/secrets/secrets-oper-editSecretInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/05-edit-secret-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/05-edit-secret-settings.adoc new file mode 100644 index 000000000..bbb389e63 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/05-edit-secret-settings.adoc @@ -0,0 +1,33 @@ +--- +title: "编辑保密字典设置" +keywords: "Kubernetes, {ks_product}, 联邦项目, 配置, 保密字典, 编辑保密字典设置" +description: "介绍如何编辑保密字典的设置。" +weight: 05 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **配置 > 保密字典** + + +include::../../../../../_custom/clusterManagement/secrets/secrets-desc-editSecretSettings.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/secrets/secrets-oper-editSecretSettings.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/06-delete-secrets.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/06-delete-secrets.adoc new file mode 100644 index 000000000..f334e63bd --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/06-delete-secrets.adoc @@ -0,0 +1,46 @@ +--- +title: "删除保密字典" +keywords: "Kubernetes, {ks_product}, 联邦项目, 配置, 保密字典, 删除保密字典" +description: "介绍如何删除保密字典。" +weight: 06 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **配置 > 保密字典** + + +include::../../../../../_custom/clusterManagement/secrets/secrets-desc-deleteSecrets.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 删除单个保密字典 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/secrets/secrets-oper-deleteASingleSecret.adoc[] + + +== 批量删除保密字典 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/secrets/secrets-oper-deleteMultipleSecrets.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/_index.adoc new file mode 100644 index 000000000..d5267eedd --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/01-secrets/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "保密字典" +keywords: "Kubernetes, {ks_product}, 联邦项目, 配置, 保密字典" +description: "介绍如何管理联邦项目中的保密字典。" +weight: 01 +--- + + + +include::../../../../../_custom/clusterManagement/secrets/secrets-desc-secrets.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/01-create-a-configmap.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/01-create-a-configmap.adoc new file mode 100644 index 000000000..3b7680584 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/01-create-a-configmap.adoc @@ -0,0 +1,37 @@ +--- +title: "创建配置字典" +keywords: "Kubernetes, {ks_product}, 联邦项目, 配置, 配置字典, 创建配置字典" +description: "介绍如何创建配置字典。" +weight: 01 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **配置 > 配置字典** + + +include::../../../../../_custom/clusterManagement/configmaps/configmaps-desc-createAConfigmap.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/configmaps/configmaps-oper-createAConfigmap.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/02-view-a-configmap-list.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/02-view-a-configmap-list.adoc new file mode 100644 index 000000000..1cb173053 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/02-view-a-configmap-list.adoc @@ -0,0 +1,39 @@ +--- +title: "查看配置字典列表" +keywords: "Kubernetes, {ks_product}, 联邦项目, 配置, 配置字典, 查看配置字典列表" +description: "介绍如何查看配置字典列表。" +weight: 02 +--- + +:ks_permission: **联邦项目查看** +:ks_navigation: **配置 > 配置字典** + + +include::../../../../../_custom/clusterManagement/configmaps/configmaps-desc-viewAConfigmapList.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] ++ +==== +include::../../../../../_custom/multi-clusterProjectManagement/configmaps/configmaps-para-configmapList.adoc[] + +include::../../../../../_custom/clusterManagement/configmaps/configmaps-oper-searchForConfigmaps.adoc[] + +include::../../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../../_ks_components/oper-customizeColumns.adoc[] +==== \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/03-view-configmap-details.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/03-view-configmap-details.adoc new file mode 100644 index 000000000..99b1d028f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/03-view-configmap-details.adoc @@ -0,0 +1,37 @@ +--- +title: "查看配置字典详情" +keywords: "Kubernetes, {ks_product}, 联邦项目, 配置, 配置字典, 查看配置字典详情" +description: "介绍如何查看配置字典详情。" +weight: 03 +--- + +:ks_permission: **联邦项目查看** +:ks_navigation: **配置 > 配置字典** + + +include::../../../../../_custom/clusterManagement/configmaps/configmaps-desc-viewConfigmapDetails.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/configmaps/configmaps-oper-openDetailsPage.adoc[] + ++ + +include::../../../../../_custom/multi-clusterProjectManagement/configmaps/configmaps-oper-viewConfigmapDetails.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/04-edit-configmap-information.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/04-edit-configmap-information.adoc new file mode 100644 index 000000000..d807929e7 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/04-edit-configmap-information.adoc @@ -0,0 +1,33 @@ +--- +title: "编辑配置字典信息" +keywords: "Kubernetes, {ks_product}, 联邦项目, 配置, 配置字典, 编辑配置字典信息" +description: "介绍如何编辑配置字典信息。" +weight: 04 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **配置 > 配置字典** + + +include::../../../../../_custom/clusterManagement/configmaps/configmaps-desc-editConfigmapInformation.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/configmaps/configmaps-oper-editConfigmapInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/05-edit-configmap-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/05-edit-configmap-settings.adoc new file mode 100644 index 000000000..3ecf08e88 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/05-edit-configmap-settings.adoc @@ -0,0 +1,33 @@ +--- +title: "编辑配置字典设置" +keywords: "Kubernetes, {ks_product}, 联邦项目, 配置, 配置字典, 编辑配置字典设置" +description: "介绍如何编辑配置字典设置。" +weight: 05 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **配置 > 配置字典** + + +include::../../../../../_custom/clusterManagement/configmaps/configmaps-desc-editConfigmapSettings.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/configmaps/configmaps-oper-editConfigmapSettings.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/06-delete-configmaps.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/06-delete-configmaps.adoc new file mode 100644 index 000000000..93bad0065 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/06-delete-configmaps.adoc @@ -0,0 +1,46 @@ +--- +title: "删除配置字典" +keywords: "Kubernetes, {ks_product}, 联邦项目, 配置, 配置字典, 删除配置字典" +description: "介绍如何删除配置字典。" +weight: 06 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **配置 > 配置字典** + + +include::../../../../../_custom/clusterManagement/configmaps/configmaps-desc-deleteConfigmaps.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 删除单个配置字典 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/configmaps/configmaps-oper-deleteASingleConfigmap.adoc[] + + +== 批量删除配置字典 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/configmaps/configmaps-oper-deleteMultipleConfigmaps.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/_index.adoc new file mode 100644 index 000000000..29aac7cb0 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/02-configmaps/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "配置字典" +keywords: "Kubernetes, {ks_product}, 联邦项目, 配置, 配置字典" +description: "介绍如何管理联邦项目中的配置字典。" +weight: 02 +--- + + + +include::../../../../../_custom/clusterManagement/configmaps/configmaps-desc-configmaps.adoc[] + +配置字典仅用于存储非保密数据。如需存储保密数据，请使用link:../01-secrets/[保密字典]。 diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/_index.adoc new file mode 100644 index 000000000..3bc406d23 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/05-configuration/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "配置" +keywords: "Kubernetes, {ks_product}, 联邦项目, 配置" +description: "介绍如何管理保密字典、配置字典和服务帐户。" +weight: 05 +--- + + + +include::../../../../_custom/multi-clusterProjectManagement/configmaps/config-desc.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/01-view-project-basic-information.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/01-view-project-basic-information.adoc new file mode 100644 index 000000000..4dd3ce275 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/01-view-project-basic-information.adoc @@ -0,0 +1,45 @@ +--- +title: "查看项目基本信息" +keywords: "Kubernetes, {ks_product}, 联邦项目, 项目设置, 基本信息, 查看项目基本信息" +description: "介绍如何查看项目基本信息。" +weight: 01 +--- + +:ks_permission: **联邦项目查看** +:ks_navigation: **项目设置 > 基本信息** + + +本节介绍如何查看项目基本信息。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] ++ +-- +**基本信息**页面提供以下信息： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|项目信息 +|当前项目的信息，包括项目名称、所属企业空间、创建者和创建时间。 + +include::../../../../../_custom/clusterManagement/projects/projects-para-defaultContainerQuotas.adoc[] + +// include::../../../../../_custom/clusterManagement/projects/projects-para-projectQuotas.adoc[] +|=== +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/02-edit-project-information.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/02-edit-project-information.adoc new file mode 100644 index 000000000..bcc5538a0 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/02-edit-project-information.adoc @@ -0,0 +1,46 @@ +--- +title: "编辑项目信息" +keywords: "Kubernetes, {ks_product}, 联邦项目, 项目设置, 基本信息, 编辑项目信息" +description: "介绍如何编辑项目信息。" +weight: 02 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **项目设置 > 基本信息** + + +本节介绍如何编辑项目基本信息。 + +您可以编辑项目的别名和描述。{ks_product_right}不支持编辑已创建项目的名称。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**基本信息**页面，点击**管理**，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置项目的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../../_custom/clusterManagement/projects/projects-para-aliasDescription.adoc[] +|=== +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/03-edit-annotation.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/03-edit-annotation.adoc new file mode 100644 index 000000000..2c85f610c --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/03-edit-annotation.adoc @@ -0,0 +1,41 @@ +--- +title: "编辑项目注解" +keywords: "Kubernetes, {ks_product}, 联邦项目, 项目设置, 基本信息,添加项目集群" +description: "介绍如何编辑项目注解。" +weight: 03 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **项目设置 > 基本信息** + + +本节介绍如何编辑项目注解。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**基本信息**页面，点击**管理**，然后在下拉列表中选择**编辑注解**。 + +. 在弹出的对话框中，设置注解的键值对，然后点击**确定**。注解添加完成后将显示在项目基本信息页面。 ++ +-- +* 点击**添加**可以为当前项目添加一个或多个注解。 + +* 点击 image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] 可删除当前待添加的注解。 +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/04-add-cluster.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/04-add-cluster.adoc new file mode 100644 index 000000000..1b83b73ce --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/04-add-cluster.adoc @@ -0,0 +1,41 @@ +--- +title: "添加项目集群" +keywords: "Kubernetes, {ks_product}, 联邦项目, 项目设置, 基本信息,添加项目集群" +description: "介绍如何添加项目集群。" +weight: 04 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **项目设置 > 基本信息** + + +本节介绍如何添加项目到其他集群。添加后将自动在对应集群创建当前项目。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**基本信息**页面，点击**管理**，然后在下拉列表中选择**添加集群**。 + +. 在弹出的对话框中，从下拉列表中选择想要添加当前项目的集群，然后点击**确定**。集群添加后将自动在对应集群创建当前项目。 ++ +-- +* 点击**添加集群**可以将当前项目添加到一个或多个集群。 + +* 点击 image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] 可删除当前待添加的集群。 +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/05-edit-default-container-quotas.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/05-edit-default-container-quotas.adoc new file mode 100644 index 000000000..29c9921fc --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/05-edit-default-container-quotas.adoc @@ -0,0 +1,37 @@ +--- +title: "编辑默认容器配额" +keywords: "Kubernetes, {ks_product}, 联邦项目, 项目设置, 基本信息, 编辑默认容器配额" +description: "介绍如何编辑默认容器配额。" +weight: 05 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **项目设置 > 基本信息** + + +include::../../../../../_custom/clusterManagement/projects/projects-desc-editDefaultContainerQuotas.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**基本信息**页面，点击**管理**，然后在下拉列表中选择**编辑默认容器配额**。 + ++ + +include::../../../../../_custom/clusterManagement/projects/projects-oper-editDefaultContainerQuotas.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/06-delete-a-project.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/06-delete-a-project.adoc new file mode 100644 index 000000000..1bdc8e39c --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/06-delete-a-project.adoc @@ -0,0 +1,38 @@ +--- +title: "删除项目" +keywords: "Kubernetes, {ks_product}, 联邦项目, 项目设置, 基本信息, 删除项目" +description: "介绍如何删除项目。" +weight: 06 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **项目设置 > 基本信息** + + +include::../../../../../_custom/clusterManagement/projects/projects-desc-deleteProjects.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**基本信息**页面，点击**管理**，然后在下拉列表中选择**删除项目**。 + ++ + +include::../../../../../_custom/clusterManagement/projects/projects-oper-deleteASingleProject.adoc[] + diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/_index.adoc new file mode 100644 index 000000000..75a0b145c --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/01-basic-information/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "基本信息" +keywords: "Kubernetes, {ks_product}, 联邦项目, 项目设置, 基本信息" +description: "介绍如何查看和管理联邦项目的基本信息。" +weight: 01 +--- + + + +本节介绍如何查看和管理联邦项目的基本信息。 diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/02-project-quotas/01-view-project-quotas.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/02-project-quotas/01-view-project-quotas.adoc new file mode 100644 index 000000000..622c318ac --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/02-project-quotas/01-view-project-quotas.adoc @@ -0,0 +1,35 @@ +--- +title: "查看项目配额" +keywords: "Kubernetes, {ks_product}, 联邦项目, 项目设置, 项目配额, 查看项目配额" +description: "介绍如何查看项目配额。" +weight: 01 +--- + +:ks_permission: **联邦项目查看** +:ks_navigation: **项目设置 > 项目配额** + + +本节介绍如何查看项目配额。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] ++ +-- +**项目配额**页面提供以下资源信息： + +include::../../../../../_custom/multi-clusterProjectManagement/project-config/project-quota-para_v4.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/02-project-quotas/02-edit-project-quotas.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/02-project-quotas/02-edit-project-quotas.adoc new file mode 100644 index 000000000..658c0ecf5 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/02-project-quotas/02-edit-project-quotas.adoc @@ -0,0 +1,35 @@ +--- +title: "编辑项目配额" +keywords: "Kubernetes, {ks_product}, 联邦项目, 项目设置, 项目配额, 编辑项目配额" +description: "介绍如何编辑项目配额。" +weight: 02 +--- + +:ks_permission: **联邦项目管理** +:ks_navigation: **项目设置 > 项目配额** + + +本节介绍如何编辑项目配额。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用**联邦集群应用管理**扩展组件。 + +* {empty} +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-prer-requiredPermission_v4.adoc[] + + +== 操作步骤 + +include::../../../../../_custom/multi-clusterProjectManagement/projectManagement-oper-openProjectPage_v4.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + +. 在**项目配额**页面，点击右上角的**编辑配额**，进入配额编辑页面。 + ++ + +include::../../../../../_custom/clusterManagement/projects/projects-oper-editProjectQuotas-for-kubefed.adoc[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/02-project-quotas/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/02-project-quotas/_index.adoc new file mode 100644 index 000000000..5eccf36fd --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/02-project-quotas/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "项目配额" +keywords: "Kubernetes, {ks_product}, 联邦项目, 项目设置, 项目配额" +description: "介绍如何查看和管理联邦项目的配额。" +weight: 02 +--- + + + +本节介绍如何查看和管理联邦项目的配额。 diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/_index.adoc new file mode 100644 index 000000000..205bf290b --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/06-project-settings/_index.adoc @@ -0,0 +1,7 @@ +--- +title: "项目设置" +keywords: "Kubernetes, {ks_product}, 联邦项目, 项目设置" +description: "介绍如何管理项目设置。" +weight: 06 +--- + diff --git a/content/zh/docs/v4.1/11-use-extensions/04-kubefed/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/_index.adoc new file mode 100644 index 000000000..883496c99 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/04-kubefed/_index.adoc @@ -0,0 +1,15 @@ +--- +title: "联邦集群应用管理" +keywords: "Kubernetes, {ks_product}, 联邦项目" +description: "介绍如何管理联邦项目，以及如何在联邦项目中管理应用负载、卷、配置资源和项目设置。" +weight: 04 +--- + + +本节介绍如何使用“联邦集群应用管理”扩展组件来管理联邦项目，以及如何在联邦项目中管理应用负载、持久卷声明、配置资源和项目设置。 + +联邦项目是基于多个集群创建的项目。联邦项目中的资源可运行在不同集群上。 + +联邦集群应用管理是一个旨在简化跨多个联邦 Kubernetes 集群管理应用程序的扩展组件，用户可以轻松地在多个联邦集群中部署、更新和管理应用程序，同时提供灵活的配置选项以满足不同需求。 + +安装“联邦集群应用管理”扩展组件后，企业空间左侧导航栏的**项目**菜单下将显⽰**联邦项目**选项。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-platform-services/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-platform-services/_index.adoc new file mode 100644 index 000000000..163299a2f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/01-platform-services/_index.adoc @@ -0,0 +1,124 @@ +--- +title: "WhizardTelemetry 平台服务" +weight: 01 +--- + +WhizardTelemetry 平台服务是 WhizardTelemetry 可观测平台中各扩展组件的公共服务。它是各个可观测性扩展组件通用的 APIServer，为所有可观测性扩展组件提供公共的后端平台服务。 + +**配置说明：** + +* 修改 WhizardTelemetry 平台服务的扩展组件配置，可配合 WhizardTelemetry 监控扩展组件，启用 Whizard 可观测中心。有关更多信息，请参阅 link:../07-whizard/01-enable-whizard/[Whizard 可观测中心]。 + +* 为 WhizardTelemetry 日志管理、WhizardTelemetry 审计管理、WhizardTelemetry 事件管理、以及通知历史配置 OpenSearch 日志接收器时，如果需要使用多个 OpenSearch 数据库，可以按如下配置。 +// 有关组件配置的更多信息，请参阅扩展中心“WhizardTelemetry 平台服务”扩展组件的详情页说明。 + +[,yaml] +---- +whizard-telemetry: + config: + monitoring: + enabled: true + kind: 0 + endpoint: http://prometheus-k8s.kubesphere-monitoring-system.svc:9090 + observability: + enabled: false + endpoint: "http://query-frontend-whizard-operated.kubesphere-monitoring-system.svc:10902" + notification: + endpoint: http://notification-manager-svc.kubesphere-monitoring-system.svc:19093 + history: + enable: true + server: + elasticsearch: + endpoints: + - https://: + version: opensearchv2 + indexPrefix: notification-history + basicAuth: true + username: admin + password: admin + auditing: + enable: true + servers: + - elasticsearch: + cluster: + - cluster1 + - cluster2 + endpoints: + - https://: + version: opensearchv2 + indexPrefix: auditing + basicAuth: true + username: admin + password: admin + - elasticsearch: + cluster: + - cluster3 + - cluster4 + endpoints: + - https://: + version: opensearchv2 + indexPrefix: auditing + basicAuth: true + username: admin + password: admin + events: + enable: true + servers: + - elasticsearch: + cluster: + - cluster1 + - cluster2 + endpoints: + - https://opensearch-cluster-data.kubesphere-logging-system:9200 + version: opensearchv2 + indexPrefix: events + basicAuth: true + username: admin + password: admin + - elasticsearch: + cluster: + - cluster3 + - cluster4 + endpoints: + - https://opensearch-cluster-data.kubesphere-logging-system:9200 + version: opensearchv2 + indexPrefix: events + basicAuth: true + username: admin + password: admin + logging: + enable: true + servers: + - elasticsearch: + cluster: + - cluster1 + - cluster2 + endpoints: + - https://: + version: opensearchv2 + indexPrefix: logs + basicAuth: true + username: admin + password: admin + - elasticsearch: + cluster: + - cluster3 + - cluster4 + endpoints: + - https://: + version: opensearchv2 + indexPrefix: logs + basicAuth: true + username: admin + password: admin +---- + + +// //note +// [.admon.note,cols="a"] +// |=== +// |说明 + +// | +// 修改 WhizardTelemetry 平台服务的扩展组件配置，可配合 WhizardTelemetry 监控扩展组件，启用 Whizard 可观测中心。有关更多信息，请参阅 link:../07-whizard/01-enable-whizard/[Whizard 可观测中心]。 +// |=== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/01-use-log-query-tools.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/01-use-log-query-tools.adoc new file mode 100644 index 000000000..8b073985f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/01-use-log-query-tools.adoc @@ -0,0 +1,36 @@ +--- +title: "使用容器日志查询工具" +keywords: "Kubernetes, {ks_product}, 集群管理, 工具箱, 查询容器日志" +description: "介绍如何使用容器日志查询工具。" +weight: 01 +--- + +本节介绍如何查询容器日志。 + +容器日志：从容器标准输出获取的日志。容器日志的内容由容器中运行的应用程序决定。 + + +== 前提条件 + +* 您需要获得平台、集群、企业空间或项目的资源查看权限，以查看特定范围的日志。 +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志管理**扩展组件。 + +== 操作步骤 + +. 以具有相关资源查看权限的用户登录{ks_product_left} Web 控制台。 + +. 将光标悬停在页面右下角的image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18]图标，然后在菜单中选择**容器日志查询**。 + +. 在弹出的对话框，设置搜索条件查询日志。 ++ +-- +* 如果有多个集群，点击**集群**下拉列表可查询特定集群中的日志。 + +* 点击搜索框，设置搜索条件，然后按 **Enter** 可查看符合特定条件的日志。您可以同时设置多个搜索条件。 + +* 在查询结果页面可查看日志的时间分布图，点击柱状图，切换到该时间段的日志列表。点击image:/images/ks-qkcp/zh/icons/start-dark.svg[start-dark,18,18]/image:/images/ks-qkcp/zh/icons/stop-dark-white.svg[stop-dark-white,18,18]可开启/停止实时数据刷新，点击**日志导出**下拉列表可选择正序或倒序导出容器日志，点击**刷新频率**的时间可选择数据的刷新频率。 + +* 在查询结果列表右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]可定制列表中显示的信息。 + +* 点击查询结果中的日志条目，查看日志的详细信息。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/01-enable-logsidecar.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/01-enable-logsidecar.adoc new file mode 100644 index 000000000..9707a097a --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/01-enable-logsidecar.adoc @@ -0,0 +1,35 @@ +--- +title: "启用日志收集" +weight: 01 +--- + +本节介绍如何修改“WhizardTelemetry 日志管理”扩展组件的配置，以启用日志收集功能。 +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +启用后，项目左侧导航栏的**项目设置**菜单下将显⽰**日志收集**选项。 +|=== + + +== 前提条件 + +* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志管理**扩展组件。 + +== 操作步骤 + +. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 +. 点击**扩展中心**。 +. 点击已安装的 **WhizardTelemetry 日志管理**扩展组件，进入组件详情页，点击**管理**。 +. 点击组件图标下的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**扩展组件配置**。 +. 在扩展组件配置文件中，将 **logsidecar-injector.enabled** 参数设置为 **true**，然后保存文件。 ++ +[,yaml] +---- +logsidecar-injector: + enabled: true +---- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/02-enable-project-log-collection.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/02-enable-project-log-collection.adoc new file mode 100644 index 000000000..d4ae45f54 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/02-enable-project-log-collection.adoc @@ -0,0 +1,58 @@ +--- +title: "在项目中启用日志收集" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 日志收集, 启用日志收集" +description: "介绍如何启用日志收集。" +weight: 02 +--- + + +:ks_permission: **项目设置管理** +:ks_navigation: **项目设置 > 日志收集** + + +本节介绍如何在项目中启用日志收集。 +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +启用后，在项目中创建工作负载和任务时，**存储设置**页签的**收集卷上日志**功能将可用。 +|=== + + +== 前提条件 + + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志管理**扩展组件，并已link:../01-enable-logsidecar/[启用日志收集]。 + +== 操作步骤 + +include::../../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**收集卷上日志**区域，点击切换开关将功能状态设置为**已启用**。 + +// Note +include::../../../../../../_ks_components/admonitions/note.adoc[] + +ifeval::["{file_output_type}" == "html"] +启用日志收集后，您需要重启容器组才能对现有的容器组生效。有关更多信息，请参阅link:../../../../../09-project-management/03-application-workloads/03-workloads/05-re-create-a-workload/[重新创建工作负载]、link:../../../../../09-project-management/03-application-workloads/04-jobs/05-rerun-a-job/[重新运行任务]或link:../../../../../09-project-management/03-application-workloads/06-pods/05-delete-pods/[删除容器组]。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +启用日志收集后，您需要重启容器组才能对现有的容器组生效。有关更多信息，请参阅《{ks_product_right}项目管理指南》的“应用负载”章节，重新创建工作负载、重新运行任务或删除容器组。 +endif::[] + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/03-enable-collect-volume-logs.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/03-enable-collect-volume-logs.adoc new file mode 100644 index 000000000..6dd1a1e05 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/03-enable-collect-volume-logs.adoc @@ -0,0 +1,51 @@ +--- +title: "启用收集卷上日志" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 日志收集, 收集卷上的日志" +description: "介绍如何启用收集卷上日志。" +weight: 03 +--- + + +:ks_permission: **应用负载管理** + +ifeval::["{file_output_type}" == "html"] +本节介绍如何在创建工作负载、服务或任务时启用收集卷上的日志。有关更多信息，请参阅link:../../../../../09-project-management/03-application-workloads/03-workloads/01-create-a-workload/[创建工作负载]或link:../../../../../09-project-management/03-application-workloads/04-jobs/01-create-a-job/[创建任务]。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +本节介绍如何在创建工作负载、服务或任务时启用收集卷上的日志。有关更多信息，请参阅《{ks_product_right}项目管理指南》的“应用负载”章节，创建工作负载或创建任务。 +endif::[] + + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志管理**扩展组件，并已link:../02-enable-project-log-collection/[在项目中启用日志收集]。 + +== 操作步骤 + +include::../../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +. 在左侧导航栏选择**应用负载 > 工作负载**或**应用负载 > 任务**。 + +. 在工作负载页面，点击**部署**、**有状态副本集**或**守护进程集**打开工作负载列表，或在任务页面，点击**任务**或**定时任务**打开任务列表。 + +. 在页面点击**创建**。 + +. 在**存储设置**页签，点击**收集卷上日志**开关启用该功能。 ++ + + +. 点击**挂载卷**，为容器挂载**读写**模式的持久卷或临时卷，并设置**容器日志路径**。 + +. 设置容器中的应用程序，将日志导出到卷挂载目录下的容器日志路径。 ++ +日志收集完成后将打印到容器的标准输出，您可以在{ks_product_both}提供的工具箱对容器日志进行查询。有关更多信息，请参阅link:../../01-use-log-query-tools/[使用容器日志查询工具]。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/_index.adoc new file mode 100644 index 000000000..549ff47f3 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/02-log-collection/_index.adoc @@ -0,0 +1,23 @@ +--- +title: "日志收集" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 日志收集" +description: "介绍如何启用和禁用日志收集功能。" +weight: 02 +--- + + +本节介绍如何使用日志收集功能。 + +日志收集功能启用后，{ks_product_right}将读取容器保存在卷上的日志文件，然后将日志文件的内容打印到容器的标准输出。使用日志收集功能需要进行以下步骤： + +. 安装并启用“WhizardTelemetry 日志管理”扩展组件。 + +. 在“WhizardTelemetry 日志管理”扩展组件的配置中启用 `logsidecar-injector`。有关更多信息，请参阅link:01-enable-logsidecar/[启用日志收集]。 + +. 在项目中启用日志收集。 + +. 设置容器，将运行日志文件输出到容器中的路径下。有关更多信息，请联系容器镜像的开发者。 + +. 创建工作负载、服务或任务时启用**收集卷上的日志**，为容器挂载卷，并设置日志文件的路径。 + +. 使用{ks_product_both}提供的工具箱对容器日志进行查询。有关更多信息，请参阅link:../01-use-log-query-tools/[使用容器日志查询工具]。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/01-config-opensearch.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/01-config-opensearch.adoc new file mode 100644 index 000000000..5b7eab5a2 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/01-config-opensearch.adoc @@ -0,0 +1,150 @@ +--- +title: "配置 OpenSearch 日志接收器" +weight: 01 +--- + +本节介绍如何配置 OpenSearch 日志接收器，以便将日志数据发送到指定的 OpenSearch 数据库。 + +[.admon.note,cols="a"] +|=== +|说明 + +| +在扩展组件安装时或安装完成后均可以修改扩展组件配置，以配置日志接收器。下文仅介绍扩展组件已安装的情况下，如何配置 OpenSearch 日志接收器。 +|=== + + +== 前提条件 + +* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。 +* 已获取 OpenSearch 的服务地址和服务端口。 + +== 配置步骤 + +. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 +. 点击**扩展中心**。 +. 点击扩展组件的名称，进入组件详情页。 +. 点击组件图标下的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**扩展组件配置**。 + +. 编辑 **WhizardTelemetry 日志管理**的扩展组件配置，修改 `vector-logging` 下 opensearch 的相关配置。 ++ +[,yaml] +---- +vector-logging: + sinks: + opensearch: + # Create opensearch sink or not + enabled: true + # Configurations for the opensearch sink, more info for https://vector.dev/docs/reference/configuration/sinks/elasticsearch/ + # Usually users needn't change the following OpenSearch sink config, and the default sinks in secret "kubesphere-logging-system/vector-sinks" created by the WhizardTelemetry Data Pipeline extension will be used. + metadata: + api_version: v8 + auth: + strategy: basic + user: admin + password: admin + batch: + timeout_secs: 5 + buffer: + max_events: 10000 + endpoints: + - https://: + tls: + verify_certificate: false +---- + +. 编辑 **WhizardTelemetry 审计管理**的扩展组件配置，修改 `kube-auditing` 下 opensearch 的相关配置。 ++ +-- +[.admon.note,cols="a"] +|=== +|说明 + +| +另外，还需要启用 KubeSphere 和 Kubernetes 审计。有关更多信息，请参阅扩展中心“WhizardTelemetry 审计管理”扩展组件的详情页说明。 +|=== + +[,yaml] +---- +kube-auditing: + sinks: + opensearch: + # Create opensearch sink or not + enabled: true + # Configurations for the opensearch sink, more info for https://vector.dev/docs/reference/configuration/sinks/elasticsearch/ + # Usually users needn't change the following OpenSearch sink config, and the default sinks in secret "kubesphere-logging-system/vector-sinks" created by the WhizardTelemetry Data Pipeline extension will be used. + # metadata: + # api_version: v8 + # auth: + # strategy: basic + # user: admin + # password: admin + # batch: + # timeout_secs: 5 + # buffer: + # max_events: 10000 + # endpoints: + # - https://: + # tls: + # verify_certificate: false +---- + +-- + +. 编辑 **WhizardTelemetry 事件管理**的扩展组件配置，修改 `kube-events-exporter` 下 opensearch 的相关配置。 ++ +[,yaml] +---- +kube-events-exporter: + sinks: + opensearch: + # Create opensearch sink or not + enabled: true + # Configurations for the opensearch sink, more info for https://vector.dev/docs/reference/configuration/sinks/elasticsearch/ + # Usually users needn't change the following OpenSearch sink config, and the default sinks in secret "kubesphere-logging-system/vector-sinks" created by the WhizardTelemetry Data Pipeline extension will be used. + # metadata: + # api_version: v8 + # auth: + # strategy: basic + # user: admin + # password: admin + # batch: + # timeout_secs: 5 + # buffer: + # max_events: 10000 + # endpoints: + # - https://: + # tls: + # verify_certificate: false +---- + +. 编辑 **WhizardTelemetry 通知管理**的扩展组件配置，修改 `notification-history` 下 opensearch 的相关配置。 ++ +[,yaml] +---- +notification-history: + sinks: + opensearch: + # Create opensearch sink or not + enabled: true + # Configurations for the opensearch sink, more info for https://vector.dev/docs/reference/configuration/sinks/elasticsearch/ + # Usually users needn't change the following OpenSearch sink config, and the default sinks in secret "kubesphere-logging-system/vector-sinks" created by the WhizardTelemetry Data Pipeline extension will be used. + # metadata: + # api_version: v8 + # auth: + # strategy: basic + # user: admin + # password: admin + # batch: + # timeout_secs: 5 + # buffer: + # max_events: 10000 + # endpoints: + # - https://: + # tls: + # verify_certificate: false +---- + +. 编辑 **WhizardTelemetry 平台服务**的扩展组件配置，确保其中各组件配置下的 `endpoints` 与以上各个扩展组件的 `endpoints` 配置一致，以便{ks_product_both}平台能够正确查询日志数据。有关更多信息，请参阅扩展中心“WhizardTelemetry 平台服务”扩展组件的详情页说明。 ++ +至此，OpenSearch 日志接收器配置完成。在**集群设置 > 日志接收器**页面，可以看到 OpenSearch 已被配置为容器日志、资源事件、审计日志和通知历史的日志接收器。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/01-add-a-log-receiver.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/01-add-a-log-receiver.adoc new file mode 100644 index 000000000..1480231bd --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/01-add-a-log-receiver.adoc @@ -0,0 +1,54 @@ +--- +title: "添加日志接收器" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 日志接收器, 添加日志接收器" +description: "介绍如何添加日志接收器。" +weight: 01 +--- + +:ks_permission: **集群设置管理** +:ks_navigation: **集群设置 > 日志接收器** + + +本节介绍如何添加日志接收器。 + +{ks_product_right}支持使用 Elasticsearch、OpenSearch 和 Kafka 作为日志接收器。 + +* 每种类型的日志接收器只能添加一个。 + +* {ks_product_right}默认使用 OpenSearch 并提供日志分析工具，您可以在{ks_product_left} Web 控制台的工具箱中使用日志分析工具查询 OpenSearch 收集的日志。 + +* {ks_product_right}默认未安装 Kafka，并且目前未提供针对 Kafka 的日志分析工具。{ks_product_right}仅提供与 Kafka 对接的功能。如需使用 Kafka 作为日志接收器，您需要参阅 link:https://kafka.apache.org/documentation/[Kafka 官方文档]安装 Kafka。 + + +== 前提条件 + +:relfileprefix: ../../../../../../ + +* {empty} +include::../../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志管理**、**WhizardTelemetry 事件管理**、**WhizardTelemetry 审计管理**、或 **WhizardTelemetry 通知管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../../../_ks_components/oper-navigate.adoc[] + ++ +. 在**日志接收器**页面，点击**容器日志**、**资源事件**、**审计日志**或**通知历史**打开日志接收器列表。 + +. 在页面右侧点击**添加日志接收器**。 + +. 在**添加日志接收器**对话框，选择 **Elasticsearch**、 **OpenSearch** 或 **Kafka**。 + +. 设置日志接收器的参数，然后点击**确定**。 ++ +-- +include::../../../../../../_custom/clusterManagement/logReceivers/logReceivers-para-addLogReceiver.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/02-view-a-log-receiver-list.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/02-view-a-log-receiver-list.adoc new file mode 100644 index 000000000..8e93a73c4 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/02-view-a-log-receiver-list.adoc @@ -0,0 +1,67 @@ +--- +title: "查看日志接收器列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 日志接收器, 查看日志接收器列表" +description: "介绍如何查看日志接收器列表。" +weight: 02 +--- + +:ks_permission: **集群设置查看** +:ks_navigation: **集群设置 > 日志接收器** + + +本节介绍如何查看日志接收器列表。 + + +== 前提条件 + +:relfileprefix: ../../../../../../ + +* {empty} +include::../../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* 已添加一个日志接收器。 + + +== 操作步骤 + +include::../../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**日志接收器**页面，点击**容器日志**、**资源事件**、**审计日志**或**通知历史**打开日志接收器列表。 + ++ +==== +* 日志接收器列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|日志接收器的名称。{ks_product_right}支持 Elasticsearch、 OpenSearch、Kafka 日志接收器。 + +|地址 +| +include::../../../../../../_custom/clusterManagement/logReceivers/logReceivers-para-address.adoc[] + +|状态 +|日志接收器是否已启用，取值为**已启用**或**已禁用**。 + +|类型 +|日志接收器的类型，可以为**日志**、**事件**、**审计日志**或**通知历史**。 + +|创建时间 +|日志接收器的创建时间。 +|=== +-- + +include::../../../../../../../_ks_components/oper-refreshListData.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/03-view-log-receiver-details.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/03-view-log-receiver-details.adoc new file mode 100644 index 000000000..89706f8bf --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/03-view-log-receiver-details.adoc @@ -0,0 +1,47 @@ +--- +title: "查看日志接收器详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 日志接收器, 查看日志接收器详情" +description: "介绍如何查看日志接收器详情。" +weight: 03 +--- + +:ks_permission: **集群设置查看** +:ks_navigation: **集群设置 > 日志接收器** + + +本节介绍如何查看日志接收器详情。 + + +== 前提条件 + +:relfileprefix: ../../../../../../ + +* {empty} +include::../../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* 已添加一个日志接收器。 + + +== 操作步骤 + +include::../../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**日志接收器**页面，点击**容器日志**、**资源事件**、**审计日志**或**通知历史**，然后在列表中点击一个日志接收器的名称打开其详情页面。 + ++ + +. 在日志接收器详情页面左侧的**属性**区域查看日志接收器是否已启用。 + +. 在日志接收器详情页面右侧的**资源状态**页签查看日志接收器的设置。 ++ +-- +include::../../../../../../_custom/clusterManagement/logReceivers/logReceivers-para-addLogReceiver.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/04-edit-log-receiver-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/04-edit-log-receiver-settings.adoc new file mode 100644 index 000000000..ca5c3c2ee --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/04-edit-log-receiver-settings.adoc @@ -0,0 +1,56 @@ +--- +title: "编辑日志接收器设置" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 日志接收器, 编辑日志接收器设置" +description: "介绍如何编辑日志接收器设置。" +weight: 04 +--- + +:ks_permission: **集群设置管理** +:ks_navigation: **集群设置 > 日志接收器** + + +本节介绍如何编辑日志接收器设置。 + + +== 前提条件 + +:relfileprefix: ../../../../../../ + +* {empty} +include::../../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* 已添加一个日志接收器。 + + +== 操作步骤 + +include::../../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**日志接收器**页面，点击**容器日志**、**资源事件**、**审计日志**或**通知历史**，然后在列表中点击一个日志接收器的名称打开其详情页面。 + ++ + +. 在日志接收器详情页面左上角点击**编辑**。 + +. 在弹出的对话框修改日志接收器的设置，然后点击**确定**。 ++ +-- +include::../../../../../../_custom/clusterManagement/logReceivers/logReceivers-para-addLogReceiver.adoc[] + +[.admon.attention,cols="a"] +|=== +|注意 + +| +修改完成后，需确保 **WhizardTelemetry 平台服务**的扩展组件配置中，各组件配置下的 `endpoints` 与修改的服务地址一致，以便{ks_product_both}平台能够正确查询日志数据。有关更多信息，请参阅扩展中心“WhizardTelemetry 平台服务”扩展组件的详情页说明。 + +|=== +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/05-enable-and-disable-log-receiver.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/05-enable-and-disable-log-receiver.adoc new file mode 100644 index 000000000..3f9d30ee6 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/05-enable-and-disable-log-receiver.adoc @@ -0,0 +1,43 @@ +--- +title: "启用和禁用日志接收器" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 日志接收器, 启用, 禁用" +description: "介绍如何启用和禁用日志接收器。" +weight: 05 +--- + +:ks_permission: **集群设置管理** +:ks_navigation: **集群设置 > 日志接收器** + + +本节介绍如何启用和禁用日志接收器。 + + +== 前提条件 + +:relfileprefix: ../../../../../../ + +* {empty} +include::../../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* 已添加一个日志接收器。 + + +== 操作步骤 + +include::../../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**日志接收器**页面，点击**容器日志**、**资源事件**、**审计日志**或**通知历史**，然后在列表中点击一个日志接收器的名称打开其详情页面。 + ++ + +. 在日志接收器详情页面左上角点击**更多操作 > 更改状态**。 + +. 在弹出的对话框中选择**启用**或**禁用**，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/06-delete-a-log-receiver.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/06-delete-a-log-receiver.adoc new file mode 100644 index 000000000..ef732ef88 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/06-delete-a-log-receiver.adoc @@ -0,0 +1,43 @@ +--- +title: "删除日志接收器" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 日志接收器, 启用, 禁用" +description: "介绍如何删除日志接收器。" +weight: 06 +--- + +:ks_permission: **集群设置管理** +:ks_navigation: **集群设置 > 日志接收器** + + +本节介绍如何删除日志接收器。 + + +== 前提条件 + +:relfileprefix: ../../../../../../ + +* {empty} +include::../../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* 已添加一个日志接收器。 + + +== 操作步骤 + +include::../../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**日志接收器**页面，点击**容器日志**、**资源事件**、**审计日志**或**通知历史**，然后在列表中点击一个日志接收器的名称打开其详情页面。 + ++ + +. 在日志接收器详情页面左上角点击**更多操作 > 删除**。 + +. 在弹出的对话框中输入日志接收器的名称，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/_index.adoc new file mode 100644 index 000000000..22444113c --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/03-manage-log-receivers/_index.adoc @@ -0,0 +1,19 @@ +--- +title: "管理日志接收器" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 日志接收器" +description: "介绍如何添加和管理日志接收器。" +weight: 03 +--- + + +本节介绍如何管理日志接收器。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +安装并启用 WhizardTelemetry 日志管理、WhizardTelemetry 事件管理、WhizardTelemetry 审计管理、WhizardTelemetry 通知管理这四个扩展组件中的任意一个，集群左侧导航栏的**集群设置**菜单下都会显示**日志接收器**选项，**日志接收器**页面则会显示对应的页签。 + +|=== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/_index.adoc new file mode 100644 index 000000000..5fb2041f2 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/03-log-receivers/_index.adoc @@ -0,0 +1,16 @@ +--- +title: "日志接收器" +weight: 03 +--- + +日志接收器用于收集系统的各类日志，配置或添加日志接收器，以便将 WhizardTelemetry 日志管理、WhizardTelemetry 审计管理、WhizardTelemetry 事件管理、以及通知历史的日志数据发送到外部日志接收器中。 + +{ks_product_right}支持收集以下类型的日志： + +* 容器日志：从容器标准输出获取的日志。容器日志的内容由容器中运行的应用程序决定。 + +* 资源事件：工作负载、任务、容器组、服务、应用路由等各类资源的事件。 + +* 审计日志：{ks_product} API 服务器接收请求的记录。 + +* 通知历史：{ks_product_right}平台向用户发送的告警通知的记录。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/_index.adoc new file mode 100644 index 000000000..9280495f0 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/02-logging/_index.adoc @@ -0,0 +1,27 @@ +--- +title: "WhizardTelemetry 日志管理" +keywords: "Kubernetes, {ks_product}, 日志" +description: "介绍如何使用“WhizardTelemetry 日志管理”扩展组件。" +weight: 02 +--- + + +本节介绍如何使用“WhizardTelemetry 日志管理”扩展组件。 + +该组件提供多租户视角的云原生应用实时及历史日志收集、查询、导出、存储等功能，可对接如 ElasticSearch、OpenSearch、Kafka 等日志接收器。 + +安装“WhizardTelemetry 日志管理”扩展组件后， + +* 页面右下角的⼯具箱中将显⽰**容器⽇志查询**选项，支持用户查询自身权限范围内的容器日志。 +* 集群左侧导航栏的**集群设置**菜单下将显示**日志接收器**选项，**日志接收器**页面将显示**容器日志**页签，支持添加多种类型的日志接收器。 + +//attention +[.admon.attention,cols="a"] +|=== +| 注意 + +| +- WhizardTelemetry 日志管理依赖 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线，因此在安装 WhizardTelemetry 事件管理之前必须先安装 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线两个扩展组件，否则日志相关功能无法正常使用！ + +- 若未收集到日志，请确保 Docker 的根目录在 /var/lib 下，否则需要修改 WhizardTelemetry 数据流水线中 agent 的挂载配置。有关更多信息，请参阅扩展中心 “WhizardTelemetry 数据流水线”扩展组件的详情页说明。 +|=== \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/03-events/01-use-event-query-tools.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/03-events/01-use-event-query-tools.adoc new file mode 100644 index 000000000..dc6e2582d --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/03-events/01-use-event-query-tools.adoc @@ -0,0 +1,36 @@ +--- +title: "使用资源事件查询工具" +keywords: "Kubernetes, {ks_product}, 集群管理, 工具箱, 查询资源事件" +description: "介绍如何使用资源事件查询工具。" +weight: 02 +--- + +本节介绍如何查询资源事件。 + +资源事件：工作负载、任务、容器组、服务、应用路由等各类资源的事件。 + + +== 前提条件 + +* 您需要获得平台、集群、企业空间或项目的资源查看权限，以查看特定范围的事件。 +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 资源事件**扩展组件。 + +== 操作步骤 + +. 以具有相关资源查看权限的用户登录{ks_product_left} Web 控制台。 + +. 将光标悬停在页面右下角的image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18]图标，然后在菜单中选择**资源事件查询**。 + +. 在弹出的对话框，设置搜索条件查询事件。 ++ +-- +* 如果有多个集群，点击**集群**下拉列表可查询特定集群中的事件。 + +* 点击搜索框，设置搜索条件，然后按 **Enter** 可查看符合特定条件的事件。您可以同时设置多个搜索条件。 + +* 在查询结果页面可查看事件的时间分布图，点击柱状图，切换到该时间段的事件列表。点击image:/images/ks-qkcp/zh/icons/start-dark.svg[start-dark,18,18]/image:/images/ks-qkcp/zh/icons/stop-dark-white.svg[stop-dark-white,18,18]可开启/停止实时数据刷新，点击**刷新频率**的时间可选择数据的刷新频率。 + +* 在查询结果列表右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]可定制列表中显示的信息。 + +* 点击查询结果中的事件条目，查看事件的详细信息。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/03-events/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/03-events/_index.adoc new file mode 100644 index 000000000..7e188be92 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/03-events/_index.adoc @@ -0,0 +1,26 @@ +--- +title: "WhizardTelemetry 事件管理" +keywords: "Kubernetes, {ks_product}, 事件" +description: "介绍如何使用“WhizardTelemetry 事件管理”扩展组件。" +weight: 03 +--- + + +本节介绍如何使用“WhizardTelemetry 事件管理”扩展组件。 + +该组件可长期保存工作负载、任务、容器组、服务、应用路由等资源的事件，并提供多租户视角的事件检索和查看功能。 + +安装“WhizardTelemetry 事件管理”扩展组件后， + +* 页面右下角的⼯具箱中将显⽰**资源事件查询**选项，支持用户查询自身权限范围内的资源事件。 +* 集群左侧导航栏的**集群设置**菜单下将显示**日志接收器**选项，**日志接收器**页面将显示**资源事件**页签，支持添加多种类型的日志接收器。有关更多信息，请参阅link:../02-logging/03-log-receivers/[日志接收器]。 + +//attention +[.admon.attention,cols="a"] +|=== +| 注意 + +| +WhizardTelemetry 事件管理依赖 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线，因此在安装 WhizardTelemetry 事件管理之前必须先安装 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线两个扩展组件，否则事件相关功能无法正常使用！ + +|=== \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/04-auditing/01-use-audit-query-tools.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/04-auditing/01-use-audit-query-tools.adoc new file mode 100644 index 000000000..ae0aac69d --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/04-auditing/01-use-audit-query-tools.adoc @@ -0,0 +1,35 @@ +--- +title: "使用审计日志查询工具" +keywords: "Kubernetes, {ks_product}, 集群管理, 工具箱, 查询审计日志" +description: "介绍如何使用审计日志查询工具。" +weight: 01 +--- + +本节介绍如何查询审计日志。 + +审计日志：KubeSphere 企业版 API 服务器接收请求的记录，即{ks_product_both}平台上用户的操作行为。 + +== 前提条件 + +* 您需要获得平台、集群、企业空间或项目的资源查看权限，以查看特定范围的日志。 +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 审计管理**扩展组件。 + +== 操作步骤 + +. 以具有相关资源查看权限的用户登录{ks_product_left} Web 控制台。 + +. 将光标悬停在页面右下角的image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18]图标，然后在菜单中选择**审计日志查询**。 + +. 在弹出的对话框，设置搜索条件查询日志。 ++ +-- +* 如果有多个集群，点击**集群**下拉列表可查询特定集群中的日志。 + +* 点击搜索框，设置搜索条件，然后按 **Enter** 可查看符合特定条件的日志。您可以同时设置多个搜索条件。 + +* 在查询结果页面可查看日志的时间分布图，点击柱状图，切换到该时间段的日志列表。点击image:/images/ks-qkcp/zh/icons/start-dark.svg[start-dark,18,18]/image:/images/ks-qkcp/zh/icons/stop-dark-white.svg[stop-dark-white,18,18]可开启/停止实时数据刷新，点击**刷新频率**的时间可选择数据的刷新频率。 + +* 在查询结果列表右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]可定制列表中显示的信息。 + +* 点击查询结果中的日志条目，查看日志的详细信息。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/04-auditing/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/04-auditing/_index.adoc new file mode 100644 index 000000000..c4102db37 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/04-auditing/_index.adoc @@ -0,0 +1,27 @@ +--- +title: "WhizardTelemetry 审计管理" +keywords: "Kubernetes, {ks_product}, 审计" +description: "介绍如何使用“WhizardTelemetry 审计管理”扩展组件。" +weight: 04 +--- + + +本节介绍如何使用“WhizardTelemetry 审计管理”扩展组件。 + +该组件实时记录在{ks_product_both}平台上的用户相关操作行为，并提供多租户视角的审计历史的检索及查看功能，可快速回溯相关用户的操作行为。 + +安装“WhizardTelemetry 审计管理”扩展组件后， + +* 页面右下角的⼯具箱中将显⽰**审计日志查询**选项，支持用户查询自身权限范围内的审计日志。 +* 集群左侧导航栏的**集群设置**菜单下将显示**日志接收器**选项，**日志接收器**页面将显示**审计日志**页签，支持添加多种类型的日志接收器。有关更多信息，请参阅link:../02-logging/03-log-receivers/_index/[日志接收器]。 + + +//attention +[.admon.attention,cols="a"] +|=== +| 注意 + +| +WhizardTelemetry 审计管理依赖 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线，因此在安装 WhizardTelemetry 审计管理之前必须先安装 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线两个扩展组件，否则审计功能无法正常使用！ + +|=== \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/01-cluster-monitoring-overview.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/01-cluster-monitoring-overview.adoc new file mode 100644 index 000000000..285cc8b6b --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/01-cluster-monitoring-overview.adoc @@ -0,0 +1,79 @@ +--- +title: "查看集群监控概览" +weight: 01 +--- + +:ks_permission: **监控查看** +:ks_navigation: **概览** + + +本节介绍如何查看集群概览页面的监控信息。 + +ifeval::["{file_output_type}" == "html"] +有关集群概览页面的其他信息，请参阅link:../../../../../07-cluster-management/02-overview/01-view-cluster-overall-information/[查看集群概览信息]。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +有关集群概览页面的其他信息，请参阅《{ks_product_right}集群管理指南》的“概览”章节。 +endif::[] + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 + +== 操作步骤 + +include::../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ +-- +**概览**页面提供以下监控信息： + +[%header,cols="1a,4a"] +|=== +|功能区 |描述 + +|集群配额统计 +|当前集群中容器和项目的 CPU 配额和内存配额，包含预留数量、上限数量和总量。 + +|节点资源用量 +|所有节点的 CPU、内存、磁盘的总量和实时用量，以及集群允许创建的容器组总数和已创建的容器组数量。默认情况下每个节点最多允许创建 110 个容器组。 + +|容器组 +|当前集群的各种类型容器组的数量。 + +容器组状态类型包括： + +include::../../../../../_custom/clusterManagement/pods/pods-para-podStatus.adoc[] + +容器组 QoS（服务质量）类型包括： + +include::../../../../../_custom/clusterManagement/pods/pods-para-qosTypes.adoc[] + +|Kubernetes 状态 +|当前集群的每秒 API 请求次数、API 请求延迟、容器组调度次数和容器组调度失败次数。 + +// |系统组件 +// |当前集群中的系统组件。系统组件是运行在{ks_product_both}平台中用于实现平台功能的工作负载。 + +|资源用量排行 +|当前集群中特定资源用量最高的 5 个节点、容器组和项目。 + +* 在左侧下拉列表中选择节点、容器组或项目，在右侧下拉列表中选择不同的排序依据。 + +* 在列表上方点击image:/images/ks-qkcp/zh/icons/sort-ascending.svg[sort-ascending,18,18]/image:/images/ks-qkcp/zh/icons/sort-descending.svg[sort-descending,18,18] 可按升序/降序排序。 + +* 点击下方的**查看更多**，查看节点、容器组和项目的资源用量详情。 +|=== +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/02-workspace-monitoring-overview.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/02-workspace-monitoring-overview.adoc new file mode 100644 index 000000000..cf360bde9 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/02-workspace-monitoring-overview.adoc @@ -0,0 +1,75 @@ +--- +title: "查看企业空间监控概览" +weight: 02 +--- + +:ks_permission: **监控查看** +:ks_navigation: **概览** + +本节介绍如何查看企业空间概览页面的监控信息。 + + +== 前提条件 + + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 + +== 操作步骤 + +include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] ++ +-- +**概览**页面的**资源用量**页签提供以下信息： + +[%header,cols="1a,4a"] +|=== +|功能区 |描述 + +|物理资源 +|企业空间在指定集群中的 CPU 和内存使用情况。 + +|应用资源 +|企业空间在指定集群中创建的部署、有状态副本集、守护进程集、任务、定时任务、持久卷声明等的数量。 +|=== + +include::../../../../../../_ks_components/oper-selectTimeRange.adoc[] + +include::../../../../../../_ks_components/oper-Autorefresh.adoc[] + +include::../../../../../../_ks_components/oper-refreshData.adoc[] + +* 在右上角点击**集群**下拉列表可查看特定集群中的数据。 +-- + +. 在**概览**页面点击**用量排行**页签查看企业空间中的项目的资源使用情况。 ++ +-- +* 在列表左上角点击**集群**下拉列表可查看特定集群中的数据。 + +* 在列表上方点击下拉列表可选择按照 CPU 用量、内存用量、容器组数量、出站流量或入站流量对项目进行排序。 + +* 在列表上方点击image:/images/ks-qkcp/zh/icons/sort-ascending.svg[sort-ascending,18,18]/image:/images/ks-qkcp/zh/icons/sort-descending.svg[sort-descending,18,18] 可按升序/降序排序。 + +include::../../../../../_custom/clusterManagement/clusterStatus/clusterStatus-oper-exportJsonData.adoc[] +-- + +. 在**概览**页面点击**集群信息**页签查看授权给企业空间的集群的 CPU、内存、磁盘的总量和已使用量，以及集群上可创建容器组的总数和已创建容器组的数量。 ++ +-- +// Note +include::../../../../../../_ks_components/admonitions/note.adoc[] + +默认情况下每个集群节点最多可以创建 110 个容器组。 + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/03-project-monitoring-overview.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/03-project-monitoring-overview.adoc new file mode 100644 index 000000000..562922300 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/03-project-monitoring-overview.adoc @@ -0,0 +1,68 @@ +--- +title: "查看项目监控概览" +weight: 03 +--- + +:ks_permission: **监控查看** +:ks_navigation: **概览** + +本节介绍如何查看项目概览页面的监控信息。 + +ifeval::["{file_output_type}" == "html"] +有关项目概览页面的其他信息，请参阅link:../../../../../09-project-management/02-overview/01-view-project-overall-information/[查看项目概览信息]。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +有关项目概览页面的其他信息，请参阅《{ks_product_right}项目管理指南》的“概览”章节。 +endif::[] + + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 + +== 操作步骤 + + +include::../../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] ++ +-- +**概览**页面提供以下监控信息： + +[%header,cols="1a,4a"] +|=== +|功能区 |描述 + +|资源用量 +|当前项目的CPU、内存、磁盘的总量和实时用量。 + +|容器组 +|当前项目的各种类型容器组的数量。 + +容器组状态类型包括： + +include::../../../../../_custom/clusterManagement/pods/pods-para-podStatus.adoc[] + +容器组 QoS（服务质量）类型包括： + +include::../../../../../_custom/clusterManagement/pods/pods-para-qosTypes.adoc[] + +|资源用量排行 +|当前项目中特定资源用量最高的 5 个工作负载。点击下拉列表可选择按 CPU、内存、出站流量或入站流量排序。 + +* 在列表上方点击image:/images/ks-qkcp/zh/icons/sort-ascending.svg[sort-ascending,18,18]/image:/images/ks-qkcp/zh/icons/sort-descending.svg[sort-descending,18,18] 可按升序/降序排序。 + +* 点击下方的**查看更多**，查看工作负载的资源用量详情。 +|=== +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/_index.adoc new file mode 100644 index 000000000..b0398ec74 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/01-overview/_index.adoc @@ -0,0 +1,6 @@ +--- +title: "概览" +weight: 01 +--- + +本节介绍安装“WhizardTelemetry 监控”扩展组件后，如何查看集群、企业空间、项目概览页面的监控信息。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/01-view-cluster-status-overview.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/01-view-cluster-status-overview.adoc new file mode 100644 index 000000000..d07227c79 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/01-view-cluster-status-overview.adoc @@ -0,0 +1,64 @@ +--- +title: "查看集群状态概览" +keywords: "Kubernetes, {ks_product}, 监控告警, 集群状态，概览" +description: "介绍如何查看集群状态概览。" +weight: 01 +--- + +:ks_permission: **监控查看** +:ks_navigation: **监控告警 > 集群状态** + + +本节介绍如何查看集群状态概览。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 + +== 操作步骤 + +include::../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**集群状态**页面的**概览**区域查看集群节点、集群资源、etcd 和服务组件的状态。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群节点状态 +|集群的节点总数和正常节点数量。 + +|集群资源用量 +|集群的 CPU、内存、磁盘资源的总数和已使用量，以及集群可创建容器组总数和已创建容器组数量。默认情况下每个正常集群节点最多可创建 110 个容器组。 + +|etcd 监控 +|etcd 数据库的服务状态、Raft 提议数量、数据库大小和客户端流量。 + +* **服务状态**：显示 etcd 集群的 Leader 节点、每个节点的 IP 地址和 1 小时内 Leader 变更次数。 + +* **Raft 提议**：显示 Raft 提议的每秒提交次数、应用次数、失败次数和排队提议数量。 + +* **数据库大小**：etcd 数据库大小随时间的变化。 + +* **客户端流量**：发送给 gRPC 客户端和从 gRPC 客户端接收的数据流量。 + +查看 etcd 监控信息需要提前启用 etcd 监控。有关更多信息，请参阅扩展中心 **WhizardTelemetry 监控**扩展组件的详情页说明。 + +|服务组件监控 +|Kubernetes API 服务器的请求延迟和每秒请求次数，以及调度器的累计调度次数和每秒调度次数。 +|=== +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/02-view-physical-resource-status.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/02-view-physical-resource-status.adoc new file mode 100644 index 000000000..8b0559e6d --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/02-view-physical-resource-status.adoc @@ -0,0 +1,81 @@ +--- +title: "查看物理资源状态" +keywords: "Kubernetes, {ks_product}, 监控告警, 集群状态，物理资源状态" +description: "介绍如何查看物理资源状态。" +weight: 02 +--- + +:ks_permission: **监控查看** +:ks_navigation: **监控告警 > 集群状态** + + +本节介绍如何查看物理资源状态。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 + + + +== 操作步骤 + +include::../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**集群状态**页面，点击**物理资源监控**查看集群物理资源的使用情况。 ++ +==== +* **物理资源监控**页签提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|CPU 用量 +|显示指定时间范围内的集群 CPU 使用量百分比。 + +|CPU 平均负载 +|显示指定时间范围内的集群 CPU 平均负载。CPU 平均负载是一个无量纲值，表示单位时间内 CPU 的平均活跃进程数。 + +|内存用量 +|显示指定时间范围内的集群内存使用量百分比。 + +|磁盘用量 +|显示指定时间范围的内集群磁盘使用量。 + +|Inode 用量 +|显示指定时间范围内的集群 Inode 使用量百分比。 + +|磁盘吞吐 +|显示指定时间范围内的集群磁盘读写速率。 + +|IOPS +|显示指定时间范围内的集群磁盘每秒读写操作数。 + +|网络流量 +|显示指定时间范围内集群网络出入速率。 + +|容器组状态 +|显示指定时间范围内集群运行中、已完成和异常容器组的数。 +|=== +-- + +include::../../../../../../_ks_components/oper-selectTimeRange.adoc[] + +include::../../../../../../_ks_components/oper-Autorefresh.adoc[] + +include::../../../../../../_ks_components/oper-refreshData.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/03-view-etcd-status.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/03-view-etcd-status.adoc new file mode 100644 index 000000000..301e4f70f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/03-view-etcd-status.adoc @@ -0,0 +1,92 @@ +--- +title: "查看 etcd 数据库状态" +keywords: "Kubernetes, {ks_product}, 监控告警, 集群状态，etcd 状态" +description: "介绍如何查看 etcd 数据库状态。" +weight: 03 +--- + +:ks_permission: **监控查看** +:ks_navigation: **监控告警 > 集群状态** + + +本节介绍如何查看 etcd 数据库状态。 + +[.admon.note,cols="a"] +|=== +|说明 + +| +查看 etcd 监控信息需要提前启用 etcd 监控。有关更多信息，请参阅扩展中心 **WhizardTelemetry 监控**扩展组件的详情页说明。 +|=== + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**集群状态**页面，点击 **etcd 监控**页签查看 etcd 数据库的运行状态。 ++ +==== +* **etcd 监控**页签提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|服务状态 +|显示 etcd 集群的 Leader 节点、每个节点的 IP 地址和 1 小时内 Leader 变更次数。 + +|数据库大小 +|指定时间范围内 etcd 数据库的大小。 + +|客户端流量 +|显示发送给 gRPC 客户端和从 gRPC 客户端接收的数据流量。 + +|gRPC 流式消息 +|显示服务端的 gRPC 流式消息每秒接收次数和发送次数。 + +|WAL 日志同步时间 +|显示 WAL 调用 fsync 的延迟。在应用日志条目之前，etcd 会在持久化日志条目到磁盘时调用 **wal_fsync**。 + +|数据库同步时间 +|显示后端调用提交延迟的分布。当 etcd 将其最新的增量快照提交到磁盘时，会调用 **backend_commit**。磁盘操作延迟较大（WAL 日志同步时间或库同步时间较长）通常表示磁盘存在问题，这可能会导致请求延迟过高或集群不稳定。 + +|Raft 提议 +| +显示当前 etcd 每秒的 Raft 提议次数。将鼠标悬停在折线图上即可查看具体某个时间点的提议数据。 + +* **提议提交速率**：协商一致提议的提交速率。如果集群运行状况良好，则该指标应随着时间的推移而增加。etcd 集群的几个健康成员可以同时具有不同的一般提议。单个成员与其 Leader 之间的持续较大滞后表示该成员缓慢或不健康。 + +* **提议应用速率**：协商一致提议的总应用率。etcd 服务器异步地应用每个提交的提议。提议提交速率和提议应用速率的差异应该很小（即使在高负载下也只有几千）。如果它们之间的差异持续增大，则表明 etcd 服务器过载。当使用大范围查询或大量 txn 操作等大规模查询时，可能会出现这种情况。 + +* **提议失败速率**：提议失败的总速率。该值受两个因素影响：与 Leader 选举相关的临时失败；集群成员数目达不到规定数目而导致长时间停机。 + +* **排队提议数**：当前待处理提议的数量。待处理提议的增加表明客户端负载较高或成员无法提交提议。 +|=== + +有关 etcd 数据库参数的更多信息，请参阅 link:https://etcd.io/docs/v3.5/metrics/[etcd 官方文档]。 +-- + +include::../../../../../../_ks_components/oper-selectTimeRange.adoc[] + +include::../../../../../../_ks_components/oper-Autorefresh.adoc[] + +include::../../../../../../_ks_components/oper-refreshData.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/04-view-api-server-status.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/04-view-api-server-status.adoc new file mode 100644 index 000000000..7a44a0890 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/04-view-api-server-status.adoc @@ -0,0 +1,60 @@ +--- +title: "查看 Kubernetes API 服务器状态" +keywords: "Kubernetes, {ks_product}, 监控告警, 集群状态，API 服务器状态" +description: "介绍如何查看 Kubernetes API 服务器监控数据。" +weight: 04 +--- + +:ks_permission: **监控查看** +:ks_navigation: **监控告警 > 集群状态** + + +本节介绍如何查看 Kubernetes API 服务器状态。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 + + + +== 操作步骤 + +include::../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**集群状态**页面，点击 **API Server 监控**页签查看 API 服务器的运行状态。 ++ +==== +* **API Server 监控**页签提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|指标 |描述 + +|请求延迟 +|指定时间范围内 API 服务器的请求延迟。 + +|每秒请求次数 +|指定时间范围内 API 服务器每秒接受的请求数。 +|=== +-- + +include::../../../../../../_ks_components/oper-selectTimeRange.adoc[] + +include::../../../../../../_ks_components/oper-Autorefresh.adoc[] + +include::../../../../../../_ks_components/oper-refreshData.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/05-view-scheduler-monitoring-data.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/05-view-scheduler-monitoring-data.adoc new file mode 100644 index 000000000..3474707b3 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/05-view-scheduler-monitoring-data.adoc @@ -0,0 +1,63 @@ +--- +title: "查看调度器状态" +keywords: "Kubernetes, {ks_product}, 监控告警, 集群状态，调度器状态" +description: "介绍如何查看调度器状态。" +weight: 05 +--- + +:ks_permission: **监控查看** +:ks_navigation: **监控告警 > 集群状态** + + +本节介绍如何查看调度器状态。调度器根据容器组的资源需求、节点可用资源和其他约束条件决定容器组运行在哪些节点上。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 + + + +== 操作步骤 + +include::../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**集群状态**页面，点击**调度器监控**页签查看调度器的运行状态。 ++ +==== +* **调度器监控**页签提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|指标 |描述 + +|调度次数 +|指定时间范围内的容器组调度成功、错误和失败累计次数。 + +|调度速率 +|指定时间范围内的容器组每秒调度成功、错误和失败次数。 + +|调度延迟 +|指定时间范围内容器组调度延迟的 99% 分位数、90% 分位数、中位数和平均值。 +|=== +-- + +include::../../../../../../_ks_components/oper-selectTimeRange.adoc[] + +include::../../../../../../_ks_components/oper-Autorefresh.adoc[] + +include::../../../../../../_ks_components/oper-refreshData.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/06-view-nodes-ranked-by-resource-usage.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/06-view-nodes-ranked-by-resource-usage.adoc new file mode 100644 index 000000000..108349f42 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/06-view-nodes-ranked-by-resource-usage.adoc @@ -0,0 +1,45 @@ +--- +title: "查看节点资源用量排行" +keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 集群状态, 资源用量" +description: "介绍如何按照特定资源的用量对节点进行排序。" +weight: 06 +--- + +:ks_permission: **监控查看** +:ks_navigation: **监控告警 > 集群状态** + + +本节介绍如何按照特定资源的用量对节点进行排序。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 + + + +== 操作步骤 + +include::../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**集群状态**页面，点击**资源用量排行**页签查看各节点的资源使用情况。 ++ +-- +* 在左上角点击下拉列表可选择按照 CPU 用量、CPU 平均负载、内存用量、磁盘用量、Inode 用量或容器组用量对节点进行排序。 + +include::../../../../../_custom/clusterManagement/clusterStatus/clusterStatus-oper-sortAscendingDescending.adoc[] + +include::../../../../../_custom/clusterManagement/clusterStatus/clusterStatus-oper-exportJsonData.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/_index.adoc new file mode 100644 index 000000000..b4e62848d --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/03-cluster-status/_index.adoc @@ -0,0 +1,9 @@ +--- +title: "集群状态" +keywords: "Kubernetes, {ks_product}, 监控告警, 集群状态" +description: "介绍如何查看集群状态。" +weight: 03 +--- + + +本节介绍如何查看集群状态。集群状态展示集群资源的监控数据和用量排行情况。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/01-view-resource-usage.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/01-view-resource-usage.adoc new file mode 100644 index 000000000..5941e9076 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/01-view-resource-usage.adoc @@ -0,0 +1,62 @@ +--- +title: "查看应用资源用量" +keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 资源用量" +description: "介绍如何查看应用资源用量的监控数据。" +weight: 01 +--- + +:ks_permission: **监控查看** +:ks_navigation: **监控告警 > 应用资源** + + +本节介绍如何查看应用资源用量。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 + + + +== 操作步骤 + +include::../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**应用资源**页面，点击**资源用量**页签查看集群资源用量、应用资源用量和项目数量。 ++ +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群资源用量 +|当前集群已使用的 CPU 和内存资源数量。 + +|应用资源用量 +|当前集群中已创建的部署、有状态副本集、守护进程集、任务、定时任务、持久卷声明、服务、应用路由、容器组的数量。 + +|项目数量 +|当前集群中的项目数量。 +|=== + ++ +-- +* 点击**集群资源用量**和**应用资源用量**中的折线图，查看资源用量随时间变化的详细信息。 + +include::../../../../../../_ks_components/oper-selectTimeRange.adoc[] + +include::../../../../../../_ks_components/oper-Autorefresh.adoc[] + +include::../../../../../../_ks_components/oper-refreshData.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/02-view-projects-ranked-by-resource-usage.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/02-view-projects-ranked-by-resource-usage.adoc new file mode 100644 index 000000000..58b9b2d61 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/02-view-projects-ranked-by-resource-usage.adoc @@ -0,0 +1,45 @@ +--- +title: "查看项目资源用量排行" +keywords: "Kubernetes, {ks_product}, 集群管理, 应用资源，用量排行" +description: "介绍如何查看项目资源用量排行。" +weight: 02 +--- + +:ks_permission: **监控查看** +:ks_navigation: **监控告警 > 应用资源** + + +本节介绍如何查看项目资源用量排行。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 + + + +== 查看用量排行 + +include::../../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**应用资源**页面，点击**用量排行**页签查看各项目的资源使用情况。 ++ +-- +* 在列表左上角点击下拉列表可选择按照 CPU 用量、内存用量、容器组数量、出站流量或入站流量对项目进行排序。 + +include::../../../../../_custom/clusterManagement/clusterStatus/clusterStatus-oper-sortAscendingDescending.adoc[] + +include::../../../../../_custom/clusterManagement/clusterStatus/clusterStatus-oper-exportJsonData.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/_index.adoc new file mode 100644 index 000000000..b9ea9e405 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/04-application-resources/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "应用资源" +keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 应用资源" +description: "介绍如何查看应用资源数据。" +weight: 04 +--- + + + +本节介绍如何查看应用资源数据。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/01-create-a-custom-monitoring-dashboard.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/01-create-a-custom-monitoring-dashboard.adoc new file mode 100644 index 000000000..5b6bdee90 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/01-create-a-custom-monitoring-dashboard.adoc @@ -0,0 +1,41 @@ +--- +title: "创建自定义监控面板" +keywords: "Kubernetes, {ks_product}, 集群管理, 自定义监控面板, 创建自定义监控面板" +description: "介绍如何创建自定义监控面板。" +weight: 01 +--- + +:ks_permission: **监控管理** +:ks_navigation: **监控告警 > 自定义监控** + + +include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-createACustomMonitoringDashboard.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../../ + +* {empty} +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] + +:relfileprefix: ./ + +include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-prer-exposeMetrics.adoc[] + +* 您需要在用于暴露工作负载的服务上设置监控导出器以声明提供应用程序监控指标的路径。{ks_product_right}将根据监控导出器的相关参数获取应用程序的监控指标。有关更多信息，请参阅link:../../08-edit-a-metrics-exporter/[编辑监控导出器]。 + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-createACustomMonitoringDashboard.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/02-view-a-custom-monitoring-dashboard.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/02-view-a-custom-monitoring-dashboard.adoc new file mode 100644 index 000000000..9e2c398cf --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/02-view-a-custom-monitoring-dashboard.adoc @@ -0,0 +1,32 @@ +--- +title: "查看自定义监控面板" +keywords: "Kubernetes, {ks_product}, 集群管理, 自定义监控面板, 查看自定义监控面板" +description: "介绍如何查看自定义监控面板。" +weight: 02 +--- + +:ks_permission: **监控查看** +:ks_navigation: **监控告警 > 自定义监控** + + +include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-viewACustomMonitoringDashboard.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../../ + +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] + +:relfileprefix: ./ + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-viewACustomMonitoringDashboard.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/03-edit-custom-monitoring-dashboard-information.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/03-edit-custom-monitoring-dashboard-information.adoc new file mode 100644 index 000000000..a0c379dc4 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/03-edit-custom-monitoring-dashboard-information.adoc @@ -0,0 +1,33 @@ +--- +title: "编辑自定义监控面板信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 自定义监控面板, 编辑自定义监控面板信息" +description: "介绍如何编辑自定义监控面板的信息。" +weight: 03 +--- + +:ks_permission: **监控管理** +:ks_navigation: **监控告警 > 自定义监控** + + +本节介绍如何编辑自定义监控面板的信息。 + +您可以编辑自定义监控面板的别名和描述。{ks_product_right}不支持编辑自定义监控面板的名称。 + +== 前提条件 + +:relfileprefix: ../../../../../ + +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] + +:relfileprefix: ./ + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editCustomMonitoringDashboardInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/04-edit-a-custom-monitoring-dashboard.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/04-edit-a-custom-monitoring-dashboard.adoc new file mode 100644 index 000000000..9016941bf --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/04-edit-a-custom-monitoring-dashboard.adoc @@ -0,0 +1,32 @@ +--- +title: "编辑自定义监控面板" +keywords: "Kubernetes, {ks_product}, 集群管理, 自定义监控面板, 编辑自定义监控面板" +description: "介绍如何编辑自定义监控面板。" +weight: 04 +--- + +:ks_permission: **监控管理** +:ks_navigation: **监控告警 > 自定义监控** + + +include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-editACustomMonitoringDashboard.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../../ + +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] + +:relfileprefix: ./ + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-editACustomMonitoringDashboard.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/05-delete-custom-monitoring-dashboards.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/05-delete-custom-monitoring-dashboards.adoc new file mode 100644 index 000000000..a7fdd8732 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/05-delete-custom-monitoring-dashboards.adoc @@ -0,0 +1,44 @@ +--- +title: "删除自定义监控面板" +keywords: "Kubernetes, {ks_product}, 集群管理, 自定义监控面板, 删除自定义监控面板" +description: "介绍如何删除自定义监控面板。" +weight: 05 +--- + +:ks_permission: **监控管理** +:ks_navigation: **监控告警 > 自定义监控** + + +include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-deleteCustomMonitoringDashboards.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../../ + +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] + +:relfileprefix: ./ + +== 删除单个自定义监控面板 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteASingleCustomMonitoringDashboard.adoc[] + + +== 批量删除自定义监控面板 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-deleteMultipleCustomMonitoringDashboards.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/_index.adoc new file mode 100644 index 000000000..0fd1b9c42 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/05-custom-monitoring/_index.adoc @@ -0,0 +1,18 @@ +--- +title: "自定义监控" +keywords: "Kubernetes, {ks_product}, 集群管理, 自定义监控面板" +description: "介绍如何使用自定义监控面板。" +weight: 05 +--- + + + +include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-customMonitoringDashboards.adoc[] + +include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-howToUse.adoc[] + +include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-exposeMetrics.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-oper-useCustomMonitoringDashboard.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/08-edit-a-metrics-exporter.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/08-edit-a-metrics-exporter.adoc new file mode 100644 index 000000000..3b6283182 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/08-edit-a-metrics-exporter.adoc @@ -0,0 +1,46 @@ +--- +title: "编辑监控导出器" +keywords: "Kubernetes, {ks_product}, 项目管理, 工作负载, 服务, 编辑监控导出器" +description: "介绍如何编辑服务外部访问设置。" +weight: 08 +--- + +:ks_permission: **应用负载管理** +:ks_navigation: **应用负载 > 服务** + + +include::../../../../_custom/clusterManagement/services/services-desc-editAMetricsExporter.adoc[] + +include::../../../../_custom/clusterManagement/customMonitoringDashboards/customMonitoringDashboards-desc-exposeMetrics.adoc[] + ++ + +include::../../../../_custom/clusterManagement/services/services-oper-exposeMetrics.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] + +:relfileprefix: ./ + +include::../../../../_custom/clusterManagement/services/services-prer-exposeMetrics.adoc[] + + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/services/services-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/services/services-oper-editAMetricsExporter.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/_index.adoc new file mode 100644 index 000000000..02d7a63ba --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/_index.adoc @@ -0,0 +1,46 @@ +--- +title: "WhizardTelemetry 监控" +keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心" +description: "介绍如何使用 Whizard 可观测中心功能。" +weight: 05 +--- + + +本节介绍如何使用“WhizardTelemetry 监控”扩展组件。 + +WhizardTelemetry 监控是 WhizardTelemetry 可观测平台中提供监控功能的扩展组件，其中包含了 Whizard 可观测中心。可提供多租户视角的云原生资源监控能力, 包括针对多集群、节点、工作负载、GPU、K8s 控制面等对象的核心监控指标实时和历史数据展示等功能。 + +本节仅介绍单集群环境下的监控功能。有关单集群的告警功能，请参阅 link:../06-alerting[WhizardTelemetry 告警管理]。有关多集群的监控和告警功能，请参阅 link:../07-whizard[Whizard 可观测中心]。 + +安装“WhizardTelemetry 监控”扩展组件后，集群和项目的左侧导航栏将显示**监控告警**选项，集群和项目中应用负载下的服务将支持**编辑监控导出器**，以下页面也将显示相关监控指标的数据： + +[%header,cols="1a,3a"] +|=== +|模块 +|页面 + +|集群管理 +| +* 概览页面； +* 集群节点、项目的列表和详情页； +* 工作负载、任务、容器组、服务、容器组 IP 池、持久卷声明的详情页； +* 集群设置的基本信息页面。 + +|企业空间管理 +| +* 概览页面； +* 项目列表。 + +|项目管理 +| +* 概览页面； +* 工作负载、任务、容器组、服务、持久卷声明的详情页。 +|=== + +[.admon.note,cols="a"] +|=== +|说明 + +| +有关组件配置的更多信息，请参阅扩展中心“WhizardTelemetry 监控”扩展组件的详情页说明。 +|=== \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/01-create-a-rule-group.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/01-create-a-rule-group.adoc new file mode 100644 index 000000000..f6d2e4771 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/01-create-a-rule-group.adoc @@ -0,0 +1,100 @@ +--- +title: "创建规则组" +keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 规则组, 创建规则组" +description: "介绍如何创建告警规则组。" +weight: 01 +--- + + +:ks_permission: **规则组管理** +:ks_navigation: **监控告警 > 规则组** + + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-createAnAlertingPolicy.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警管理**扩展组件。 + +:relfileprefix: ../../../../../ + +* {empty} +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] + +:relfileprefix: ./ + +// :relfileprefix: ../../../../../ + +// include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-prer-exposeMetrics.adoc[] + +// :relfileprefix: ./ + + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 ++ +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-setBasicInfo.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-addAlertRule.adoc[] ++ +==== +include::../../../../../_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-commonParameters_new.adoc[] + +* 规则模板 ++ +-- +通过下拉列表选择监控目标和触发条件。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|资源类型 +|需要监控的工作负载的类型，如部署、有状态副本集、守护进程集。仅显示在项目的告警规则设置中。 + +|监控目标 +|需要监控的目标，如集群节点、工作负载等。 + +include::../../../../../_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-triggerCondition.adoc[] +|=== +-- + +* 自定义规则 ++ +-- +通过 PromQL 表达式指定监控目标和触发条件。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../../_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-duration.adoc[] + +|告警级别 +| +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-para-alertLevel.adoc[] + +include::../../../../../_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-ruleExpression.adoc[] +|=== +-- +==== + ++ + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-clickOK.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/02-view-a-rule-group-list.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/02-view-a-rule-group-list.adoc new file mode 100644 index 000000000..0c0ad1f6d --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/02-view-a-rule-group-list.adoc @@ -0,0 +1,46 @@ +--- +title: "查看规则组列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 规则组, 查看规则组列表" +description: "介绍如何查看告警规则组列表。" +weight: 02 +--- + +:ks_permission: **规则组查看** +:ks_navigation: **监控告警 > 规则组** + + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-viewAnAlertingPolicyList.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警管理**扩展组件。 + + +:relfileprefix: ../../../../../ + +* {empty} +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] + +:relfileprefix: ./ + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc[] ++ +==== +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList.adoc[] + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-searchForAlertingPolicies.adoc[] + +include::../../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/03-view-rule-group-details.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/03-view-rule-group-details.adoc new file mode 100644 index 000000000..627ecd956 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/03-view-rule-group-details.adoc @@ -0,0 +1,39 @@ +--- +title: "查看规则组详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 规则组, 查看规则组详情" +description: "介绍如何查看规则组详情。" +weight: 03 +--- + +:ks_permission: **规则组查看** +:ks_navigation: **监控告警 > 规则组** + + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-viewAlertingPolicyDetails.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警管理**扩展组件。 + +:relfileprefix: ../../../../../ + +* {empty} +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] + +:relfileprefix: ./ + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openDetailsPage.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-viewAlertingPolicyDetails.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/04-edit-rule-group-information.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/04-edit-rule-group-information.adoc new file mode 100644 index 000000000..6bba4b386 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/04-edit-rule-group-information.adoc @@ -0,0 +1,43 @@ +--- +title: "编辑规则组信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 规则组, 编辑规则组信息" +description: "介绍如何编辑规则组信息。" +weight: 04 +--- + +:ks_permission: **规则组管理** +:ks_navigation: **监控告警 > 规则组** + + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-editRuleGroupInformation.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警管理**扩展组件。 + +:relfileprefix: ../../../../../ + +* {empty} +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] + +:relfileprefix: ./ + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-clickEditInformation.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-editRuleGroupInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/05-edit-alert-rules.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/05-edit-alert-rules.adoc new file mode 100644 index 000000000..fc8a4c696 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/05-edit-alert-rules.adoc @@ -0,0 +1,43 @@ +--- +title: "编辑告警规则" +keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 规则组, 编辑告警规则" +description: "介绍如何编辑规则组中的告警规则。" +weight: 05 +--- + +:ks_permission: **规则组管理** +:ks_navigation: **监控告警 > 规则组** + + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-editAnAlertingPolicy.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警管理**扩展组件。 + +:relfileprefix: ../../../../../ + +* {empty} +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] + +:relfileprefix: ./ + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-editAnAlertingPolicy.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-editAlertRules.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/06-disable-and-enable-rule-groups.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/06-disable-and-enable-rule-groups.adoc new file mode 100644 index 000000000..88b3e2e36 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/06-disable-and-enable-rule-groups.adoc @@ -0,0 +1,55 @@ +--- +title: "禁用和启用规则组" +keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 规则组, 禁用和启用规则组" +description: "介绍如何禁用和启用告警规则组。" +weight: 06 +--- + +:ks_permission: **规则组管理** +:ks_navigation: **监控告警 > 规则组** + + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-disableAndEnablerRuleGroups.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警管理**扩展组件。 + +:relfileprefix: ../../../../../ + +* {empty} +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] + +:relfileprefix: ./ + +== 禁用和启用单个规则组 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableASingleRuleGroup.adoc[] + + +== 批量禁用和启用规则组 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableMultipleRuleGroups.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/07-delete-rule-groups.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/07-delete-rule-groups.adoc new file mode 100644 index 000000000..73e376ee7 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/07-delete-rule-groups.adoc @@ -0,0 +1,47 @@ +--- +title: "删除规则组" +keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 规则组, 编辑规则组" +description: "介绍如何编辑告警规则组。" +weight: 07 +--- + +:ks_permission: **规则组管理** +:ks_navigation: **监控告警 > 规则组** + + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-deleteAlertingPolicies.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警管理**扩展组件。 + +:relfileprefix: ../../../../../ + +* {empty} +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] + +:relfileprefix: ./ + +== 删除单个规则组 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-deleteASingleAlertingPolicy.adoc[] + + +== 批量删除规则组 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-deleteMultipleAlertingPolicies.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/08-reset-built-in-rule-groups.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/08-reset-built-in-rule-groups.adoc new file mode 100644 index 000000000..ea9cfddb2 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/08-reset-built-in-rule-groups.adoc @@ -0,0 +1,61 @@ +--- +title: "重置内置规则组" +keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 告警管理, 规则组, 删除规则组" +description: "介绍如何删重置内置规则组。" +weight: 08 +--- + +:ks_permission: **规则组管理** +:ks_navigation: **监控告警 > 规则组** + + +本节介绍如何重置内置规则组。 + +[.admon.note,cols="a"] +|=== +|说明 + +| +* {ks_product_right}仅支持重置内置规则组，不支持重置自定义规则组。 +* 项目中没有内置规则组。 +|=== + +[.admon.warning,cols="a"] +|=== +|警告 + +| +规则组重置后不能恢复，请谨慎执行此操作。 +|=== + + + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警管理**扩展组件。 + +:relfileprefix: ../../../../../ + +* {empty} +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**规则组**页面，点击**内置规则组**打开规则组列表。 + +. 在需要重置的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**重置**。 + +. 在**重置规则组**对话框，点击**确定**。 + diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/_index.adoc new file mode 100644 index 000000000..e446f43a9 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/_index.adoc @@ -0,0 +1,23 @@ +--- +title: "规则组" +keywords: "Kubernetes, {ks_product}, 集群管理, 规则组" +description: "介绍如何创建、编辑和查看告警规则组。" +weight: 03 +--- + +本节介绍如何在集群和项目中创建、编辑、启用、禁用和查看告警规则组。 + +创建规则组后，系统可在特定监控指标满足预设条件和持续时间时生成告警。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +- {ks_product_right}为集群提供了内置规则组，同时也支持自定义规则组。若已启用 Whizard 可观测中心，内置规则组只能在 Whizard 可观测中心中进行管理。有关更多信息，请参阅 link:../../07-whizard/05-alert-management/02-rule-groups/[Whizard 规则组]。 + +- 在项目中，只支持自定义规则组。 +|=== + + diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/04-alerts/01-view-an-alert-list.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/04-alerts/01-view-an-alert-list.adoc new file mode 100644 index 000000000..762109de1 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/04-alerts/01-view-an-alert-list.adoc @@ -0,0 +1,46 @@ +--- +title: "查看告警列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 告警, 查看告警列表" +description: "介绍如何查看告警列表。" +weight: 01 +--- + +:ks_permission: **告警查看** +:ks_navigation: **监控告警 > 告警** + + +include::../../../../../_custom/clusterManagement/alerts/alerts-desc-viewAnAlertingMessageList.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 告警管理**扩展组件。 + +:relfileprefix: ../../../../../ + +include::../../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../..//_custom/clusterManagement/alerts/alerts-oper-openListPage.adoc[] + ++ +==== +include::../../../../../_custom/clusterManagement/alerts/alerts-para-alertingMessageList.adoc[] + +include::../../../../../_custom/clusterManagement/alerts/alerts-oper-searchForAlertingMessages_new.adoc[] + +include::../../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/04-alerts/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/04-alerts/_index.adoc new file mode 100644 index 000000000..f44a97b4f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/04-alerts/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "告警" +keywords: "Kubernetes, {ks_product}, 集群管理, 告警" +description: "介绍如何使用告警功能。" +weight: 04 +--- + + + +本节介绍如何使用告警功能。 + +告警由系统根据告警规则组生成。当告警规则组中设置的指标满足预设的条件和持续时间时，系统将生成告警。当指标不再满足预设的条件时，告警将被系统自动清除。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/_index.adoc new file mode 100644 index 000000000..edaee033f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/_index.adoc @@ -0,0 +1,60 @@ +--- +title: "WhizardTelemetry 告警管理" +keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警" +description: "介绍如何监控集群状态、应用资源和告警，以及管理告警规则组和自定监控面板。" +weight: 06 +--- + +本节介绍如何使用“WhizardTelemetry 告警管理”扩展组件。 + +WhizardTelemetry 告警管理基于 KubeSphere 采集的监控数据，可针对不同资源类型和监控指标，提供平台、集群及项目视角的告警及告警规则管理功能。 + +安装“WhizardTelemetry 告警管理”扩展组件后，集群和项目左侧导航栏的**监控告警**菜单下将显⽰**告警**和**规则组**选项。 + +//attention +[.admon.attention,cols="a"] +|=== +| 注意 + +| +- WhizardTelemetry 告警管理依赖 WhizardTelemetry 平台服务和 WhizardTelemetry 监控，因此在安装 WhizardTelemetry 告警管理之前必须先安装 WhizardTelemetry 平台服务和 WhizardTelemetry 监控两个扩展组件，否则告警相关功能无法正常使用！ + +- 为了及时收到系统告警消息，建议同时安装 WhizardTelemetry 通知管理扩展组件。 +|=== + +**配置说明：** + +* 当 **WhizardTelemetry 监控**扩展组件未启用 Whizard 可观测中心时： + +. 安装 **WhizardTelemetry 告警管理**扩展组件时，保持 `global.rules.distributionMode` 为 Member。 +. 若使用 **WhizardTelemetry 通知管理**扩展组件发送告警消息，需将 WhizardTelemetry 告警管理的 `agent.ruler.alertmanagersUrl` 配置为 WhizardTelemetry 通知管理的 `alertmanager-proxy` 服务，该服务安装在 host 集群，以 NodePort 形式（默认 31093）暴露。 ++ +[,yaml] +---- +global: + rules: + distributionMode: Member + +agent: + ruler: + alertmanagersUrl: + - 'http://:' +---- + + +* 当 **WhizardTelemetry 监控**扩展组件已启用 Whizard 可观测中心时： + +. 安装 **WhizardTelemetry 告警管理**扩展组件时，保持 `global.rules.distributionMode` 为 None。 +. 若使用 **WhizardTelemetry 通知管理**扩展组件发送告警消息，需将 WhizardTelemetry 告警管理的 `extension.ruler.alertmanagersUrl` 配置为 WhizardTelemetry 通知管理的 `alertmanager` 服务（按如下配置即可）。 ++ +[,yaml] +---- +global: + rules: + distributionMode: None + +extension: + ruler: + alertmanagersUrl: + - 'dnssrv+http://whizard-notification-alertmanager-headless.kubesphere-monitoring-system.svc:9093' +---- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/01-enable-whizard.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/01-enable-whizard.adoc new file mode 100644 index 000000000..f208f66b4 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/01-enable-whizard.adoc @@ -0,0 +1,85 @@ +--- +title: "启用 Whizard 可观测中心" +weight: 01 +--- + +本节介绍如何配置相关扩展组件，以启用 Whizard 可观测中心。 + +为了使用 Whizard 可观测中心的完整功能，您需要安装并启用 WhizardTelemetry 平台服务、 WhizardTelemetry 监控以及 WhizardTelemetry 告警管理扩展组件，并进行以下配置。 + +== 前提条件 + +* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../05-users-and-roles/01-users/[用户]和link:../../../../05-users-and-roles/02-platform-roles/[平台角色]。 +* 已安装 **WhizardTelemetry 平台服务**、 **WhizardTelemetry 监控**以及 **WhizardTelemetry 告警管理**扩展组件。 + +== 操作步骤 + +. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 +. 点击**扩展中心**。 +. 点击已安装的组件名称，进入组件详情页。 +. 点击组件图标下的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**扩展组件配置**。 ++ +-- +**WhizardTelemetry 平台服务** + +将配置文件中的 `whizard-telemetry.config.observability.enabled` 参数设置为 true，然后点击**确定**。 + +[,yaml] +---- +whizard-telemetry: + config: + observability: + enabled: true + endpoint: "http://query-frontend-whizard-operated.kubesphere-monitoring-system.svc:10902" +---- +**WhizardTelemetry 监控** + +修改配置文件的以下部分，然后点击**确定**。 + +[,yaml] +---- +whizard-monitoring-helper: + whizardHelper: + enabled: true ## set true to enable whizard + +whizard: + enabled: true + +frontend: + enabled: true + +whizardAgentProxy: + enabled: true + +whizard-agent-proxy: + config: + gatewayUrl: "http://172.31.73.206:30990" ## set whizard gateway url，default is http://{host_cluster_node_ip}:30990 + +kube-prometheus-stack: + prometheus: + agentMode: true # agentMode need to be set to true when enable whizard +---- + +**WhizardTelemetry 告警管理** + +确保 `global.rules.distributionMode` 为 None。 + +[,yaml] +---- +global: + rules: + distributionMode: None +---- + +-- +. 编辑完成后，点击顶部导航栏上的image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，即可发现 **Whizard 可观测中心**图标。 ++ +-- +[.admon.note,cols="a"] +|=== +|说明 + +| +启用过程可能需要一定时间，请等待启用完成。 +|=== +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-view-monitoring-data-of-multiple-clusters.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-view-monitoring-data-of-multiple-clusters.adoc new file mode 100644 index 000000000..94de6c545 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/03-view-monitoring-data-of-multiple-clusters.adoc @@ -0,0 +1,89 @@ +--- +title: "查看多集群监控数据" +keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心, 查看多集群监控数据" +description: "介绍如何查看多集群监控数据。" +weight: 03 +--- + + +本节介绍如何查看多集群监控数据。 + + +== 前提条件 + +* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../05-users-and-roles/01-users/[用户]和link:../../../../05-users-and-roles/02-platform-roles/[平台角色]。 + +* host 集群和需要监控的成员集群需要启用 Whizard 可观测中心。 + ++ +-- +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +如果成员集群未启用 Whizard 可观测中心，Whizard 可观测中心将无法获取成员集群的数据。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + + +== 操作步骤 + +include::../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] + ++ + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 + ++ +-- +Whizard 可观测中心的**概览**页面显示所有集群的监控信息。 + +[%header,cols="1a,4a"] +|=== +|功能区 |描述 + +|已创建资源数量 +|显示当前平台管理的所有集群、节点、项目、容器组、部署、有状态副本集、守护进程集、任务、定时任务、卷、服务、应用路由的数量。 + +|资源使用情况 +|显示当前平台管理的所有集群的所有节点的 CPU、内存、磁盘使用情况，以及可已创建容器组数量占可创建容器组最大数量的百分比。默认情况下每个节点最多可以创建 110 个容器组。 + +对于 CPU 和内存，将光标悬停在image:/images/ks-qkcp/zh/icons/eye.svg[eye,18,18]可查看已分配给容器和项目的资源预留和上限数量。 + +|集群成员和集群角色 +|显示当前平台管理的所有集群的集群成员和集群角色数量。 + +|全局告警 +|显示全局告警规则组产生的告警数量及最近的告警消息。此处显示的告警不包括集群和项目告警规则组产生的告警。全局告警规则组由平台管理员在 Whizard 可观测中心管理。 + +告警级别的类型包括**提醒、警告、重要和紧急**。 + +告警状态的类型包括： + +include::../../../../_custom/clusterManagement/alerts/alerts-para-alertingStatus.adoc[] + +|资源用量排行 +|显示当前平台资源用量最多的集群、节点、项目和容器组。 + +* 点击下拉列表可选择对象类型和排序依据。 + +* 在列表上方点击image:/images/ks-qkcp/zh/icons/sort-ascending.svg[sort-ascending,18,18]/image:/images/ks-qkcp/zh/icons/sort-descending.svg[sort-descending,18,18] 可按升序/降序排序。 + +* 点击**查看更多**可查看集群、节点、项目和容器组的资源用量详情。 + +|容器组 +|显示当前平台管理的所有集群的各种类型容器组的数量。 + +容器组状态类型包括： + +include::../../../../_custom/clusterManagement/pods/pods-para-podStatus.adoc[] + +容器组 QoS（服务质量）类型包括： + +include::../../../../_custom/clusterManagement/pods/pods-para-qosTypes.adoc[] +|=== +-- + +. 在左侧导航栏点击集群的名称，可查看集群的详细监控信息。 ++ +在页面右上角，点击**选择集群**，选择需要监控的集群。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-alerts/01-view-an-alert-list.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-alerts/01-view-an-alert-list.adoc new file mode 100644 index 000000000..3684003c5 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-alerts/01-view-an-alert-list.adoc @@ -0,0 +1,45 @@ +--- +title: "查看告警列表" +keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心, 告警管理, 告警, 查看告警列表" +description: "介绍如何在 Whizard 可观测中心查看全局告警列表。" +weight: 01 +--- + +:ks_permission: **告警查看** +:ks_navigation: **告警管理 > 告警** + + +本节介绍如何在 Whizard 可观测中心查看全局告警列表。 + +Whizard 可观测中心的**告警**页面显示系统根据全局告警规则组生成的告警，不包括系统根据集群和项目告警规则组生成的告警。 + + +== 前提条件 + +您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 + +== 操作步骤 + +include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] + ++ + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 + ++ + +include::../../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_custom/clusterManagement/alerts/alerts-oper-openListPage.adoc[] ++ +==== +include::../../../../../../_custom/clusterManagement/alerts/alerts-para-alertingMessageList.adoc[] + +include::../../../../../../_custom/clusterManagement/alerts/alerts-oper-searchForAlertingMessages_new.adoc[] + +include::../../../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../../../_ks_components/oper-customizeColumns.adoc[] +==== \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-alerts/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-alerts/_index.adoc new file mode 100644 index 000000000..bd2f7c882 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/01-alerts/_index.adoc @@ -0,0 +1,13 @@ +--- +title: "告警" +keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心, 告警管理, 告警" +description: "介绍如何在 Whizard 可观测中心使用告警功能。" +weight: 01 +--- + + + +本节介绍如何在 Whizard 可观测中心使用告警功能。 + +Whizard 可观测中心的**告警**页面显示系统根据全局规则组生成的全局告警。当全局告警规则组中设置的指标满足预设的条件和持续时间时，系统将生成告警。当指标不再满足预设的条件时，告警将被系统自动清除。 + diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/01-create-a-rule-group.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/01-create-a-rule-group.adoc new file mode 100644 index 000000000..944e29630 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/01-create-a-rule-group.adoc @@ -0,0 +1,161 @@ +--- +title: "创建规则组" +keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 告警管理, 规则组, 创建规则组" +description: "介绍如何创建告警规则组。" +weight: 01 +--- + +:ks_permission: **规则组管理** +:ks_navigation: **监控告警 > 规则组** + + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-createAnAlertingPolicy.adoc[] + +[.admon.note,cols="a"] +|=== +|说明 + +| +{ks_product_right}仅支持创建自定义规则组，不支持创建内置规则组。 +|=== + +== 前提条件 + +* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 + +* 如需对应用程序的指标进行监控，您需要配置运行在容器中的应用程序，将符合 link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus 规范]的监控指标暴露在某个服务端路径下，并在用于暴露工作负载的服务上设置监控导出器，以声明提供应用程序监控指标的路径。有关更多信息，请参阅link:../../../../05-monitoring/08-edit-a-metrics-exporter/[编辑监控导出器]。 + + +== 操作步骤 + +include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] + ++ + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 + ++ + +include::../../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**规则组**页面，点击**自定义规则组**打开规则组列表。 + ++ + +include::../../../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-setBasicInfo.adoc[] + ++ + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-addAlertRule.adoc[] ++ +include::../../../../../../_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-commonParameters_new.adoc[] + +* 规则模板 ++ +-- +通过下拉列表选择监控目标和触发条件。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|监控目标 +|需要监控的集群节点或工作负载。 + +include::../../../../../../_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-triggerCondition.adoc[] +|=== +-- + +* 自定义规则 ++ +-- +通过 PromQL 表达式指定监控目标和触发条件。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群设置 +|选择需要监控的资源所在的集群。 + +include::../../../../../../_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-duration.adoc[] + +|告警级别 +| +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-para-alertLevel.adoc[] + +include::../../../../../../_custom/platformManagement/observabilityCenter/ruleGroups/ruleGroups-para-ruleExpression.adoc[] +|=== +-- + ++ + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-clickOK.adoc[] + +// == 创建规则组示例 +// 创建一个 Process Exporter 全局告警规则，以监控集群节点上的僵尸进程。当节点上有僵尸进程的时候，就会触发告警。 + +// 创建 Process Exporter 告警规则需要启⽤ Process Exporter 扩展组件。 + +// === 启用 Process Exporter 扩展组件 + +// . 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 + +// . 将光标悬停在页面右下角的image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18]图标，然后在菜单中选择 **kubectl**。 + +// . 在 **kubectl** 对话框，执行以下命令编辑集群配置文件： +// + +// -- +// // bash +// [,bash] +// ---- +// kubectl edit cc ks-installer -n kubesphere-system +// ---- +// -- + +// . 在集群配置文件中，将 **spec.monitoring.process_exporter.enabled** 参数设置为 **true**，然后保存文件。## 此处未找到，其他部分已确认 ok +// + +// -- +// // YAML +// [,yaml] +// ---- +// spec: +// monitoring: +// process_exporter: +// enabled: true +// ---- + +// // Note +// include::../../../../../../../_ks_components/admonitions/note.adoc[] + +// include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-desc-waitForExtensionEnabled.adoc[] + +// include::../../../../../../../_ks_components/admonitions/admonEnd.adoc[] +// -- + +// === 创建 Process Exporter 规则组 + +// . 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 +// . 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 +// . 在左侧导航栏选择**监控告警 > 规则组**。 +// . 在**规则组**页面，点击**自定义规则组**打开规则组列表。 +// . 在页面点击**创建**。 +// . 在**基本信息**页签，设置规则组的基本信息，然后点击**下一步**。 +// . 在**告警规则**页签，点击**添加告警规则**，选择**自定义规则**。 +// . 配置**集群设置**、**规则名称**、**告警级别**、**概要**。 +// . 在**告警规则表达式**下填写此表达式： +// + +// -- +// // bash +// [,bash] +// ---- +// sum by (cluster, job, instance, groupname)(namedprocess_namegroup_states{state="Zombie"}) > 0 +// ---- +// -- +// include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-clickOK.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/02-view-a-rule-group-list.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/02-view-a-rule-group-list.adoc new file mode 100644 index 000000000..2cb33f9f1 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/02-view-a-rule-group-list.adoc @@ -0,0 +1,56 @@ +--- +title: "查看规则组列表" +keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心, 告警管理, 规则组, 查看规则组列表" +description: "介绍如何查看告警规则组列表。" +weight: 02 +--- + +:ks_permission: **规则组查看** +:ks_navigation: **告警管理 > 规则组** + + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-viewAnAlertingPolicyList.adoc[] + + +== 前提条件 + +您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 + + +== 操作步骤 + +include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] + ++ + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 + ++ + +include::../../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc[] ++ +==== +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-para-alertingPolicyList_whizard.adoc[] + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-searchForAlertingPolicies.adoc[] + +include::../../../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../../../_ks_components/oper-customizeColumns.adoc[] +==== + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +* 当添加或移除集群时，规则组列表的集群列信息不会同步更新。 + +* 移除集群时，也不会将仅适用该集群的规则组自动删除。 + +|=== \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/03-view-rule-group-details.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/03-view-rule-group-details.adoc new file mode 100644 index 000000000..b20b388d3 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/03-view-rule-group-details.adoc @@ -0,0 +1,39 @@ +--- +title: "查看规则组详情" +keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心, 告警管理, 规则组, 查看规则组详情" +description: "介绍如何查看规则组详情。" +weight: 03 +--- + +:ks_permission: **规则组查看** +:ks_menu: **平台管理 > Whizard 可观测中心** +:ks_navigation: **告警管理 > 规则组** + + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-viewAlertingPolicyDetails.adoc[] + + +== 前提条件 + +您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 + + +== 操作步骤 + +include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] + ++ + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 + ++ + +include::../../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openDetailsPage.adoc[] + ++ + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-viewAlertingPolicyDetails.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/04-edit-rule-group-information.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/04-edit-rule-group-information.adoc new file mode 100644 index 000000000..59a6fb960 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/04-edit-rule-group-information.adoc @@ -0,0 +1,43 @@ +--- +title: "编辑规则组信息" +keywords: "Kubernetes, {ks_product}, 平台管理, Whizard , 告警管理, 规则组, 编辑告警规则" +description: "介绍如何编辑告警规则组的信息。" +weight: 04 +--- + + +:ks_permission: **规则组管理** +:ks_navigation: **告警管理 > 规则组** + + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-editRuleGroupInformation.adoc[] + + +== 前提条件 + +您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 + + +== 操作步骤 + +include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] + ++ + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 + ++ + +include::../../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc[] + ++ + +. 在需要编辑的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + ++ + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-editRuleGroupInformation.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/05-edit-alert-rules.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/05-edit-alert-rules.adoc new file mode 100644 index 000000000..d829d9950 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/05-edit-alert-rules.adoc @@ -0,0 +1,39 @@ +--- +title: "编辑告警规则" +keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心, 告警管理, 规则组, 编辑告警规则" +description: "介绍如何编辑告警规则组中的告警规则。" +weight: 05 +--- + +:ks_permission: **规则组管理** +:ks_menu: **平台管理 > Whizard 可观测中心** +:ks_navigation: **告警管理 > 规则组** + + +本节介绍如何编辑规则组中的告警规则。 + + +== 前提条件 + +您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 + + +== 操作步骤 + +include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] + ++ + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 + ++ + +include::../../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-editAnAlertingPolicy.adoc[] + ++ + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-editAlertRules.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/06-disable-and-enable-rule-groups.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/06-disable-and-enable-rule-groups.adoc new file mode 100644 index 000000000..c30fa6b15 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/06-disable-and-enable-rule-groups.adoc @@ -0,0 +1,62 @@ +--- +title: "禁用和启用规则组" +keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 规则组, 禁用和启用规则组" +description: "介绍如何禁用和启用告警规则组。" +weight: 06 +--- + + +:ks_permission: **规则组管理** +:ks_menu: **平台管理 > Whizard 可观测中心** +:ks_navigation: **监控告警 > 规则组** + + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-desc-disableAndEnablerRuleGroups.adoc[] + + +== 前提条件 + +您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 + + + +== 禁用和启用单个规则组 + +include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] + ++ + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 + ++ + +include::../../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc[] + ++ + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableASingleRuleGroup.adoc[] + + +== 批量禁用和启用规则组 + +include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] + ++ + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 + ++ + +include::../../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-openListPage.adoc[] + ++ + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-disableAndEnableMultipleRuleGroups.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/07-delete-rule-groups.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/07-delete-rule-groups.adoc new file mode 100644 index 000000000..682370aeb --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/07-delete-rule-groups.adoc @@ -0,0 +1,68 @@ +--- +title: "删除自定义规则组" +keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 告警管理, 规则组, 删除规则组" +description: "介绍如何删除告警规则组。" +weight: 07 +--- + +:ks_permission: **规则组管理** +:ks_menu: **平台管理 > Whizard 可观测中心** +:ks_navigation: **监控告警 > 规则组** + + +本节介绍如何删除告警规则组。 + +[.admon.note,cols="a"] +|=== +|说明 + +| +{ks_product_right}仅支持删除自定义规则组，不支持删除内置规则组。您可以重置内置规则组。 +|=== + +[.admon.warning,cols="a"] +|=== +|警告 + +| +规则组删除后不能恢复，请谨慎执行此操作。 +|=== + + +== 前提条件 + +您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 + + +== 删除单个规则组 + +include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] + ++ + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 + ++ + +include::../../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-deleteASingleAlertingPolicy.adoc[] + + +== 批量删除规则组 + +include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] + ++ + +include::../../../../../../../_ks_components/oper-selectMenu.adoc[] + ++ + +include::../../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-oper-deleteMultipleAlertingPolicies.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/08-reset-built-in-rule-groups.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/08-reset-built-in-rule-groups.adoc new file mode 100644 index 000000000..fd6f6050c --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/08-reset-built-in-rule-groups.adoc @@ -0,0 +1,58 @@ +--- +title: "重置内置规则组" +keywords: "Kubernetes, {ks_product}, 集群管理, 监控告警, 告警管理, 规则组, 删除规则组" +description: "介绍如何删重置内置规则组。" +weight: 08 +--- + +:ks_permission: **规则组管理** +:ks_menu: **平台管理 > Whizard 可观测中心** +:ks_navigation: **监控告警 > 规则组** + + +本节介绍如何重置内置规则组。 + +[.admon.note,cols="a"] +|=== +|说明 + +| +{ks_product_right}仅支持重置内置规则组，不支持重置自定义规则组。 +|=== + +[.admon.warning,cols="a"] +|=== +|警告 + +| +规则组重置后不能恢复，请谨慎执行此操作。 +|=== + + + + +== 前提条件 + +您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../../05-users-and-roles/02-platform-roles/[平台角色]。 + + +== 操作步骤 + +include::../../../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] + ++ + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 + ++ + +include::../../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**规则组**页面，点击**内置规则组**打开规则组列表。 + +. 在需要重置的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**重置**。 + +. 在**重置规则组**对话框，点击**确定**。 + diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/_index.adoc new file mode 100644 index 000000000..3553e8613 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/02-rule-groups/_index.adoc @@ -0,0 +1,11 @@ +--- +title: "规则组" +keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心, 告警管理, 规则组" +description: "介绍如何在 Whizard 可观测中心使用告警规则组功能。" +weight: 02 +--- + + +本节介绍如何在 Whizard 可观测中心创建、编辑、启用、禁用和查看全局告警规则组。 + +您可以在 Whizard 可观测中心的**规则组**页面创建全局告警规则组。区别于用户在集群和项目中创建的规则组，全局规则可用于监控平台管理的所有集群的资源。Whizard 可观测中心的**规则组**页面提供内置的规则组，同时也支持自定义规则组。您可以通过规则组使系统在特定监控指标满足预设条件和持续时间时生成告警。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/_index.adoc new file mode 100644 index 000000000..786ed57a6 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/05-alert-management/_index.adoc @@ -0,0 +1,9 @@ +--- +title: "告警管理" +keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心, 告警管理" +description: "介绍如何在 Whizard 可观测中心使用告警规则组功能。" +weight: 05 +--- + + +本节介绍如何在 Whizard 可观测中心管理全局告警和全局规则组。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/07-set-alert-components.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/07-set-alert-components.adoc new file mode 100644 index 000000000..ec3c66acc --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/07-set-alert-components.adoc @@ -0,0 +1,148 @@ +--- +title: "设置组件" +keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心, 设置组件" +description: "介绍如何设置 Whizard 组件。" +weight: 07 +--- + +:ks_menu: **平台管理 > Whizard 可观测中心** + + +本节介绍如何设置 Whizard 可观测中心的组件。 + + +== 前提条件 + +您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../05-users-and-roles/01-users/[用户]和link:../../../../05-users-and-roles/02-platform-roles/[平台角色]。 + + +== 操作步骤 + +include::../../../../_custom/platformManagement/extensionManagement/extensionManagement-oper-logInAsPlatformAdmin.adoc[] + ++ + +. 在页面右上角点击image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，选择 **Whizard 可观测中心**。 + ++ + +. 在页面右侧，点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**组件设置**页面。 + + +. 在**数据接入**页签，设置以下参数。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|网关设置 +| + +* 组件副本数量: 设置存储网关组件的副本数量，默认值为 2。 + +* 容器配额: 设置 CPU 预留和限制以及内存预留和上限。 + +|数据路由 +| + +* 数据保留副本数量: 设置数据保留组件的副本数量，默认值为 1。 + +* 组件副本数量: 设置数据路由组件的副本数量，默认值为 2。 + +* 容器配额: 设置 CPU 预留和限制以及内存预留和上限。 + +|本地存储 +| + +* 本地数据存储时间: 设置本地数据的存储时间，最小时间必须大于 3 天，默认为 7 天。 + +* 组件副本数量: 设置本地存储组件的副本数量，默认值为 2。 + +* 容器配额: 设置 CPU 预留和限制以及内存预留和上限。 +|=== +-- + +. 在**数据查询**页签，设置以下参数。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|基础设置 +| + +* 组件副本数量: 设置 Query 组件的副本数量，默认值为 2。 + +* 容器配额: 设置 CPU 预留和限制以及内存预留和上限。 + +|缓存设置 +| + +* 组件副本数量: 设置 Cache 组件的副本数量，默认值为 2。 + +* 容器配额: 设置 CPU 预留和限制以及内存预留和上限。 + +|=== +-- + +. 在**长期存储**页签，点击**启用**启用长期存储组件。启用后，您可以配置对象存储、网关、保留周期与降采样的组件参数。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|对象存储 +| + +* Bucket 名称：S3 对象存储桶的名称。 + +* 区域：您创建 Bucket 的地理区域。 + +* 端点：要连接的 AWS S3 对象存储地址。 + +* Access Key：与 AWS 访问密钥 ID 相关联的密钥。 + +* Secret Key：与 AWS Access Key ID 关联的密钥。 + +**高级设置** + +* HTTP 协议：决定是否开启不安全的 HTTP 协议。 + +* 添加存储类：为对象存储添加用户元数据。开启后需要为对象存储参数添加键值。 + +* HTTP 配置：配置接收方用于与基于 HTTP 的 API 服务通信的 HTTP 客户端。 + +** TLS 证书：开启是否通过提交数字证书证明您的身份或表明您有权访问在线服务。 + +** TLS 连接 + +*** CA 证书：用于验证服务器证书的 CA 文件。 + +*** Cert 文件：用于向服务器进行客户端证书身份验证的证书文件。 + +*** 密钥：用于向服务器进行客户端证书身份验证的密钥文件。 + +*** 服务器名称：ServerName 扩展以指示服务器的名称。 + +*** 服务器证书验证：是否通过提交数字证书证明您的身份或表明您有权访问在线服务。 + +|存储网关 +|设置 CPU 预留和限制以及内存预留和上限。 + +|压缩及降采样 +| + +* 原始数据存储时间：原始数据存储时间，超过此时间将删除原始数据。 + +* 5m 降采样数据存储时间：指定降采样到数据点 5 分钟间隔的数据存储时间。 + +* 1h 降采样数据存储时间：指定降采样到数据点 5 分钟间隔的数据存储时间。 + +* 容器配额：设置 CPU 预留和限制以及内存预留和上限。 +|=== +-- + +. 在**规则计算**页签，设置容器配额。设置完成后，点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/_index.adoc new file mode 100644 index 000000000..297d2b06c --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/07-whizard/_index.adoc @@ -0,0 +1,15 @@ +--- +title: "Whizard 可观测中心" +keywords: "Kubernetes, {ks_product}, 平台管理, Whizard 可观测中心" +description: "介绍如何使用 Whizard 可观测中心功能。" +weight: 07 +--- + + +本节介绍如何使用 Whizard 可观测中心。 + +Whizard 可观测中心功能提供了跨集群的资源监控和告警信息。您可以在 Whizard 可观测中心查看所有集群的汇总监控数据和每个集群的具体监控数据，同时可以在平台层级创建全局告警规则组并查看系统生成的全局告警。 + +link:01-enable-whizard/[启用 Whizard 可观测中心]后，点击{ks_product_both}平台顶部导航栏上的image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，点击 **Whizard 可观测中心**，进入该组件的概览页面。 + + diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/01-create-rules.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/01-create-rules.adoc new file mode 100644 index 000000000..01c973f13 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/01-create-rules.adoc @@ -0,0 +1,193 @@ +--- +title: "创建告警规则" +weight: 01 +--- + +本节介绍如何为 Kubernetes 原生事件和 Kubernetes/KubeSphere 审计事件定义告警规则。 + +== 前提条件 + +* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。 + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 事件告警**扩展组件。 + +== 操作步骤 + +. 在任意集群节点上，创建一个 yaml 文件，为该集群定义事件和审计的告警规则。 ++ +-- +点击link:../02-example-rules[此处]查看完整的告警规则示例。简单示例如下： + +[,yaml] +---- +apiVersion: logging.whizard.io/v1alpha1 +kind: ClusterRuleGroup +metadata: + name: example-auditing-rule + namespace: kubesphere-logging-system +spec: + type: auditing + rules: + - desc: all action not need to be audit + expr: + kind: list + list: + - get + - list + - watch + name: ignore-action + - desc: all operator need to be audit + expr: + kind: list + list: + - create + - delete + - update + - patch + name: action + - desc: pod + expr: + kind: macro + macro: ObjectRef.Resource="pods" + name: pod + - desc: service + expr: + kind: macro + macro: ObjectRef.Resource="services" + name: service + - desc: the alias of the user related to audit event + expr: + alias: User.username + kind: alias + name: user +---- + +告警规则目前支持两种类型：审计和事件。在 `spec.type` 下配置不同类型的告警规则，如 `type: auditing` 或 `type: events`。 + +告警规则的设置项如下： +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|`name` +| 规则名称。 + +|`desc` +| 规则描述。 + +|`expr.kind` +|规则类型，取值可以为 `rule`, `macro`, `list`, 或 `alias`。 + +|`expr.condition` +|日志的过滤表达式，以检查日志是否与规则匹配。可使用比较运算符（=，!=，<，<=，>，>=，contains，in，like，regexp）、布尔运算符（and，or 和 not）以及括号进行组合。 + +|`expr.macro` +| macro 的条件。 + +|`expr.list` +| list 的值。 + +|`expr.alias` +| alias 的值。 + +|`enable` +| 如果为 false，规则将不生效。 + +|`alerts.output` +| 指定在匹配事件发生时输出的消息。 + +|`alerts.annotations` +| 规则的注解，包含在匹配事件发生时输出的告警消息。 + +|`alerts.annotations.summary` +| 指定在匹配事件发生时输出的摘要消息。 + +|`alerts.annotations.summaryCn` +| 指定在匹配事件发生时输出的中文摘要消息。 + +|`alerts.severity` +| 规则的告警级别，取值可以为 INFO、WARNING、ERROR、或 CRITICAL。 +|=== + +**Macro** + +宏（Macro）是规则条件片段，可以在规则内部甚至其他宏中重复使用。宏提供了一种命名常见模式和消除规则冗余的方法。以下是一个宏的示例： + +[,yaml] +---- +apiVersion: logging.whizard.io/v1alpha1 +kind: ClusterRuleGroup +metadata: + name: macro-rule +spec: + type: auditing + rules: + - desc: pod + expr: + kind: macro + macro: ObjectRef.Resource="pods" + name: pod +---- + +[.admon.note,cols="a"] +|=== +|说明 + +| +宏可以在规则或其他宏中使用，例如 `${pod}` 或 `${alerting-rule.pod}` 。这两种方法的区别在于 `${pod}` 只能用于 `alerting-rule`，而 `${alerting-rule.pod}` 可以用于所有实例。宏也可用于 list 和 alias。 +|=== + +**list** + +列表（List）是可以包含在规则、宏或其他列表中的项目集合。与规则和宏不同，列表不能被解析为过滤表达式。以下是一个列表的示例： + +[,yaml] +---- +apiVersion: logging.whizard.io/v1alpha1 +kind: ClusterRuleGroup +metadata: + name: list-rule +spec: + type: alerting + rules: + - desc: all action not need to be audit + expr: + kind: list + list: + - get + - list + - watch + name: ignore-action +---- + +**Alias** + +别名（Alias）是过滤字段的缩写名称，它可以包含在规则、宏、列表和输出字符串中。以下是一个别名的示例： + +[,yaml] +---- +apiVersion: logging.whizard.io/v1alpha1 +kind: ClusterRuleGroup +metadata: + name: alias-rule +spec: + type: alerting + rules: + - desc: the alias of the user related to audit event + expr: + alias: User.username + kind: alias + name: user +---- +-- + +. 执行以下命令，创建 CRD（定制资源定义）。 ++ +[,bash] +---- +kubectl apply -f xxx.yaml # 注意替换 yaml 文件的名称 +---- + +. 运行成功后，在**集群管理 > 定制资源定义**页面搜索 **ClusterRuleGroup**。 + +. 点击 **ClusterRuleGroup** 进入详情页，在右侧页面查看、编辑或删除告警规则。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/02-example-rules.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/02-example-rules.adoc new file mode 100644 index 000000000..d60e68db4 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/02-example-rules.adoc @@ -0,0 +1,1106 @@ +--- +title: "告警规则示例" +weight: 02 +--- + +本节展示告警规则的示例文件。可参照示例，自定义事件和审计的告警规则，然后link:../01-create-rules[创建告警规则]。 + +== 事件告警规则示例 + +[,yaml] +---- +apiVersion: logging.whizard.io/v1alpha1 +kind: ClusterRuleGroup +metadata: + name: events-rules +spec: + type: events + rules: + - name: ContainerCreated + expr: + kind: rule + condition: type="Normal" and involvedObject.kind="Pod" and reason="Created" and involvedObject.fieldPath != "" + desc: create new container + enable: true + alerts: + severity: info + - name: ContainerStarted + expr: + kind: rule + condition: type="Normal" and involvedObject.kind="Pod" and reason="Started" and involvedObject.fieldPath != "" + desc: start new pod + alerts: + severity: warning + annotations: + summary: start new pod + summaryCn: 创建新容器 + enable: true + - name: ContainerFailed + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="Pod" and reason="Failed" and involvedObject.fieldPath != "" + desc: Create container failed + enable: true + alerts: + severity: warning + annotations: + summary: Container failed + summaryCn: 容器失败 + - name: ContainerKilling + expr: + kind: rule + condition: type="Normal" and involvedObject.kind="Pod" and reason="Killing" and involvedObject.fieldPath != "" + desc: container kill + enable: true + alerts: + severity: warning + annotations: + summary: container killing + summaryCn: 容器停止 + - name: ContainerPreempting + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="Pod" and reason="Preempting" + desc: container is preempting + alerts: + severity: warning + annotations: + summary: Container is preemting + summaryCn: 容器抢占中 + enable: true + - name: ContainerBackoff + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="Pod" and reason="BackOff" and involvedObject.fieldPath != "" and count>3 + desc: container back off + enable: true + alerts: + severity: warning + annotations: + summary: Container back-off + summaryCn: 容器回退 + - name: ContainerUnhealthy + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="Pod" and reason="Unhealthy" and count>3 + desc: container is unhealthy + alerts: + severity: warning + annotations: + summary: Container is unhealthy + summaryCn: 容器状态不良 + enable: true + - name: ContainerProbeWarning + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="Pod" and reason="ProbeWarning" and count>3 + desc: Warning to perform a probe to the container + alerts: + severity: warning + annotations: + summary: Warning to perform a probe to the container + summaryCn: 容器探测警告 + enable: true + - name: PodKillingExceededGracePeriod + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="Pod" and reason="ExceededGracePeriod" + desc: Pod killing exceeded specified grace period + enable: true + alerts: + severity: warning + annotations: + summary: Pod killing exceeded specified grace period + summaryCn: pod终止超时 + - name: PodKillFailed + expr: + kind: rule + condition: type="Warning" and reason="FailedKillPod" + desc: Warning to perform a probe to the container + enable: true + alerts: + severity: warning + annotations: + summary: Failed to kill pod + summaryCn: pod终止失败 + - name: PodContainerCreateFailed + expr: + kind: rule + condition: type="Warning" and reason="FailedCreatePodContainer" + desc: Failed to create pod container + enable: true + alerts: + severity: warning + annotations: + summary: Failed to create pod container + summaryCn: pod容器创建失败 + - name: PodFailed + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="Pod" and reason="Failed" and involvedObject.fieldPath="" + desc: Pod failed + enable: true + alerts: + severity: warning + annotations: + summary: Pod failed + summaryCn: pod失败 + - name: PodNetworkNotReady + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="Pod" and reason="NetworkNotReady" + desc: Pod network is not ready + enable: true + alerts: + severity: warning + annotations: + summary: Pod network is not ready + summaryCn: Pod网络异常 + - name: ImagePulling + expr: + kind: rule + condition: type="Normal" and involvedObject.kind="Pod" and reason="Pulling" + desc: pull images + enable: true + alerts: + severity: warning + - name: ImagePulled + expr: + kind: rule + condition: type="Normal" and involvedObject.kind="Pod" and reason="Pulled" + desc: images pulled + enable: true + alerts: + severity: warning + - name: ImagePullPolicyError + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="Pod" and reason="ErrImageNeverPull" + desc: Wrong image pull policy + enable: true + alerts: + severity: warning + annotations: + summary: Wrong image pull policy + summaryCn: 镜像拉取策略错误 + - name: ImageInspectFailed + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="Pod" and reason="InspectFailed" + desc: Failed to inspect image + enable: true + alerts: + severity: warning + annotations: + summary: Failed to inspect image + summaryCn: 镜像检查失败 + - name: NodeReady + expr: + kind: rule + condition: type="Normal" and involvedObject.kind="Node" and reason="NodeReady" + desc: Pod network is not ready + enable: true + alerts: + severity: warning + - name: NodeSchedulable + expr: + kind: rule + condition: type="Normal" and involvedObject.kind="Node" and reason="NodeSchedulable" + desc: node is schedulable + enable: true + alerts: + severity: warning + - name: NodeNotSchedulable + expr: + kind: rule + condition: type="Normal" and involvedObject.kind="Node" and reason="NodeNotSchedulable" + desc: node is not schedulable + enable: true + alerts: + severity: warning + - name: KubeletStarting + expr: + kind: rule + condition: type="Normal" and involvedObject.kind="Node" and reason="Starting" + desc: kubelet is starting + enable: true + alerts: + severity: warning + - name: KubeletSetupFailed + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="Node" and reason="KubeletSetupFailed" + desc: Failed to setup kubelet + enable: true + alerts: + severity: warning + annotations: + summary: Failed to setup kubelet + summaryCn: kubelet安装失败 + - name: VolumeAttachFailed + expr: + kind: rule + condition: type="Warning" and reason="FailedAttachVolume" + desc: Failed to attach volume + enable: true + alerts: + severity: warning + annotations: + summary: Failed to attach volume + summaryCn: 存储卷装载失败 + - name: VolumeMountFailed + expr: + kind: rule + condition: type="Warning" and reason="FailedMount" + desc: Failed to mount volume + enable: true + alerts: + severity: warning + annotations: + summary: Failed to mount volume + summaryCn: 存储卷挂载失败 + - name: VolumeResizeFailed + expr: + kind: rule + condition: type="Warning" and reason="VolumeResizeFailed" + desc: Failed to expand/reduce volume + enable: true + alerts: + severity: warning + annotations: + summary: Failed to expand/reduce volume + summaryCn: 存储卷扩缩容失败 + - name: VolumeResizeSuccess + expr: + kind: rule + condition: type="Normal" and reason="VolumeResizeSuccessful" + desc: volume resize success + enable: true + alerts: + severity: warning + - name: FileSystemResizeFailed + expr: + kind: rule + condition: type="Warning" and reason="FileSystemResizeFailed" + desc: failed to expand/reduce file system + enable: true + alerts: + severity: warning + annotations: + summary: Failed to expand/reduce file system + summaryCn: 文件系统扩缩容失败 + - name: FileSystemResized + expr: + kind: rule + condition: type="Normal" and reason="FileSystemResizeSuccessful" + desc: File system resize success + enable: true + alerts: + severity: warning + - name: VolumeMapFailed + expr: + kind: rule + condition: type="Warning" and reason="FailedMapVolume" + desc: Failed to map volume + enable: true + alerts: + severity: warning + annotations: + summary: Failed to map volume + summaryCn: 存储卷映射失败 + - name: VolumeAlreadyMounted + expr: + kind: rule + condition: type="Warning" and reason="AlreadyMountedVolume" + desc: Volume is already mounted + enable: true + alerts: + severity: warning + annotations: + summary: Volume is already mounted + summaryCn: 存储卷已被挂载 + - name: VolumeAttached + expr: + kind: rule + condition: type="Normal" and reason="SuccessfulAttachVolume" + desc: Volume is attached + enable: true + alerts: + severity: warning + - name: VolumeMounted + expr: + kind: rule + condition: type="Normal" and reason="SuccessfulMountVolume" + desc: volume is mounted + enable: true + alerts: + severity: warning + - name: NodeRebooted + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="Node" and reason="Rebooted" + desc: Node Rebooted + enable: true + alerts: + severity: warning + annotations: + summary: Node Rebooted + summaryCn: 节点重启 + - name: ContainerGCFailed + expr: + kind: rule + condition: type="Warning" and reason="ContainerGCFailed" + desc: Container GC failed + enable: true + alerts: + severity: warning + annotations: + summary: Container GC failed + summaryCn: 容器GC失败 + - name: ImageGCFailed + expr: + kind: rule + condition: type="Warning" and reason="ImageGCFailed" + desc: Image GC failed + enable: true + alerts: + severity: warning + annotations: + summary: Image GC failed + summaryCn: 镜像GC失败 + - name: NodeAllocatableEnforcementFailed + expr: + kind: rule + condition: type="Warning" and reason="FailedNodeAllocatableEnforcement" + desc: Node allocatable enforcement failed + enable: true + alerts: + severity: warning + annotations: + summary: Node allocatable enforcement failed + summaryCn: 节点可分配资源更新失败 + - name: NodeAllocatableEnforcedSuccess + expr: + kind: rule + condition: type="Normal" and involvedObject.kind="Node" and reason="NodeAllocatableEnforced" + desc: Node allocatable enforcement success + enable: true + alerts: + severity: warning + - name: SandboxChanged + expr: + kind: rule + condition: type="Normal" and reason="SandboxChanged" + desc: Sandbox changed + enable: true + alerts: + severity: warning + - name: SandboxCreateFailed + expr: + kind: rule + condition: type="Warning" and reason="FailedCreatePodSandBox" + desc: Failed to create sandbox + enable: true + alerts: + severity: warning + annotations: + summary: Failed to create sandbox + summaryCn: Sandbox创建失败 + - name: SandboxStatusFailed + expr: + kind: rule + condition: type="Warning" and reason="FailedPodSandBoxStatus" + desc: Failed to get sandbox status + enable: true + alerts: + severity: warning + annotations: + summary: Failed to get sandbox status + summaryCn: 获取Sandbox状态错误 + - name: DiskCapacityInvalid + expr: + kind: rule + condition: type="Warning" and reason="InvalidDiskCapacity" + desc: Invalid disk capacity + enable: true + alerts: + severity: warning + annotations: + summary: Invalid disk capacity + summaryCn: 磁盘容量配置不合法 + - name: DiskSpaceFreeFailed + expr: + kind: rule + condition: type="Warning" and reason="FreeDiskSpaceFailed" + desc: Failed to free disk space + enable: true + alerts: + severity: warning + annotations: + summary: Failed to free disk space + summaryCn: 磁盘空间释放失败 + - name: PodStatusSyncFailed + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="Pod" and reason="FailedSync" + desc: Failed To Sync Pod Status + enable: true + alerts: + severity: warning + annotations: + summary: Failed To Sync Pod Status + summaryCn: Pod状态同步失败 + - name: ConfigurationValidationFaile + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="Pod" and reason="FailedValidation" + desc: Configuration Validation Failed + enable: true + alerts: + severity: warning + annotations: + summary: Configuration Validation Failed + summaryCn: 配置验证失败 + - name: LifecycleHookPostStartFailed + expr: + kind: rule + condition: type="Warning" and reason="FailedPostStartHook" + desc: Failed to postStart LifecycleHook + enable: true + alerts: + severity: warning + annotations: + summary: Failed to postStart LifecycleHook + summaryCn: 容器启动后的生命周期钩子运行失败 + - name: LifecycleHookPreStopFailed + expr: + kind: rule + condition: type="Warning" and reason="FailedPreStopHook" + desc: Failed to preStop LifecycleHook + enable: true + alerts: + severity: warning + annotations: + summary: Failed to preStop LifecycleHook + summaryCn: 容器停止前的生命周期钩子运行失败 + - name: HPASelectorError + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="HorizontalPodAutoscaler" and reason in ("SelectorRequired","InvalidSelector") + desc: HPA selector error + enable: true + alerts: + severity: warning + annotations: + summary: HPA selector error + summaryCn: HPA选择器错误 + - name: HPAMetricError + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="HorizontalPodAutoscaler" and reason in ("FailedGetObjectMetric","InvalidMetricSourceType") + desc: Node allocatable enforcement failed + enable: true + alerts: + severity: warning + annotations: + summary: HPA metric error + summaryCn: HPA对象指标错误 + - name: HPAConvertFailed + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="HorizontalPodAutoscaler" and reason="FailedConvertHPA" + desc: Failed to convert HPA + enable: true + alerts: + severity: warning + annotations: + summary: Failed to convert HPA + summaryCn: HPA转换失败 + - name: HPAGetScaleFailed + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="HorizontalPodAutoscaler" and reason="FailedGetScale" + desc: Failed to get HPA scale + enable: true + alerts: + severity: warning + annotations: + summary: Failed to get HPA scale + summaryCn: HPA规模获取失败 + - name: HPAComputeReplicasFailed + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="HorizontalPodAutoscaler" and reason="FailedComputeMetricsReplicas" + desc: Failed to compute HPA replicas + enable: true + alerts: + severity: warning + annotations: + summary: Failed to compute HPA replicas + summaryCn: HPA副本计算失败 + - name: HPARescaleFailed + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="HorizontalPodAutoscaler" and reason="FailedRescale" + desc: Failed to rescale HPA size + enable: true + alerts: + severity: warning + annotations: + summary: Failed to rescale HPA size + summaryCn: HPA规模调整失败 + - name: HPARescaleSuccess + expr: + kind: rule + condition: type="Normal" and involvedObject.kind="HorizontalPodAutoscaler" and reason="SuccessfulRescale" + desc: Rescaled HPA size + enable: true + alerts: + severity: warning + - name: NodeSystemOOM + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="Node" and reason="SystemOOM" + desc: Node system OOM encountered + enable: true + alerts: + severity: warning + annotations: + summary: Node system OOM encountered + summaryCn: 节点内存溢出 + - name: VolumeBindingFailed + expr: + kind: rule + condition: type="Warning" and reason="FailedBinding" + desc: Volume binding failed + enable: true + alerts: + severity: warning + annotations: + summary: Volume binding failed + summaryCn: 存储卷绑定失败 + - name: VolumeMismatch + expr: + kind: rule + condition: type="Warning" and reason="VolumeMismatch" + desc: Volume Mismatch + enable: true + alerts: + severity: warning + annotations: + summary: Volume Mismatch + summaryCn: 存储卷不匹配 + - name: VolumeRecycleFailed + expr: + kind: rule + condition: type="Warning" and reason="VolumeFailedRecycle" + desc: Failed to recycle volume + enable: true + alerts: + severity: warning + annotations: + summary: Failed to recycle volume + summaryCn: 存储卷回收失败 + - name: VolumeRecycled + expr: + kind: rule + condition: type="Normal" and reason="VolumeRecycled" + desc: Volume Recycled + enable: true + alerts: + severity: warning + - name: VolumeRecyclerPodError + expr: + kind: rule + condition: type="Warning" and reason="RecyclerPod" + desc: Volume Recycler pod error + enable: true + alerts: + severity: warning + annotations: + summary: Volume Recycler pod error + summaryCn: 存储卷回收器错误 + - name: VolumeDeleted + expr: + kind: rule + condition: type="Normal" and reason="VolumeDelete" + desc: Volume Deleted + enable: true + alerts: + severity: warning + - name: VolumeDeleteFailed + expr: + kind: rule + condition: type="Warning" and reason="VolumeFailedDelete" + desc: Failed to delete volume + enable: true + alerts: + severity: warning + annotations: + summary: Failed to delete volume + summaryCn: 存储卷删除失败 + - name: VolumeProvisionFailed + expr: + kind: rule + condition: type="Warning" and reason="ProvisioningFailed" + desc: Failed to provision volume + enable: true + alerts: + severity: warning + annotations: + summary: Failed to provision volume + summaryCn: 存储申请失败 + - name: VolumeProvisioned + expr: + kind: rule + condition: type="Normal" and reason="ProvisioningSucceeded" + desc: Volume provisioned + enable: true + alerts: + severity: warning + - name: VolumeProvisionCleanupFailed + expr: + kind: rule + condition: type="Warning" and reason="ProvisioningCleanupFailed" + desc: Failed to clean up provision volume + enable: true + alerts: + severity: warning + annotations: + summary: Failed to clean up provision volume + summaryCn: 清理存储失败 + - name: VolumeExternalExpandingError + expr: + kind: rule + condition: type="Warning" and reason="ExternalExpanding" + desc: Error for volume external expanding + enable: true + alerts: + severity: warning + annotations: + summary: Error for volume external expanding + summaryCn: 存储外部扩展错误 + - name: PodScheduleFailed + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="Pod" and reason="FailedScheduling" + desc: Failed to schedule pod + enable: true + alerts: + severity: warning + annotations: + summary: Failed to schedule pod + summaryCn: pod调度失败 + - name: PodSchedulePreempted + expr: + kind: rule + condition: type="Normal" and involvedObject.kind="Pod" and reason="Preempted" + desc: Pod preempted + enable: true + alerts: + severity: warning + - name: PodScheduled + expr: + kind: rule + condition: type="Normal" and involvedObject.kind="Pod" and reason="Scheduled" + desc: Pod scheduled + enable: true + alerts: + severity: warning + - name: PodCreateFailed + expr: + kind: rule + condition: type="Warning" and involvedObject.kind in ("Pod","ReplicaSet","DaemonSet","StatefulSet","Job") and reason="FailedCreate" + desc: Failed to create pod + enable: true + alerts: + severity: warning + annotations: + summary: Failed to create pod + summaryCn: pod创建失败 + - name: PodCreated + expr: + kind: rule + condition: type="Normal" and involvedObject.kind in ("Pod","ReplicaSet","DaemonSet","StatefulSet","Job") and reason="SuccessfulCreate" + desc: pod created + enable: true + alerts: + severity: warning + - name: PodDeleteFailed + expr: + kind: rule + condition: type="Warning" and involvedObject.kind in ("Pod","ReplicaSet","DaemonSet","StatefulSet","Job") and reason="FailedDelete" + desc: Failed to delete pod + enable: true + alerts: + severity: warning + annotations: + summary: Failed to delete pod + summaryCn: pod删除失败 + - name: PodDeleted + expr: + kind: rule + condition: type="Normal" and involvedObject.kind in ("Pod","ReplicaSet","DaemonSet","StatefulSet","Job") and reason="SuccessfulDelete" + desc: pod deleted + enable: true + alerts: + severity: warning + - name: ReplicaSetCreateError + expr: + kind: rule + condition: type="Warning" and reason="ReplicaSetCreateError" + desc: Error to create replica set for deployment + enable: true + alerts: + severity: warning + annotations: + summary: Error to create replica set for deployment + summaryCn: 副本集创建错误 + - name: DeploymentRollbackFailed + expr: + kind: rule + condition: type="Warning" and reason in("DeploymentRollbackRevisionNotFound","DeploymentRollbackTemplateUnchanged") + desc: Failed to rollback deployment + enable: true + alerts: + severity: warning + annotations: + summary: Failed to rollback deployment + summaryCn: 部署回滚失败 + - name: DeploySelectorAll + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="Deployment" and reason="SelectingAll" + desc: The deploy is selecting all pods + enable: true + alerts: + severity: warning + annotations: + summary: The deploy is selecting all pods + summaryCn: deploy选择了所有pod + - name: DaemonSelectorAll + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="DaemonSet" and reason="SelectingAll" + desc: The daemon set is selecting all pods + enable: true + alerts: + severity: warning + annotations: + summary: The daemon set is selecting all pods + summaryCn: daemonset选择了所有pod + - name: DaemonPodFailed + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="DaemonSet" and reason in ("FailedDaemonPod","FailedPlacement") + desc: Failed daemon pod + enable: true + alerts: + severity: warning + annotations: + summary: Failed daemon pod + summaryCn: daemonset的pod失败 + - name: LoadBalancerSyncFailed + expr: + kind: rule + condition: type="Warning" and reason="SyncLoadBalancerFailed" + desc: Error syncing load balancer + enable: true + alerts: + severity: warning + annotations: + summary: Error syncing load balancer + summaryCn: 负载据衡器不可用 + - name: LoadBalancerDeleting + expr: + kind: rule + condition: type="Normal" and reason="DeletingLoadBalancer" + desc: LoadBalancer is deleting + enable: true + alerts: + severity: warning + - name: LoadBalancerEnsuring + expr: + kind: rule + condition: type="Normal" and reason="EnsuringLoadBalancer" + desc: LoadBalancer is ensuring + enable: true + alerts: + severity: warning + - name: LoadBalancerEnsured + expr: + kind: rule + condition: type="Normal" and reason="EnsuredLoadBalancer" + desc: LoadBalancer is ensured + enable: true + alerts: + severity: warning + - name: LoadBalancerUnAvailable + expr: + kind: rule + condition: type="Warning" and reason="UnAvailableLoadBalancer" + desc: Load balancer is not available + enable: true + alerts: + severity: warning + annotations: + summary: Load balancer is not available + summaryCn: 负载据衡器不可用 + - name: LoadBalancerUpdated + expr: + kind: rule + condition: type="Normal" and reason="UpdatedLoadBalancer" + desc: LoadBalancer is updated + enable: true + alerts: + severity: warning + - name: LoadBalancerUpdateFailed + expr: + kind: rule + condition: type="Warning" and reason="UpdateLoadBalancerFailed" + desc: Failed to update load balancer + enable: true + alerts: + severity: warning + annotations: + summary: Failed to update load balancer + summaryCn: 更新负载据衡器失败 + - name: LoadBalancerDeleting + expr: + kind: rule + condition: type="Normal" and reason="DeletingLoadBalancer" + desc: Failed To Sync Pod Status + enable: true + alerts: + severity: warning + - name: LoadBalancerDeleted + expr: + kind: rule + condition: type="Normal" and reason="DeletedLoadBalancer" + desc: LoadBalancer is deleted + enable: true + alerts: + severity: warning + - name: VolumeDeleted + expr: + kind: rule + condition: type="Normal" and reason="VolumeDelete" + desc: Volume is deleted + enable: true + alerts: + severity: warning + - name: LoadBalancerDeleteFailed + expr: + kind: rule + condition: type="Warning" and reason="DeleteLoadBalancerFailed" + desc: Failed to delete load balancer + enable: true + alerts: + severity: warning + annotations: + summary: Failed to delete load balancer + summaryCn: 负载据衡器删除失败 + - name: JobGetFailed + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="CronJob" and reason="FailedGet" + desc: Failed to get job + enable: true + alerts: + severity: warning + annotations: + summary: Failed to get job + summaryCn: 任务获取失败 + - name: JobCreated + expr: + kind: rule + condition: type="Normal" and involvedObject.kind="CronJob" and reason="SuccessfulCreate" + desc: job is created + enable: true + alerts: + severity: warning + - name: JobCreateFailed + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="CronJob" and reason="FailedCreate" + desc: Failed to create job + enable: true + alerts: + severity: warning + annotations: + summary: Failed to create job + summaryCn: 任务创建失败 + - name: JobDeleted + expr: + kind: rule + condition: type="Normal" and involvedObject.kind="CronJob" and reason="SuccessfulDelete" + desc: job is deleted + enable: true + alerts: + severity: warning + - name: JobDeleteFailed + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="CronJob" and reason="FailedDelete" + desc: Failed to delete job + enable: true + alerts: + severity: warning + annotations: + summary: Failed to delete job + summaryCn: 任务删除失败 + - name: JobCompleted + expr: + kind: rule + condition: type="Normal" and involvedObject.kind="CronJob" and reason="SawCompletedJob" + desc: job is completed + enable: true + alerts: + severity: warning + - name: JobUnexpected + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="CronJob" and reason="UnexpectedJob" + desc: CronJob saw unexpected job + enable: true + alerts: + severity: warning + annotations: + summary: CronJob saw unexpected job + summaryCn: 任务非预期 + - name: JobMissing + expr: + kind: rule + condition: type="Normal" and involvedObject.kind="CronJob" and reason="MissingJob" + desc: CronJob missed expected job + enable: true + alerts: + severity: warning + - name: JobScheduleFailed + expr: + kind: rule + condition: type="Warning" and involvedObject.kind="CronJob" and reason in ("MissSchedule","FailedNeedsStart") + desc: CronJob failed to schedule job + enable: true + alerts: + severity: warning + annotations: + summary: CronJob failed to schedule job + summaryCn: 任务调度失败 +---- + +== 审计告警规则示例 + + +[,yaml] +---- +apiVersion: logging.whizard.io/v1alpha1 +kind: ClusterRuleGroup +metadata: + name: auditing-rules +spec: + type: auditing + rules: + - name: ignore-action + expr: + kind: list + list: + - get + - list + - watch + desc: all action not need to be audit + - name: action + expr: + kind: list + list: + - create + - delete + - update + - patch + desc: all operator need to be audit + - name: pod + expr: + kind: macro + macro: ObjectRef.Resource="pods" + desc: pod + - name: service + expr: + kind: macro + macro: ObjectRef.Resource="services" + desc: service + - name: user + expr: + kind: alias + alias: User.username + desc: the alias of the user related to audit event + - name: name + expr: + kind: alias + alias: ObjectRef.Name + desc: the alias of the resource name + - name: namespace + expr: + kind: alias + alias: ObjectRef.Namespace + desc: the alias of the resource namespace + - name: create + expr: + kind: macro + macro: Verb = "create" + desc: create operator + - name: ResourceChange + expr: + kind: rule + condition: Verb in ${action} + desc: audit the change of resource + enable: true + alerts: + severity: info + - name: CreateHostNetworkPod + expr: + kind: rule + condition: ${pod} and ${create} and RequestObject.spec.hostNetwork = true + desc: Detect an attempt to start a pod using the host network + alerts: + severity: warning + annotations: + summary: creat hostNetwork pod + summaryCn: 创建 hostNetwork 容器 + message: ${user} ${Verb} HostNetwork Pod ${name} in Namespace ${namespace}. + enable: true + - name: CreateHostportPod + expr: + kind: rule + condition: ${pod} and ${create} and (RequestObject.spec.containers[*].ports[*].hostPort > 0 or RequestObject.spec.initContainers[*].ports[*].hostPort > 0) + desc: Detect an attempt to start a pod mount to a host port + enable: true + alerts: + severity: warning + annotations: + summary: creat hostport pod + summaryCn: 创建 hostport 容器 + message: ${user} ${Verb} HostPort Pod ${name} in Namespace ${namespace}. + - name: CreateNodePortService + expr: + kind: rule + condition: ${service} and ${create} and RequestObject.spec.type = "NodePort" + desc: Detect an attempt to start a service with a NodePort service type + enable: true + alerts: + severity: warning + annotations: + summary: creat NodePort service + summaryCn: 创建 NodePort 服务 + message: ${user} ${Verb} NodePort Service ${name} in Namespace ${namespace}. + - name: AttachOrExecPod + expr: + kind: rule + condition: ${pod} and ${create} and ObjectRef.Subresource in ("exec", "attach") + desc: Detect any attempt to attach/exec to a pod + alerts: + severity: warning + annotations: + summary: attach or exec pod + summaryCn: 进入容器 + message: ${user} ${ObjectRef.Subresource} Pod ${name} in Namespace ${namespace}. +---- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/_index.adoc new file mode 100644 index 000000000..c5248166d --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/09-events-altering/_index.adoc @@ -0,0 +1,64 @@ +--- +title: "WhizardTelemetry 事件告警" +keywords: "Kubernetes, {ks_product}, 事件, 审计, 告警" +description: "介绍如何管理事件和审计的告警。" +weight: 09 +--- + +本节介绍如何使用“WhizardTelemetry 事件告警”扩展组件。 + +WhizardTelemetry 事件告警为 Kubernetes 原生事件和 Kubernetes/KubeSphere 审计事件定义告警规则，对传入的事件数据进行评估，并将告警发送到指定的接收器如 HTTP 端点等。 + +[.admon.attention,cols="a"] +|=== +|注意 + +| +- WhizardTelemetry 事件告警依赖于 WhizardTelemetry 数据流水线扩展组件发送过来的事件与审计数据。在使用前，请确保已安装并配置好该扩展组件。 +- 审计告警和事件告警功能默认启用，请确保已安装并配置好 WhizardTelemetry 事件管理和 WhizardTelemetry 审计管理扩展组件。 +|=== + + +**配置说明：** + +WhizardTelemetry 事件告警提供了多种自定义选项。以下是一些最常用的配置： + +- 审计告警和事件告警功能默认启用。若需禁用审计告警，请在扩展组件配置中将 `whizard-telemetry-ruler.auditingAlerting.enabled` 字段设置为 false。同样，若要停用事件告警，请将 `whizard-telemetry-ruler.eventsAlerting.enabled` 设置为 false。 ++ +[,yaml] +---- +whizard-telemetry-ruler: + auditingAlerting: + enabled: true + eventsAlerting: + enabled: true +---- + +- WhizardTelemetry 事件告警支持通过配置接收器将消息发送至 Webhook 和其他输出端口。您可根据需求进行配置。 ++ +-- +[,yaml] +---- +whizard-telemetry-ruler: + config: + sinks: + - name: alertmanager # sink 名称。 + type: webhook # sink 类型。 + config: + ### Please modify to your actual ip address. + url: http://:31093/api/v1/alerts # url 提供 Webhook 标准 URL 格式地址，必须明确指定一个 URL 或 service。 +---- +[.admon.note,cols="a"] +|=== +|说明 + +| +* 若使用 **WhizardTelemetry 通知管理**扩展组件发送告警消息，需将 WhizardTelemetry 事件告警的 `whizard-telemetry-ruler.config.sinks.config.url` 配置为 WhizardTelemetry 通知管理的 `alertmanager-proxy` 服务，该服务安装在 host 集群，以 NodePort 形式（默认 31093）暴露。 +alertmanager-proxy 默认的访问地址为 `http://:31093/api/v1/alerts`。 + +* 您也可以将 WhizardTelemetry 事件告警产生的告警发送到自己安装的 alertmanager 如 `http://:/api/v1/alerts`，或者自定义的 webhook。 + +|=== +-- + + diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/01-set-email-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/01-set-email-notification.adoc new file mode 100644 index 000000000..1c1792c07 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/01-set-email-notification.adoc @@ -0,0 +1,63 @@ +--- +title: "设置邮件通知" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置邮件通知" +description: "介绍如何设置邮件通知。" +weight: 01 +--- + +// :ks_menu: **平台管理 > 平台设置** +:ks_navigation: **通知管理 > 通知渠道** +:ks_permission: **平台设置管理** + + +本节介绍如何设置邮件通知。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**通知渠道**页面，点击**邮箱**页签，设置邮箱通知参数，然后点击**确定**。 ++ +-- +* 服务器设置 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|SMTP 服务器地址 +|SMTP 服务器的地址和端口号。 + +|使用 SSL 安全连接 +|是否启用 SSL 安全连接。 + +|SMTP 用户名 +|SMTP 服务器的登录用户名。 + +|SMTP 密码 +|SMTP 服务器的登录密码。 + +|发件人邮箱 +|用于发送通知的邮箱地址。 +|=== + +邮件的接收人设置可前往**通知订阅**页面进行设置。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/02-set-feishu-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/02-set-feishu-notification.adoc new file mode 100644 index 000000000..bedd42ce8 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/02-set-feishu-notification.adoc @@ -0,0 +1,74 @@ +--- +title: "设置飞书通知" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置飞书通知" +description: "介绍如何设置飞书通知。" +weight: 02 +--- + +// :ks_menu: **平台管理 > 平台设置** +:ks_navigation: **通知管理 > 通知渠道** +:ks_permission: **平台设置管理** + + +本节介绍如何设置飞书通知。 + +飞书通知功能支持通过以下两种方式向用户发送通知： + +* **会话设置**：使用飞书应用向特定用户或部门发送通知。 + +* **群机器人设置**：使用飞书机器人向特定群聊发送通知。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + +* 您需要提前从飞书平台获取应用或群机器人的访问参数。有关更多信息，请参阅link:https://open.feishu.cn/document/ukTMukTMukTM/uITNz4iM1MjLyUzM[飞书开发者文档]。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**通知渠道**页面，点击**飞书**页签，设置飞书通知参数，然后点击**确定**。 ++ +==== +* 会话设置 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|App ID +|飞书应用的 App ID。 + +|App Secret +|飞书应用的 App Secret。 + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sessionId.adoc[] +|=== +-- + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-groupChatBotSettings.adoc[] + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] +==== + +. 在**飞书**页签右上角，点击切换开关将飞书通知功能设置为**已启用**。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/03-set-dingtalk-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/03-set-dingtalk-notification.adoc new file mode 100644 index 000000000..0a6a7e61f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/03-set-dingtalk-notification.adoc @@ -0,0 +1,76 @@ +--- +title: "设置钉钉通知" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置钉钉通知" +description: "介绍如何设置钉钉通知。" +weight: 03 +--- + +// :ks_menu: **平台管理 > 平台设置** +:ks_navigation: **通知管理 > 通知渠道** +:ks_permission: **平台设置管理** + + +本节介绍如何设置钉钉通知。 + +钉钉通知功能支持通过以下两种方式向用户发送通知： + +* **会话设置**：使用钉钉应用向特定用户或部门发送通知。 + +* **群机器人设置**：使用钉钉机器人向特定群聊发送通知。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + +* 您需要提前从钉钉平台获取应用或群机器人的访问参数。有关更多信息，请参阅link:https://open.dingtalk.com/document/orgapp-server/how-to-call-apis[钉钉开发者文档]。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**通知渠道**页面，点击**钉钉**页签，设置钉钉通知参数，然后点击**确定**。 ++ +==== +* 会话设置 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|App Key +|钉钉应用的 AppKey。 + +|App Secret +|钉钉应用 App Secret。 + +|Chat ID +|接收通知的 Chat ID。点击**添加**可设置多个 Chat ID。 +|=== +-- + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-groupChatBotSettings.adoc[] + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] +==== + + +. 在**钉钉**页签右上角，点击切换开关将钉钉通知功能设置为**已启用**。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/04-set-wecom-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/04-set-wecom-notification.adoc new file mode 100644 index 000000000..542f95df9 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/04-set-wecom-notification.adoc @@ -0,0 +1,74 @@ +--- +title: "设置企业微信通知" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置企业微信通知" +description: "介绍如何设置企业微信通知。" +weight: 04 +--- + + +// :ks_menu: **平台管理 > 平台设置** +:ks_navigation: **通知管理 > 通知渠道** +:ks_permission: **平台设置管理** + + +本节介绍如何设置企业微信通知。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + +* 您需要提前从企业微信平台获取应用访问参数。有关更多信息，请参阅link:https://developer.work.weixin.qq.com/document/path/90664[企业微信开发者文档]。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**通知渠道**页面，点击**企业微信**页签，设置企业微信通知参数，然后点击**确定**。 ++ +==== +* 服务器设置 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|Corp ID +|您的企业在企业微信上的 Corp ID。 + +|Agent ID +|企业微信应用的 Agent ID。 + +|Secret +|企业微信应用的 Secret。 +|=== +-- + +* 接收设置 ++ +-- +设置接收通知的 User ID、Department ID 或 Tag ID。点击**添加**可设置多个 ID。 +-- + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] +==== + +. 在**企业微信**页签右上角，点击切换开关将企业微信通知功能设置为**已启用**。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/05-set-slack-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/05-set-slack-notification.adoc new file mode 100644 index 000000000..299a235a3 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/05-set-slack-notification.adoc @@ -0,0 +1,62 @@ +--- +title: "设置 Slack 通知" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置 Slack 通知" +description: "介绍如何设置 Slack 通知。" +weight: 05 +--- + + +// :ks_menu: **平台管理 > 平台设置** +:ks_navigation: **通知管理 > 通知渠道** +:ks_permission: **平台设置管理** + + +本节介绍如何设置 Slack 通知。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + +* 您需要提前从 Slack 平台获取应用访问参数。有关更多信息，请参阅 link:https://api.slack.com/messaging/webhooks#create_a_webhook[Slack 开发者文档]。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**通知渠道**页面，点击 **Slack** 页签，设置 Slack 通知参数，然后点击**确定**。 ++ +==== +* 服务器设置 ++ +-- +设置用于访问 Slack 应用的令牌。 +-- + +* Slack 频道设置 ++ +-- +设置接收通知的 Slack 频道。点击**添加**可设置多个 Slack 频道。 +-- + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] +==== + +. 在 **Slack** 页签右上角，点击切换开关将 Slack 通知功能设置为**已启用**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/06-set-webhook-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/06-set-webhook-notification.adoc new file mode 100644 index 000000000..2f50e24a4 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/06-set-webhook-notification.adoc @@ -0,0 +1,73 @@ +--- +title: "设置 Webhook 通知" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置 Webhook 通知" +description: "介绍如何设置 Webhook 通知。" +weight: 06 +--- + +// :ks_menu: **平台管理 > 平台设置** +:ks_navigation: **通知管理 > 通知渠道** +:ks_permission: **平台设置管理** + + +本节介绍如何设置 Webhook 通知。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + +* 您需要提前获取 Webhook 的访问参数。有关更多信息，请联系您的 Webhook 管理员。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**通知渠道**页面，点击 **Webhook** 页签，设置 Webhook 通知参数，然后点击**确定**。 ++ +==== +* 服务器设置 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|Webhook URL +|Webhook 的访问 URL。 + +|认证类型 +|Webhook 的认证类型。 + +* **无需认证**：不需要进行认证。 + +* **Bearer 令牌**：使用 URL Bearer 令牌进行认证。如果选择此类型，您需要进一步设置用于认证的令牌。 + +* **基础认证**：使用用户名和密码进行认证。如果选择此类型，您需要进一步设置用于认证的用户名和密码。 + +|跳过 TLS 验证（不安全） +|调用 Webhook 时是否跳过 TLS 验证。 +|=== +-- + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] +==== + +. 在 **Webhook** 页签右上角，点击切换开关将 Webhook 通知功能设置为**已启用**。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/_index.adoc new file mode 100644 index 000000000..2193aecdc --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/01-notification-channels/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "通知渠道" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知渠道" +description: "介绍如何设置通知渠道。" +weight: 01 +--- + + + +本节介绍如何设置平台级别的通知渠道。 + +根据您的需要，您可以通过邮件、飞书、钉钉、企业微信、Slack 或 Webhook 向用户发送通知。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/01-set-subscription.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/01-set-subscription.adoc new file mode 100644 index 000000000..3da610d00 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/01-set-subscription.adoc @@ -0,0 +1,74 @@ +--- +title: "创建通知订阅" +weight: 01 +--- + +:ks_menu: **平台管理 > 平台设置** +:ks_navigation: **通知管理 > 通知订阅** +:ks_permission: **平台设置管理** + + +本节介绍如何创建通知订阅。 + +include::../../../../../../_ks_components/admonitions/note.adoc[] + +目前仅支持为邮箱配置多个通知订阅。 + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 +. 在左侧导航栏选择pass:a,q[{ks_navigation}]。 +. 在**通知订阅**页面的**邮箱**页签，点击**创建**。 ++ +==== +* 基本信息 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|通知订阅的名称。 + +名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 + +|别名 +|通知订阅的别名。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|通知订阅的描述信息。描述可包含任意字符，最长 256 个字符。 + +|=== +-- + +* 接收设置 ++ +-- +设置接收通知的邮箱地址。点击**添加**可设置多个地址。 +-- + +* 通知接收 ++ +-- +点击切换开关，将通知功能设置为**已启用**。 +-- + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] + +==== \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/02-view-subscription.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/02-view-subscription.adoc new file mode 100644 index 000000000..29bdf38e2 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/02-view-subscription.adoc @@ -0,0 +1,57 @@ +--- +title: "查看通知订阅" +weight: 02 +--- + +:ks_menu: **平台管理 > 平台设置** +:ks_navigation: **通知管理 > 通知订阅** +:ks_permission: **平台设置管理** + + + +本节介绍如何查看通知订阅。 + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 +. 在左侧导航栏选择pass:a,q[{ks_navigation}]。 +. 在**通知订阅**页面的**邮箱**页签，查看已创建的通知订阅列表。 ++ +-- +通知订阅列表提供以下信息： +[%header,cols="1a,4a"] +|=== +|参数|描述 + +|名称 +|通知订阅的名称。 + +|通知接收状态 +|通知订阅是否被启用。 + +|通知订阅账号数量 +|接收通知的账号数量。 + +|创建时间 +|通知订阅的创建时间。 +|=== + +* 在列表上方点击搜索框并设置搜索条件，可按名称搜索通知订阅。 + +* 在列表右上角点击image:/images/ks-qkcp/zh/icons/refresh-light.svg[refresh,18,18]可刷新列表信息。 + +* 在列表右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]可定制列表中显示的信息。 +-- +. 点击通知订阅的名称，可查看详细信息，如订阅账号、过滤条件等。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/03-edit-subscription.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/03-edit-subscription.adoc new file mode 100644 index 000000000..fb8b49905 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/03-edit-subscription.adoc @@ -0,0 +1,66 @@ +--- +title: "编辑通知订阅" +weight: 03 +--- + +:ks_menu: **平台管理 > 平台设置** +:ks_navigation: **通知管理 > 通知订阅** +:ks_permission: **平台设置管理** + + +本节介绍如何编辑通知订阅。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 +. 在左侧导航栏选择pass:a,q[{ks_navigation}]。 +. 在**通知订阅**页面的**邮箱**页签，查看已创建的通知订阅列表。 +. 在需要操作的通知订阅右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑**。 +. 在**编辑通知订阅**页面，编辑信息后，点击**确定**。 ++ +==== +* 基本信息 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|通知订阅的别名。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|通知订阅的描述信息。描述可包含任意字符，最长 256 个字符。 + +|=== +-- + +* 接收设置 ++ +-- +设置接收通知的邮箱地址。点击**添加**可设置多个地址。 +-- + +* 通知接收 ++ +-- +点击切换开关，启用或禁用通知订阅。 +-- + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] + +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/04-delete-subscription.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/04-delete-subscription.adoc new file mode 100644 index 000000000..607c26577 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/04-delete-subscription.adoc @@ -0,0 +1,49 @@ +--- +title: "删除通知订阅" +weight: 04 +--- + +:ks_menu: **平台管理 > 平台设置** +:ks_navigation: **通知管理 > 通知订阅** +:ks_permission: **平台设置管理** + + +本节介绍如何删除通知订阅。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + + +== 删除单个通知订阅 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 +. 在左侧导航栏选择pass:a,q[{ks_navigation}]。 +. 在**通知订阅**页面的**邮箱**页签，查看已创建的通知订阅列表。 +. 在需要操作的通知订阅右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 +. 在**删除通知订阅**对话框，输⼊通知订阅的名称，然后点击**确定**。 + +== 批量删除通知订阅 +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台。 +. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 +. 在左侧导航栏选择pass:a,q[{ks_navigation}]。 +. 在**通知订阅**页面的**邮箱**页签，查看已创建的通知订阅列表。 +. 勾选需要删除的通知订阅左侧的复选框，然后在列表上⽅点击**删除**。 +. 在**批量删除通知订阅**对话框，输⼊通知订阅的名称，然后点击**确定**。 ++ +-- +// Note +include::../../../../../../_ks_components/admonitions/note.adoc[] + +请使用半角逗号（,）和空格分隔多个名称。 + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/_index.adoc new file mode 100644 index 000000000..a8e40fdb9 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/02-notification-subscription/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "通知订阅" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知订阅" +description: "介绍如何管理通知订阅。" +weight: 02 +--- + +本节介绍如何管理通知订阅。 + +通过通知订阅，您可以在同一通知渠道下，配置多个不同的过滤条件以发送通知给相应的接收者。 + + diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/01-create-a-silence-policy.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/01-create-a-silence-policy.adoc new file mode 100644 index 000000000..d1519954d --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/01-create-a-silence-policy.adoc @@ -0,0 +1,67 @@ +--- +title: "创建静默策略" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 静默策略, 创建静默策略" +description: "本节介绍如何创建静默策略。" +weight: 01 +--- + +:ks_menu: **平台管理 > 平台设置** +:ks_navigation: **通知管理 > 通知设置** +:ks_permission: **平台设置管理** + + +本节介绍如何创建静默策略。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**基本信息**页签，设置静默策略的基本信息，然后点击**下一步**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|静默策略的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母开头并以小写字母或数字结尾，最长 63 个字符。 + +include::../../../../../_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-aliasDescription.adoc[] +|=== +-- + +. 在**静默条件**页签，根据需要选择**对所有通知静默**或**自定义静默条件**并设置相关参数，然后点击**下一步**。 ++ +==== +include::../../../../../_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceConditions_new.adoc[] +==== + +. 在**静默时间**页签，选择静默时间类型并设置相关参数，然后点击**创建**。 ++ +-- +include::../../../../../_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceTime.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/02-edit-silence-policy-information.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/02-edit-silence-policy-information.adoc new file mode 100644 index 000000000..07cb58e41 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/02-edit-silence-policy-information.adoc @@ -0,0 +1,53 @@ +--- +title: "编辑静默策略信息" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 静默策略, 编辑静默策略信息" +description: "本节介绍如何编辑静默策略信息。" +weight: 02 +--- + + +:ks_menu: **平台管理 > 平台设置** +:ks_navigation: **通知管理 > 通知设置** +:ks_permission: **平台设置管理** + + +本节介绍如何编辑静默策略信息。 + +您可以编辑静默策略的别名和描述。{ks_product_right}不支持编辑已创建静默策略的名称。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的静默策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置静默策略的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../../_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-aliasDescription.adoc[] +|=== +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/03-edit-silence-conditions.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/03-edit-silence-conditions.adoc new file mode 100644 index 000000000..78c562c77 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/03-edit-silence-conditions.adoc @@ -0,0 +1,47 @@ +--- +title: "编辑静默条件" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 静默策略, 编辑静默条件" +description: "本节介绍如何编辑通知静默条件。" +weight: 03 +--- + + +:ks_menu: **平台管理 > 平台设置** +:ks_navigation: **通知管理 > 通知设置** +:ks_permission: **平台设置管理** + + +本节介绍如何编辑通知静默条件。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的静默策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑静默条件**。 + +. 在**编辑静默条件**对话框，设置静默条件，然后点击**确定**。 ++ +==== +include::../../../../../_custom/platformManagement/platformSettings/platformSettings/platformSettings-para-silenceConditions_new.adoc[] +==== \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/04-edit-silence-time.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/04-edit-silence-time.adoc new file mode 100644 index 000000000..e613ba708 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/04-edit-silence-time.adoc @@ -0,0 +1,59 @@ +--- +title: "编辑静默时间" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 静默策略, 编辑静默时间" +description: "本节介绍如何编辑通知静默时间。" +weight: 04 +--- + + +:ks_menu: **平台管理 > 平台设置** +:ks_navigation: **通知管理 > 通知设置** +:ks_permission: **平台设置管理** + + +本节介绍如何编辑通知静默时间。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的静默策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑静默时间**。 + +. 在**编辑静默时间**对话框，选择静默时间类型并设置相关参数，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|持续静默 +|满足静默条件的通知在所有时间静默。 + +|在特定时间范围内静默 +|满足静默条件的通知在指定的时间范围内静默。您需要选择静默的开始时间和结束时间。 + +|周期性静默 +|满足静默条件的通知每日、每周或每月在指定的时间范围内静默。您需要选择静默的日期、开始时间和结束时间。 +|=== +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/05-delete-silence-policies.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/05-delete-silence-policies.adoc new file mode 100644 index 000000000..24bdcf66e --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/05-delete-silence-policies.adoc @@ -0,0 +1,63 @@ +--- +title: "删除静默策略" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 静默策略, 删除静默策略" +description: "本节介绍如何删除静默策略。" +weight: 05 +--- + +:ks_menu: **平台管理 > 平台设置** +:ks_navigation: **通知管理 > 通知设置** +:ks_permission: **平台设置管理** + + +本节介绍如何删除静默策略。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + + + +== 删除单个静默策略 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要删除的静默策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除静默策略**对话框，输入静默策略的名称，然后点击**确定**。 + + +== 批量删除静默策略 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 选择需要删除的静默策略左侧的复选框，然后在列表上方点击**删除**。 + +. 在**批量删除静默策略**对话框，输入静默策略的名称，然后点击**确定**。 ++ +-- +include::../../../../../_custom/note-separateNamesByComma.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/06-change-the-notification-language.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/06-change-the-notification-language.adoc new file mode 100644 index 000000000..dde993a72 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/06-change-the-notification-language.adoc @@ -0,0 +1,41 @@ +--- +title: "修改通知语言" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 静默策略, 修改通知语言" +description: "本节介绍如何修改通知语言。" +weight: 06 +--- + +:ks_menu: **平台管理 > 平台设置** +:ks_navigation: **通知管理 > 通知设置** +:ks_permission: **平台设置管理** + + +本节介绍如何修改通知语言。 + +发送给用户的通知包含键值对信息，您可以设置通知的键的语言。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**通知设置**页面，点击**通知语言**页签，然后在下拉列表中选择通知语言。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/_index.adoc new file mode 100644 index 000000000..35007f1ac --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/03-notification-settings/_index.adoc @@ -0,0 +1,11 @@ +--- +title: "通知设置" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置" +description: "本节介绍如何管理静默策略和通知语言。" +weight: 03 +--- + + +本节介绍如何管理静默策略和通知语言。 + +使用静默策略设置系统在特定条件和特定时间下不发送通知。通知以键值对的形式呈现，您可以指定通知的键的语言。 diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/03-view-notification-history.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/03-view-notification-history.adoc new file mode 100644 index 000000000..d53459089 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/03-view-notification-history.adoc @@ -0,0 +1,94 @@ +--- +title: "查看通知历史" +keywords: "Kubernetes, {ks_product}, 平台设置" +description: "介绍如何查看通知历史记录。" +weight: 03 +--- + +:ks_menu: **平台管理 > 平台设置** +:ks_navigation: **通知管理 > 通知历史** +:ks_permission: **平台设置管理** + + +本节介绍如何查看通知历史记录。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + + +== 操作步骤 + +include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在{ks_product_left} Web 控制台右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。 + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + +* **通知历史**页面提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|告警名称 +|作为通知发送给用户的告警的名称。 + +|告警类型 +|告警提示的系统事件类型。 + +* **指标告警**：资源指标满足告警触发条件。 + +* **审计告警**：系统审计事件，例如 API 调用。 + +* **事件告警**：系统资源事件，例如资源创建、删除、修改等。 + +|告警级别 +| +include::../../../../../_custom/clusterManagement/ruleGroups/ruleGroups-para-alertLevel.adoc[] + +|消息 +|告警消息的内容。 + +|状态 +|告警的状态：触发中/已解决。 + +**触发中**：已触发的告警会产生触发中的通知。 + +**已解决**：当一段时间（默认5分钟）后，如果不再收到同样的告警，状态就会变为已解决。 + +|项目 +|触发告警的资源所在的项目。 + +|服务 +|触发告警的服务。 + +|容器组 +|触发告警的容器组。 + +|容器 +|触发告警的容器。 + +|通知时间 +|通知发送的时间。 +|=== +-- + +* 在列表左上角的下拉列表中选择一个集群，查看特定集群中的通知历史。 + +* 在列表上方点击搜索框并输入关键字，可按告警名称、告警级别、消息、状态、项目和时间范围搜索通知历史记录。 ++ +include::../../../../../../_ks_components/oper-refreshListData.adoc[] ++ +include::../../../../../../_ks_components/oper-customizeColumns.adoc[] + diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/_index.adoc new file mode 100644 index 000000000..804996402 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/04-notification-history/_index.adoc @@ -0,0 +1,6 @@ +--- +title: "通知历史" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知历史" +description: "介绍如何查看通知历史记录。" +weight: 04 +--- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/01-set-email-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/01-set-email-notification.adoc new file mode 100644 index 000000000..07d7f1500 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/01-set-email-notification.adoc @@ -0,0 +1,45 @@ +--- +title: "设置邮件通知" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置邮件通知" +description: "介绍如何设置邮件通知。" +weight: 01 +--- + +// // :ks_menu: **平台管理 > 平台设置** +// :ks_navigation: **通知管理 > 通知渠道** + + +本节介绍如何设置邮件通知。 + + +== 前提条件 + +// :relfileprefix: ../../../../../ +// * {empty} +// include::../../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +// :relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + +== 操作步骤 + +. 登录{ks_product_left} Web 控制台。 + +// include::../../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[] + +. 在页面右上角点击当前用户名，然后在下拉列表中选择**通知设置**。 + +. 在**通知设置**页面的**邮箱**页签，设置邮件通知参数，然后点击**确定**。 ++ +==== +* 接收设置 ++ +输入邮箱地址，点击**添加**可设置多个通知接收人。 + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] +==== + +. 点击上方的**通知已禁用**开关，启用邮箱通知。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/02-set-feishu-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/02-set-feishu-notification.adoc new file mode 100644 index 000000000..3cd5277f2 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/02-set-feishu-notification.adoc @@ -0,0 +1,62 @@ +--- +title: "设置飞书通知" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置飞书通知" +description: "介绍如何设置飞书通知。" +weight: 02 +--- + +// :ks_menu: **平台管理 > 平台设置** +// :ks_navigation: **通知管理 > 通知渠道** + + +本节介绍如何设置飞书通知。 + +飞书通知功能支持通过以下两种方式向用户发送通知： + +* **会话设置**：使用飞书应用向特定用户或部门发送通知。 + +* **群机器人设置**：使用飞书机器人向特定群聊发送通知。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + +* 您需要提前从飞书平台获取应用或群机器人的访问参数。有关更多信息，请参阅link:https://open.feishu.cn/document/ukTMukTMukTM/uITNz4iM1MjLyUzM[飞书开发者文档]。 + + +== 操作步骤 + +. 登录{ks_product_left} Web 控制台。 + +. 在页面右上角点击当前用户名，然后在下拉列表中选择**通知设置**。 + +. 在**通知设置**页面的**飞书**页签，设置飞书通知参数，然后点击**确定**。 + ++ +==== +* 会话设置 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// |App ID +// |飞书应用的 App ID。 + +// |App Secret +// |飞书应用的 App Secret。 + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sessionId.adoc[] +|=== +-- + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-groupChatBotSettings.adoc[] + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] +==== + +. 点击上方的**通知已禁用**开关，启用飞书通知。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/03-set-dingtalk-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/03-set-dingtalk-notification.adoc new file mode 100644 index 000000000..7c44b5685 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/03-set-dingtalk-notification.adoc @@ -0,0 +1,64 @@ +--- +title: "设置钉钉通知" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置钉钉通知" +description: "介绍如何设置钉钉通知。" +weight: 03 +--- + +// :ks_menu: **平台管理 > 平台设置** +// :ks_navigation: **通知管理 > 通知渠道** + + +本节介绍如何设置钉钉通知。 + +钉钉通知功能支持通过以下两种方式向用户发送通知： + +* **会话设置**：使用钉钉应用向特定用户或部门发送通知。 + +* **群机器人设置**：使用钉钉机器人向特定群聊发送通知。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + +* 您需要提前从钉钉平台获取应用或群机器人的访问参数。有关更多信息，请参阅link:https://open.dingtalk.com/document/orgapp-server/how-to-call-apis[钉钉开发者文档]。 + + +== 操作步骤 + +. 登录{ks_product_left} Web 控制台。 + +. 在页面右上角点击当前用户名，然后在下拉列表中选择**通知设置**。 + +. 在**通知设置**页面的**钉钉**页签，设置钉钉通知参数，然后点击**确定**。 + ++ +==== +* 会话设置 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// |App Key +// |钉钉应用的 AppKey。 + +// |App Secret +// |钉钉应用 App Secret。 + +|Chat ID +|接收通知的 Chat ID。点击**添加**可设置多个 Chat ID。 +|=== +-- + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-groupChatBotSettings.adoc[] + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] +==== + + +. 点击上方的**通知已禁用**开关，启用钉钉通知。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/04-set-wecom-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/04-set-wecom-notification.adoc new file mode 100644 index 000000000..0adbfcbf4 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/04-set-wecom-notification.adoc @@ -0,0 +1,62 @@ +--- +title: "设置企业微信通知" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置企业微信通知" +description: "介绍如何设置企业微信通知。" +weight: 04 +--- + + +// :ks_menu: **平台管理 > 平台设置** +// :ks_navigation: **通知管理 > 通知渠道** + + +本节介绍如何设置企业微信通知。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + +* 您需要提前从企业微信平台获取应用访问参数。有关更多信息，请参阅link:https://developer.work.weixin.qq.com/document/path/90664[企业微信开发者文档]。 + + +== 操作步骤 + +. 登录{ks_product_left} Web 控制台。 + +. 在页面右上角点击当前用户名，然后在下拉列表中选择**通知设置**。 + +. 在**通知设置**页面的**企业微信**页签，设置企业微信通知参数，然后点击**确定**。 + ++ +==== +// * 服务器设置 +// + +// -- +// [%header,cols="1a,4a"] +// |=== +// |参数 |描述 + +// |Corp ID +// |您的企业在企业微信上的 Corp ID。 + +// |Agent ID +// |企业微信应用的 Agent ID。 + +// |Secret +// |企业微信应用的 Secret。 +// |=== +// -- + +* 接收设置 ++ +-- +设置接收通知的 User ID、Department ID 或 Tag ID。点击**添加**可设置多个 ID。 +-- + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] +==== + +. 点击上方的**通知已禁用**开关，启用企业微信通知。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/05-set-slack-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/05-set-slack-notification.adoc new file mode 100644 index 000000000..040cf2d15 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/05-set-slack-notification.adoc @@ -0,0 +1,50 @@ +--- +title: "设置 Slack 通知" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置 Slack 通知" +description: "介绍如何设置 Slack 通知。" +weight: 05 +--- + + +// :ks_menu: **平台管理 > 平台设置** +// :ks_navigation: **通知管理 > 通知渠道** + + +本节介绍如何设置 Slack 通知。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + +* 您需要提前从 Slack 平台获取应用访问参数。有关更多信息，请参阅 link:https://api.slack.com/messaging/webhooks#create_a_webhook[Slack 开发者文档]。 + + +== 操作步骤 + +. 登录{ks_product_left} Web 控制台。 + +. 在页面右上角点击当前用户名，然后在下拉列表中选择**通知设置**。 + +. 在**通知设置**页面的 **Slack** 页签，设置 Slack 通知参数，然后点击**确定**。 + ++ +==== +// * 服务器设置 +// + +// -- +// 设置用于访问 Slack 应用的令牌。 +// -- + +* Slack 频道设置 ++ +-- +设置接收通知的 Slack 频道。点击**添加**可设置多个 Slack 频道。 +-- + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] +==== + +. 点击上方的**通知已禁用**开关，启用 Slack 通知。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/06-set-webhook-notification.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/06-set-webhook-notification.adoc new file mode 100644 index 000000000..6dab0782d --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/06-set-webhook-notification.adoc @@ -0,0 +1,61 @@ +--- +title: "设置 Webhook 通知" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知设置, 设置 Webhook 通知" +description: "介绍如何设置 Webhook 通知。" +weight: 06 +--- + +// :ks_menu: **平台管理 > 平台设置** +// :ks_navigation: **通知管理 > 通知渠道** + + +本节介绍如何设置 Webhook 通知。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 通知管理**扩展组件。 + +* 您需要提前获取 Webhook 的访问参数。有关更多信息，请联系您的 Webhook 管理员。 + + +== 操作步骤 + +. 登录{ks_product_left} Web 控制台。 + +. 在页面右上角点击当前用户名，然后在下拉列表中选择**通知设置**。 + +. 在**通知设置**页面的 **Webhook** 页签，设置 Webhook 通知参数，然后点击**确定**。 + ++ +==== +* 服务器设置 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|Webhook URL +|Webhook 的访问 URL。 + +|认证类型 +|Webhook 的认证类型。 + +* **无需认证**：不需要进行认证。 + +* **Bearer 令牌**：使用 URL Bearer 令牌进行认证。如果选择此类型，您需要进一步设置用于认证的令牌。 + +* **基础认证**：使用用户名和密码进行认证。如果选择此类型，您需要进一步设置用于认证的用户名和密码。 + +|跳过 TLS 验证（不安全） +|调用 Webhook 时是否跳过 TLS 验证。 +|=== +-- + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-notificationConditions_new.adoc[] + +include::../../../../../_custom/platformManagement/platformSettings/notificationChannels/notificationChannels-para-sendTestInformation.adoc[] +==== + +. 点击上方的**通知已禁用**开关，启用 Webhook 通知。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/_index.adoc new file mode 100644 index 000000000..f54644322 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/05-users-notification/_index.adoc @@ -0,0 +1,18 @@ +--- +title: "用户通知设置" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理, 通知渠道" +description: "介绍如何设置用户的通知渠道。" +weight: 05 +--- + +:ks_permission: **接收通知** + +本节介绍如何设置当前用户的通知渠道，用于接收其所在项目的告警消息。 + +[.admon.note,cols="a"] +|=== +|说明 + +|用户必须在所在项目中具有pass:a,q[{ks_permission}]权限，才能接收该项目的告警消息。 + +|=== \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/_index.adoc new file mode 100644 index 000000000..3df72ca2d --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/11-notifications/_index.adoc @@ -0,0 +1,30 @@ +--- +title: "WhizardTelemetry 通知管理" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理" +description: "介绍如何管理平台通知。" +weight: 10 +--- + + +本节介绍如何使用“WhizardTelemetry 通知管理”扩展组件。 + +// 在集群或项目中创建告警规则组会对资源状态进行监控。当资源状态满足预设的条件并且满足预设的持续时间时，系统将产生告警，并通过在平台级别设置的通知渠道向用户发送。有关告警规则组和告警的更多信息，请参阅 link:../06-alerting[WhizardTelemetry 告警管理]。 + +该扩展组件用于管理多租户 Kubernetes 环境中的通知。它能够接收来自不同发送者的告警、云事件以及其他类型的事件（例如审计和 Kubernetes 事件），并根据租户标签（如命名空间或用户）将通知发送给相应的租户接收器。支持邮件、飞书、钉钉、企业微信、Slack、Webhook 等多种通知渠道。 + + +安装“WhizardTelemetry 通知管理”扩展组件后， + +* 平台设置左侧导航栏下将显⽰**通知管理**选项。 +* 集群左侧导航栏的**集群设置**菜单下将显示**日志接收器**选项，**日志接收器**页面将显示**通知历史**页签，支持添加多种类型的日志接收器。有关更多信息，请参阅link:../02-logging/03-log-receivers/[日志接收器]。 + +//attention +[.admon.attention,cols="a"] +|=== +| 注意 + +| +- WhizardTelemetry 通知管理由每个集群部署改为只需在 host 集群部署。在 host 集群添加了 `alertmanager proxy`，并且以 NodePort 形式（默认 31093）暴露。配置 WhizardTelemetry 告警管理和 WhizardTelemetry 事件告警时，若使用 WhizardTelemetry 通知管理扩展组件发送告警消息，需要进行相应配置。有关更多信息，请参阅 link:../06-alerting[WhizardTelemetry 告警管理]和 link:../09-events-altering[WhizardTelemetry 事件告警]。 + +- WhizardTelemetry 通知管理依赖 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线，因此在安装 WhizardTelemetry 通知管理之前必须先安装 WhizardTelemetry 平台服务和 WhizardTelemetry 数据流水线这两个扩展组件，否则通知相关功能无法正常使用！ +|=== \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/01-write-data-to-kafka.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/01-write-data-to-kafka.adoc new file mode 100644 index 000000000..17c513e43 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/01-write-data-to-kafka.adoc @@ -0,0 +1,293 @@ +--- +title: "步骤 1：使用 Vector 将数据写入 Kafka" +weight: 01 +--- + + +== 部署 KSE 并安装日志相关组件 + +{ks_product_right}中需要安装的扩展组件： + +- RadonDB DMP +- OpenSearch 分布式检索与分析引擎 +- WhizardTelemetry 平台服务 +- WhizardTelemetry 数据流水线 +- WhizardTelemetry 日志管理 +- WhizardTelemetry 审计管理 +- WhizardTelemetry 通知管理 +- WhizardTelemetry 事件管理 + +=== 禁用 OpenSearch Sink + +在安装部署 WhizardTelemetry 日志管理、WhizardTelemetry 审计管理、WhizardTelemetry 事件管理以及 WhizardTelemetry 通知管理前，需要禁用这些扩展组件配置中 opensearch 的 sink。 + +以安装 WhizardTelemetry 审计管理扩展组件为例，将 sinks.opensearch.enabled 设置为 false。 + +image:/images/ks-qkcp/zh/v4.1/disable-opensearch.png[vector,100%] + +== 配置 Kafka + +在{ks_product_both}中，安装 **RadonDB DMP** 扩展组件后，点击顶部导航栏上的image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，然后点击 RadonDB DMP 进入数据库管理平台，创建 Kafka 集群以用于收集日志。 + +image:/images/ks-qkcp/zh/v4.1/dmp.png[vector,100%] + +image:/images/ks-qkcp/zh/v4.1/kafka.png[vector,100%] + +=== 启用自动创建 topic + +点击 Kafka 集群名称，进入**参数管理**页签，启用自动创建 topic 的功能。 + +image:/images/ks-qkcp/zh/v4.1/parameter.png[vector,100%] + +image:/images/ks-qkcp/zh/v4.1/enable-topic.png[vector,100%] + +[.admon.note,cols="a"] +|=== +|说明 + +| +在 Kafka 集群的详情页左侧可获取 Kafka 的读写地址。 +|=== + + +=== 创建 Kafka 用户 + +. 在 Kafka 集群的详情页面，进入 **Kafka 用户**页签，点击**创建**开始创建 Kafka 用户。 ++ +image:/images/ks-qkcp/zh/v4.1/kafka-user.png[vector,100%] + +. 按下图所示设置用户权限。 ++ +image:/images/ks-qkcp/zh/v4.1/user-permission.png[vector, 70%] + + +=== 获取证书 + +==== 查看证书相关信息 + +为了与 Kafka 通信，需要配置相关的证书及文件，具体为 -cluster-ca-cert，以及上一个步骤中创建的用户的 user.p12 字段及密码，详细信息可在{ks_product_left} Web 控制台界面上查询，如下所示。 + + +. 点击页面上方的**工作台 > 集群管理**，进入 host 集群。 +. 在左侧导航栏选择**配置 > 保密字典**。 +. 在**保密字典**页面，搜索 `cluster-ca-cert`，点击 Kafka 集群对应的保密字典进入详情页面，查看 **ca-crt** 字段的信息。 ++ +image:/images/ks-qkcp/zh/v4.1/ca-crt.png[vector,100%] ++ +. 在**保密字典**页面，搜索已创建的 Kafka 用户的名称，点击其对应的保密字典进入详情页面，查看 **user.p12** 及 **user.password** 字段的信息。 ++ +image:/images/ks-qkcp/zh/v4.1/user-password.png[vector,100%] + +==== 生成证书 + +. 在 Kafka 所在集群的节点上，执行以下命令。 ++ +==== +[.admon.note,cols="a"] +|=== +|说明 + +| +**kafka cluster** 为 Kafka 集群的名称，**kafka namespace** 为 Kafka 所在的 namespace，**kafka user** 为之前创建的 Kafka 用户。 +|=== + +[,bash] +---- +export kafka_cluster=< kafka cluster > +export kafka_namespace=< kafka namespace > +export kafka_user=< kafka user > +echo -e "apiVersion: v1\ndata:" > kafka-ca.yaml +echo " ca.crt: $(kubectl get secret -n $kafka_namespace ${kafka_cluster}-cluster-ca-cert \ +-o jsonpath='{.data.ca\.crt}')" >> kafka-ca.yaml +echo -e "kind: Secret\nmetadata:\n name: kafka-agent-cluster-ca\n labels:\n logging.whizard.io/certification: 'true'\n logging.whizard.io/vector-role: Agent\n \ +namespace: kubesphere-logging-system\ntype: Opaque" >> kafka-ca.yaml +echo "---" >> kafka-ca.yaml +echo -e "apiVersion: v1\ndata:" >> kafka-ca.yaml +echo " user.p12: $(kubectl get secret -n $kafka_namespace ${kafka_user} \ +-o jsonpath='{.data.user\.p12}')" >> kafka-ca.yaml +echo -e "kind: Secret\nmetadata:\n name: kafka-agent-user-ca\n labels:\n logging.whizard.io/certification: 'true'\n logging.whizard.io/vector-role: Agent\n \ +namespace: kubesphere-logging-system\ntype: Opaque" >> kafka-ca.yaml +---- + +此命令会生成 **kafka-ca.yaml** 文件，包含 **kafka-agent-cluster-ca** 以及 **kafka-agent-user-ca** 两个 secret 文件，分别含有上一个步骤中的 ca.crt 以及 user.p12 信息。示例如下： + +[,yaml] +---- +apiVersion: v1 +data: + ca.crt: xxx +kind: Secret +metadata: + name: kafka-agent-cluster-ca + labels: + logging.whizard.io/certification: 'true' + logging.whizard.io/vector-role: Agent + namespace: kubesphere-logging-system +type: Opaque +--- +apiVersion: v1 +data: + user.p12: xxxx +kind: Secret +metadata: + name: kafka-agent-user-ca + labels: + logging.whizard.io/certification: 'true' + logging.whizard.io/vector-role: Agent + namespace: kubesphere-logging-system +---- +==== + +. 将 **kafka-ca.yaml** 文件复制到需要收集日志数据的集群节点上，执行以下命令。 ++ +-- +[,bash] +---- +kubectl apply -f kafka-ca.yaml +---- + +此命令会在 **kubesphere-logging-system** 项目下创建 **kafka-agent-cluster-ca** 以及 **kafka-agent-user-ca** 两个 secret 文件。vector-config 会自动加载这两个 secret，并且在 vector 中配置相关证书。 +-- + +== 创建 Kafka 日志接收器 + +[,bash] +---- +cat <- + sinks: + kafka_auditing: + type: "kafka" + topic: "vector-{{ .cluster }}-auditing" + # 逗号分隔的 Kafka bootstrap servers 如："10.14.22.123:9092,10.14.23.332:9092" + bootstrap_servers: "172.31.73.214:32239" + librdkafka_options: + security.protocol: "ssl" + ssl.endpoint.identification.algorithm: "none" + ssl.ca.location: "/etc/vector/custom/certification/ca.crt" + ssl.keystore.location: "/etc/vector/custom/certification/user.p12" + ssl.keystore.password: "yj5nwJLVqyII1ZHZCW2RQwJcyjKo3B9o" + encoding: + codec: "json" + inputs: + - auditing_remapped + batch: + max_events: 100 + timeout_secs: 10 +type: Opaque + +--- +kind: Secret +apiVersion: v1 +metadata: + name: vector-agent-events-sink-kafka + namespace: kubesphere-logging-system + labels: + logging.whizard.io/component: events + logging.whizard.io/enable: 'true' + logging.whizard.io/vector-role: Agent + annotations: + kubesphere.io/creator: admin +stringData: + sink.yaml: >- + sinks: + kafka_events: + type: "kafka" + topic: "vector-{{ .cluster }}-events" + bootstrap_servers: "172.31.73.214:32239" + librdkafka_options: + security.protocol: "ssl" + ssl.endpoint.identification.algorithm: "none" + ssl.ca.location: "/etc/vector/custom/certification/ca.crt" + ssl.keystore.location: "/etc/vector/custom/certification/user.p12" + ssl.keystore.password: "yj5nwJLVqyII1ZHZCW2RQwJcyjKo3B9o" + encoding: + codec: "json" + inputs: + - kube_events_remapped + batch: + max_events: 100 + timeout_secs: 10 +type: Opaque + +--- +kind: Secret +apiVersion: v1 +metadata: + name: vector-agent-logs-sink-kafka + namespace: kubesphere-logging-system + labels: + logging.whizard.io/component: logs + logging.whizard.io/enable: 'true' + logging.whizard.io/vector-role: Agent + annotations: + kubesphere.io/creator: admin +stringData: + sink.yaml: >- + sinks: + kafka_logs: + type: "kafka" + topic: "vector-{{ .cluster }}-logs" + bootstrap_servers: "172.31.73.214:32239" + librdkafka_options: + security.protocol: "ssl" + ssl.endpoint.identification.algorithm: "none" + ssl.ca.location: "/etc/vector/custom/certification/ca.crt" + ssl.keystore.location: "/etc/vector/custom/certification/user.p12" + ssl.keystore.password: "yj5nwJLVqyII1ZHZCW2RQwJcyjKo3B9o" + encoding: + codec: "json" + inputs: + - kube_logs_remapped + - systemd_logs_remapped + batch: + max_events: 100 + timeout_secs: 10 +type: Opaque + +--- +apiVersion: v1 +kind: Secret +metadata: + name: vector-aggregator-notification-history-sink-kafka + namespace: kubesphere-logging-system + labels: + logging.whizard.io/component: "notification-history" + logging.whizard.io/vector-role: Aggregator + logging.whizard.io/enable: "true" +stringData: + sink.yaml: >- + sinks: + kafka_notification_history: + type: "kafka" + topic: "vector-{{ .cluster }}-notification-history" + bootstrap_servers: "172.31.73.214:32239" + librdkafka_options: + security.protocol: "ssl" + ssl.endpoint.identification.algorithm: "none" + ssl.ca.location: "/etc/vector/custom/certification/ca.crt" + ssl.keystore.location: "/etc/vector/custom/certification/user.p12" + ssl.keystore.password: "yj5nwJLVqyII1ZHZCW2RQwJcyjKo3B9o" + encoding: + codec: "json" + inputs: + - notification_history_remapped + batch: + max_events: 100 + timeout_secs: 10 +type: Opaque +EOF +---- + diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/02-read-data-from-kafka.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/02-read-data-from-kafka.adoc new file mode 100644 index 000000000..1a75708a5 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/02-read-data-from-kafka.adoc @@ -0,0 +1,171 @@ +--- +title: "步骤 2：使用 Vector 从 Kafka 读取数据" +weight: 02 +--- + +== 部署 vector aggregator + +在 Kafka 所在集群，执行以下命令创建 vector namespace，并在该 namespace 下部署 vector-aggregator。 + +[.admon.note,cols="a"] +|=== +|说明 + +| +* 请勿将 vector aggregator 部署到 kubesphere-logging-system namespace， 以免与{ks_product_both}内置的 vector aggregator 冲突。 + +* 请联系{ks_product_both}技术支持团队获取 vector aggregator 的 helm 包。 +|=== + +[,bash] +---- +helm install vector-aggregator aggregator-0.30.0.tgz -n vector --create-namespace --set vectorConfig.image.tag=v0.2.1 --set image.tag=0.36.0-debian +---- + +所需镜像： + +[,bash] +---- +docker.io/timberio/vector:0.36.0-debian +docker.io/kubesphere/kubectl:v1.26.13 +docker.io/kubesphere/vector-config:v0.2.1 +---- + +== 获取证书 + +. 在 Kafka 所在集群的节点上，执行以下命令。 ++ +==== +[.admon.note,cols="a"] +|=== +|说明 + +| +**kafka cluster** 为 Kafka 集群的名称，**kafka namespace** 为 Kafka 所在的 namespace，**kafka user** 为之前创建的 Kafka 用户。 +|=== + +[,bash] +---- +export kafka_cluster=< kafka cluster > +export kafka_namespace=< kafka namespace > +export kafka_user=< kafka user > +echo -e "apiVersion: v1\ndata:" > kafka-aggregator-ca.yaml +echo " ca.crt: $(kubectl get secret -n $kafka_namespace ${kafka_cluster}-cluster-ca-cert \ +-o jsonpath='{.data.ca\.crt}')" >> kafka-aggregator-ca.yaml +echo -e "kind: Secret\nmetadata:\n name: kafka-aggregator-cluster-ca\n labels:\n logging.whizard.io/certification: 'true'\n logging.whizard.io/vector-role: Aggregator\n \ +namespace: vector\ntype: Opaque" >> kafka-aggregator-ca.yaml +echo "---" >> kafka-aggregator-ca.yaml +echo -e "apiVersion: v1\ndata:" >> kafka-aggregator-ca.yaml +echo " user.p12: $(kubectl get secret -n $kafka_namespace ${kafka_user} \ +-o jsonpath='{.data.user\.p12}')" >> kafka-aggregator-ca.yaml +echo -e "kind: Secret\nmetadata:\n name: kafka-aggregator-user-ca\n labels:\n logging.whizard.io/certification: 'true'\n logging.whizard.io/vector-role: Aggregator\n \ +namespace: vector\ntype: Opaque" >> kafka-aggregator-ca.yaml +---- + +此命令会生成 **kafka-aggregator-ca.yaml** 文件，包含 **kafka-aggregator-cluster-ca** 以及 **kafka-aggregator-user-ca** 两个 secret 文件，分别含有上一个步骤中的 ca.crt 以及 user.p12 信息。 +示例如下： + +[,yaml] +---- +apiVersion: v1 +data: + ca.crt: xxx +kind: Secret +metadata: + name: kafka-aggregator-cluster-ca + labels: + logging.whizard.io/certification: 'true' + logging.whizard.io/vector-role: Aggregator + namespace: vector +type: Opaque +--- +apiVersion: v1 +data: + user.p12: xxx +kind: Secret +metadata: + name: kafka-aggregator-user-ca + labels: + logging.whizard.io/certification: 'true' + logging.whizard.io/vector-role: Aggregator + namespace: vector +type: Opaque +---- + +==== + +== 配置 vector-aggregator，将消息发送至 OpenSearch + +创建 vector 配置，在 bootstrap_servers 填入相应的 Kafka 集群地址，在 sink:kafka_to_opensearch:endpoints 填入相应的 OpenSearch 地址。 + +[,bash] +---- +cat <- + sources: + kafka_source: + type: "kafka" + group_id: "ks" + topics: [ "^(vector)-.+" ] + bootstrap_servers: "172.31.53.102:32476" + librdkafka_options: + security.protocol: "ssl" + ssl.endpoint.identification.algorithm: "none" + ssl.ca.location: "/etc/vector/custom/certification/ca.crt" + ssl.keystore.location: "/etc/vector/custom/certification/user.p12" + ssl.keystore.password: "yj5nwJLVqyII1ZHZCW2RQwJcyjKo3B9o" + max.poll.interval.ms: "600000" + partition.assignment.strategy: roundrobin + decoding: + codec: json + session_timeout_ms: 20000 + socket_timeout_ms: 90000 + transforms: + kafka_remapped: + inputs: + - kafka_source + source: |- + .event.original = encode_json(.) + ts = parse_timestamp!(.timestamp, format: "%+") + .timestamp = format_timestamp!(ts, format: "%+", timezone: "local") + .topictime = to_unix_timestamp(ts, unit: "milliseconds") + .logstamp = from_unix_timestamp!(.topictime, unit: "milliseconds") + .logdate = .timestamp + .idxdate = format_timestamp!(ts, format: "%Y.%m.%d", timezone: "local") + tmp = split!(.topic, "-") + .index = join!(remove!(tmp, [0]), "-") + type: remap + sinks: + kafka_to_opensearch: + api_version: v8 + auth: + password: admin + strategy: basic + user: admin + batch: + timeout_secs: 5 + buffer: + max_events: 10000 + endpoints: + - https://: + tls: + verify_certificate: false + type: elasticsearch + inputs: + - kafka_remapped + bulk: + index: "{{ .index }}-%Y.%m.%d" + request: + timeout_sec: 180 +type: Opaque +EOF +---- diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/03-configure-platform-service.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/03-configure-platform-service.adoc new file mode 100644 index 000000000..0c4acc54e --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/03-configure-platform-service.adoc @@ -0,0 +1,24 @@ +--- +title: "步骤 3：配置 WhizardTelemetry 平台服务" +weight: 03 +--- + +== 修改 whizard-telemetry-config + +如果使用外置 OpenSearch 数据库，需要修改配置文件 whizard-telemetry-config。 + +. 在集群左侧导航栏选择**配置 > 配置字典**。 + +. 在**配置字典**页面，查找 **whizard-telemetry-config**，点击右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑 yaml**。 ++ +image:/images/ks-qkcp/zh/v4.1/whizard-telemetry-config.png[vector,100%] + +. 修改 `notification:history:endpoints`、`logging:endpoints`、`auditing:endpoints` 和 `events:endpoints` 为 OpenSearch 地址，点击**确定**。 ++ +image:/images/ks-qkcp/zh/v4.1/edit-endpoint.png[vector,100%] + +== 在 KSE 界面查询日志 + +部署完成后，可以从 OpenSearch 查询到日志，如图所示。 + +image:/images/ks-qkcp/zh/v4.1/log.png[vector,100%] \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/_index.adoc new file mode 100644 index 000000000..d8f287dbd --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/02-etl-solution/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "Vector 日志 ETL 方案 - 从 Kafka 到 OpenSearch" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理" +description: "介绍如何管理平台通知。" +weight: 13 +--- + +== 总体方案 + +image:/images/ks-qkcp/zh/v4.1/vector-solution.png[vector, 100%] \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/_index.adoc new file mode 100644 index 000000000..091120f0f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/13-vector/_index.adoc @@ -0,0 +1,29 @@ +--- +title: "WhizardTelemetry 数据流水线" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理" +description: "介绍如何管理平台通知。" +weight: 13 +--- + + +WhizardTelemetry 数据流水线是 WhizardTelemetry 可观测平台中提供可观测性数据的收集、转换和路由能力的扩展组件。 + + +//attention +[.admon.attention,cols="a"] +|=== +| 注意 + +| +* WhizardTelemetry 数据流水线是 WhizardTelemetry 日志管理、WhizardTelemetry 事件管理、WhizardTelemetry 审计管理、WhizardTelemetry 通知管理等共同依赖的扩展组件，因此在安装上述几个扩展组件之前必须先安装 WhizardTelemetry 数据流水线扩展组件，否则日志、通知、审计、事件等功能无法正常使用！ + +* WhizardTelemetry 可观测平台支持从 OpenSearch 查询日志、审计、事件、通知历史等数据，因此需要在 WhizardTelemetry 数据流水线扩展组件里统一配置接收日志、审计、事件、通知历史等数据的 OpenSearch 服务的信息，可以是用户自行搭建的 OpenSearch 服务，也可以是通过 OpenSearch 分布式检索与分析引擎这个扩展组件安装的 OpenSearch 服务。 +|=== + +[.admon.note,cols="a"] +|=== +|说明 + +| +有关组件配置的更多信息，请参阅扩展中心“WhizardTelemetry 数据流水线”扩展组件的详情页说明。 +|=== \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/15-opensearch/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/15-opensearch/_index.adoc new file mode 100644 index 000000000..baffd3d6f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/15-opensearch/_index.adoc @@ -0,0 +1,23 @@ +--- +title: "OpenSearch 分布式检索与分析引擎" +keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理" +description: "介绍如何管理平台通知。" +weight: 15 +--- + +“OpenSearch 分布式检索与分析引擎”扩展组件是 KubeSphere 内置的日志存储扩展组件，用于存储日志、审计、事件、通知历史等可观测数据。 + +除支持部署 OpenSearch 外，该扩展组件还支持部署 OpenSearch Dashboard 和 OpenSearch Curator。 + +* **OpenSearch Dashboard** 用于可视化 OpenSearch 数据以及管理 OpenSearch 集群的用户界面。部署后默认禁用，若要启用，将 `opensearch-dashboards.enabled` 字段设置为 true。 + +* **OpenSearch Curator** 是一个定时任务，定期清理超过配置日期（默认为 7 天）的 Kubernetes 事件日志、Kubernetes 审计日志、Kubernetes 应用程序日志以及通知历史日志。部署后默认启用，若要禁用，将 `opensearch-curator.enabled` 字段设置为 false。 + + +[.admon.note,cols="a"] +|=== +|说明 + +| +有关组件配置的更多信息，请参阅扩展中心“WhizardTelemetry 数据流水线”和“OpenSearch 分布式检索与分析引擎”扩展组件的详情页说明。 +|=== \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/_index.adoc new file mode 100644 index 000000000..f3dda3bfe --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/05-observability-platform/_index.adoc @@ -0,0 +1,31 @@ +--- +title: "WhizardTelemetry 可观测平台" +keywords: "Kubernetes, KubeSphere, 可观测中心, 监控, 告警管理, 事件告警, 通知管理, 日志管理, 审计管理, 事件管理, 数据流水线, OpenSearch" +description: "介绍如何使用 WhizardTelemetry 可观测平台。" +weight: 05 +--- + +WhizardTelemetry 可观测平台是一款企业级多集群监控告警产品，专注于提供一体化的云原生可观测性服务。该平台提供了从基础设施到应用的多层级、多维度、多租户的指标监控和告警功能。同时，通过可插拔的 Whizard 可观测中心实现了监控告警的多集群统一纳管能力，以及成员集群和边缘集群的轻量化支持。 + +WhizardTelemetry 可观测平台由以下扩展组件构成： + +- **WhizardTelemetry 平台服务**：是 WhizardTelemetry 可观测平台各扩展组件的公共服务。它是各个可观测性扩展组件通用的 APIServer，为所有可观测性扩展组件提供公共的后端平台服务。 + +- **WhizardTelemetry 日志管理**：提供多租户视角的云原生应用实时及历史日志收集、查询、导出、存储等功能，可对接如 ElasticSearch、OpenSearch、Kafka 等日志接收器。 + +- **WhizardTelemetry 事件管理**：可长期保存 Kubernetes 相关对象产生的事件，并提供多租户视角的事件检索和查看功能。 + +- **WhizardTelemetry 审计管理**：实时记录在{ks_product_both}平台上的用户相关操作行为，并提供多租户视角的审计历史的检索及查看功能，可快速回溯相关用户的操作行为。 + +- **WhizardTelemetry 监控**：提供多租户视角的云原生资源监控能力，包括针对集群，节点，工作负载、GPU、K8s 控制面等对象的核心监控指标进行实时和历史数据展示等功能。 + +- **WhizardTelemetry 告警管理**：基于 KubeSphere 采集的监控数据，可针对不同资源类型和监控指标，提供平台及租户视角的告警及告警规则管理功能。 + +- **WhizardTelemetry 事件告警**：为 Kubernetes 原生事件和 Kubernetes/KubeSphere 审计事件定义告警规则，对传入的事件数据进行评估，并将告警发送到指定的接收器如 HTTP 端点等。 + +- **WhizardTelemetry 通知管理**：管理多租户 Kubernetes 环境中的通知。它能够接收来自不同发送者的告警、云事件以及其他类型的事件（例如审计和 Kubernetes 事件），并根据租户标签（如命名空间或用户）将通知发送给相应的租户接收器。支持邮件、飞书、钉钉、企业微信、Slack、Webhook 等多种通知渠道。 + +- **WhizardTelemetry 数据流水线**：提供可观测性数据的收集、转换和路由能力。 + +- **OpenSearch 分布式检索与分析引擎**：支持使用外置或内置的 OpenSearch 集群来存储、检索与分析日志、审计、事件、通知历史等可观测数据。 + diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/01-create-a-network-policy.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/01-create-a-network-policy.adoc new file mode 100644 index 000000000..32f31c9b0 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/01-create-a-network-policy.adoc @@ -0,0 +1,56 @@ +--- +title: "创建网络策略" +keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 网络策略, 创建网络策略" +description: "介绍如何创建网络策略。" +weight: 01 +--- + +:ks_permission: **集群网络资源管理** +:ks_navigation: **网络 > 网络策略** + + +本节介绍如何创建网络策略。 + + +== 前提条件 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**创建网络策略**对话框，设置网络策略的配置文件，然后点击**确定**。 ++ +-- +* 在右上角点击image:/images/ks-qkcp/zh/icons/upload-dark-white.svg[upload-dark-white,18,18] 可上传配置文件。 + +* 在右上角点击image:/images/ks-qkcp/zh/icons/download-dark-white.svg[download-dark-white,18,18] 可下载配置文件。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +{ks_product_right}目前不支持以图形化的方式创建网络策略。有关网络策略配置文件的具体参数，请参阅 link:https://kubernetes.io/zh/docs/concepts/services-networking/network-policies/[Kubernetes 官方文档]。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + +网络策略创建完成后将显示在网络策略列表中。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/02-view-a-network-policy-list.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/02-view-a-network-policy-list.adoc new file mode 100644 index 000000000..08cb136ff --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/02-view-a-network-policy-list.adoc @@ -0,0 +1,54 @@ +--- +title: "查看网络策略列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 网络策略, 查看网络策略列表" +description: "介绍如何查看网络策略列表。" +weight: 02 +--- + +:ks_permission: **集群网络资源查看** +:ks_navigation: **网络 > 网络策略** + + +本节介绍如何查看网络策略列表。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ +==== +* 网络策略列表提供以下信息： ++ +-- +[options="header",cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../_custom/clusterManagement/networkPolicies/networkPolicies-para-information.adoc[] +|=== +-- + +* 在列表左上角的下拉列表中选择一个项目，可以查看特定项目中的网络策略。 + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/03-view-network-policy-details.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/03-view-network-policy-details.adoc new file mode 100644 index 000000000..94b18de14 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/03-view-network-policy-details.adoc @@ -0,0 +1,111 @@ +--- +title: "查看网络策略详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 网络策略, 查看网络策略详情" +description: "介绍如何查看网络策略详情。" +weight: 03 +--- + +:ks_permission: **集群网络资源查看** +:ks_navigation: **网络 > 网络策略** + + +本节介绍如何查看网络策略详情。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在网络策略列表中点击一个网络策略的名称打开其详情页面。 + +. 在网络策略详情页面左侧的**属性**区域查看网络策略的资源属性。 ++ +-- +[options="header",cols="1a,4a"] +|=== +|参数 |描述 + +|集群 +|网络策略所属的集群。 + +|项目 +|网络策略所属的项目。 + +|创建时间 +|网络策略的创建时间。 + +|创建者 +|创建网络策略的用户。 +|=== +-- + +. 在网络策略详情页面右侧点击**出站规则**页签查看网络策略的出站规则。 ++ +-- +出站规则用于限制容器组只能访问特定的其他容器组或网段。 + +[%header,cols="1a,4a"] +|=== + +|参数 +|描述 + +|目标 +|规则适用的容器组的信息。 + +* **项目**：规则所属的项目。网络策略中的规则仅适用于网络策略所属项目中的容器组。 + +* **标签**：规则适用的容器组所具有的标签。如果未设置标签，则规则适用于网络策略所属的项目中的所有容器组。 + + +|目的地 +|目标容器组可以访问的其他容器组或网段的信息。 + +* **项目**：目标容器组可以访问的其他容器组所属的项目。 +* **标签**：目标容器组可以访问的其他容器组所具有的标签。如果未设置标签，则目标容器组可以访问项目中的所有容器组。 +* **CIDR**：目标容器组可以访问的网段。 +* **端口**：目标容器组可以访问的其他容器组或网段的端口。如果未设置端口，则目标容器组可以访问其他容器组或网段的所有端口。 +|=== +-- + +. 在网络策略详情页面右侧点击**入站规则**页签查看网络策略的入站规则。 ++ +-- +入站规则用于限制容器组只能被特定的其他容器组或网段访问。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|目标 +| +include::../../../../_custom/clusterManagement/networkPolicies/networkPolicies-para-target.adoc[] + +|目的地 +|可以访问目标容器组的其他容器组或网段的信息。 + +* **项目**：可以访问目标容器组的其他容器组所属的项目。 +* **标签**：可以访问目标容器组的其他容器组所具有的标签。如果未设置标签，则项目中的所有容器组都可访问目标容器组。 +* **CIDR**：可以访问目标容器组的网段。 +* **端口**：其他容器组或网段可以访问的目标容器组的端口。如果未设置端口，则其他容器组或网段可以访问的目标容器组的所有端口。 +|=== +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/04-edit-network-policy-information.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/04-edit-network-policy-information.adoc new file mode 100644 index 000000000..ef2ab3668 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/04-edit-network-policy-information.adoc @@ -0,0 +1,55 @@ +--- +title: "编辑网络策略信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 项目, 编辑网络策略信息" +description: "介绍如何编辑网络策略信息。" +weight: 04 +--- + +:ks_permission: **集群网络资源管理** +:ks_navigation: **网络 > 网络策略** + + +本节介绍如何编辑网络策略信息。 + +您可以编辑网络策略的别名和描述。{ks_product_right}不支持编辑已创建网络策略的名称。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的网络策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置网络策略的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|网络策略的别名。不同项目的网络策略可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|网络策略的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|=== +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/05-edit-network-policy-yaml.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/05-edit-network-policy-yaml.adoc new file mode 100644 index 000000000..5818a156e --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/05-edit-network-policy-yaml.adoc @@ -0,0 +1,44 @@ +--- +title: "编辑网络策略配置" +keywords: "Kubernetes, {ks_product}, 集群管理, 项目, 编辑网络策略配置, yaml" +description: "介绍如何编辑网络策略配置。" +weight: 05 +--- + +:ks_permission: **集群网络资源管理** +:ks_navigation: **网络 > 网络策略** + + +本节介绍如何编辑网络策略的配置。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的网络策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑 YAML**。 + +. 在**编辑 YAML**对话框，修改网络策略的配置，然后点击**确定**。 ++ +-- +有关网络策略配置文件的具体参数，请参阅 link:https://kubernetes.io/zh/docs/concepts/services-networking/network-policies/[Kubernetes 官方文档]。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/06-delete-network-policies.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/06-delete-network-policies.adoc new file mode 100644 index 000000000..dfac45146 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/06-delete-network-policies.adoc @@ -0,0 +1,64 @@ +--- +title: "删除网络策略" +keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 网络策略, 删除网络策略" +description: "介绍如何删除网络策略。" +weight: 06 +--- + +:ks_permission: **集群网络资源管理** +:ks_navigation: **网络 > 网络策略** + + +本节介绍如何删除网络策略。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +网络策略删除后无法恢复，请谨慎执行此操作。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 + + +== 删除单个网络策略 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + +. 在需要删除的网络策略右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除网络策略**对话框，输入网络策略的名称，然后点击**确定**。 + + +== 批量删除网络策略 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 选择需要删除的网络策略左侧的复选框，然后在网络策略列表上方点击**删除**。 + +. 在**批量删除网络策略**对话框，输入网络策略的名称，然后点击**确定**。 ++ +-- +include::../../../../_custom/note-separateNamesByComma.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/01-workspace-network-isolation.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/01-workspace-network-isolation.adoc new file mode 100644 index 000000000..5b703eb53 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/01-workspace-network-isolation.adoc @@ -0,0 +1,36 @@ +--- +title: "启用企业空间网络隔离" +keywords: "Kubernetes, {ks_product}, 企业空间, 企业空间设置, 基本信息, 启用和禁用网络隔离" +description: "介绍如何启用和禁用企业空间网络隔离。" +weight: 01 +--- + +:ks_permission: **企业空间网络隔离管理** +:ks_navigation: **企业空间设置 > 基本信息** + + +本节介绍如何为授权给企业空间的集群启用和禁用网络隔离。 + +当授权给企业空间的集群启用网络隔离后，属于该企业空间且运行在该集群中的容器组将不能被企业空间外部的客户端访问，也不能被集群外部的客户端访问。属于该企业空间且运行在该集群中的容器组的出站流量不受限制。 + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 + +== 操作步骤 + +include::../../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**网络隔离**区域，点击集群右侧的开关为集群启用或禁用网络隔离。 diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/02-project-network-isolation.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/02-project-network-isolation.adoc new file mode 100644 index 000000000..d6b9a1020 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/02-project-network-isolation.adoc @@ -0,0 +1,148 @@ +--- +title: "启用项目网络隔离" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 网络隔离, 启用网络隔离" +description: "介绍如何启用项目网络隔离。" +weight: 02 +--- + +:ks_permission: **项目网络隔离管理** +:ks_navigation: **项目设置 > 网络隔离** + + +本节介绍如何启用项目网络隔离，以及添加和删除隔离白名单。 + + +== 前提条件 + +:relfileprefix: ../../../../../ +* {empty} +include::../../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 + +== 操作步骤 + +=== 启用网络隔离 + +include::../../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**网络隔离**页面，点击**启用**。 ++ +-- +// Note +include::../../../../../../_ks_components/admonitions/note.adoc[] + +启用网络隔离后，其他项目的容器组、其他节点主机环境以及集群外部的所有网段将无法访问当前项目中的容器组。默认对出站没有限制，即在未设置白名单条目的情况下，当前项目中的容器组可以与其他项目的容器组、其他节点主机环境以及集群外部的所有网段通信。添加白名单条目后，仅允许当前项目中的容器组与特定项目中的容器组、其他节点主机环境和集群外部网段通信。 + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +=== 添加白名单 + +. 启用网络隔离后，点击**内部白名单**或**外部白名单**页签。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|内部白名单 +|允许当前项目中的容器组与当前企业空间其他项目中的容器组通信。 + +|外部白名单 +|允许当前项目中的容器组与企业空间外部的特定网段和端口通信。 +|=== +-- + +. 在**内部白名单**或**外部白名单**页签，点击**添加白名单条目**。 + +. 在**添加白名单条目**对话框，设置白名单条目的参数，然后点击**确定**。 ++ +==== +* 对于内部白名单条目，请设置以下参数： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|流量方向 +|白名单条目放行的流量方向。 + +* **出站**：从当前项目到其他项目的方向。 + +* **入站**：从其他项目到当前项目的方向。 + +|类型 +|白名单条目匹配其他项目容器组的方式。 + +* **项目**：当前项目中的容器组可以与指定项目中的所有容器组通信。 + +* **服务**：当前项目中的容器组可以与指定服务的后端容器组通信。 +|=== +-- + +* 对于外部白名单条目，请设置以下参数： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|白名单条目的名称。 + +|流量方向 +|白名单条目放行的流量方向。 + +* **出站**：从当前项目到企业空间外的方向。 + +* **入站**：从企业空间外到当前项目的方向。 + +|网段 +|企业空间外部的网络地址和子网掩码。支持无类别域间路由（CIDR）。 + +* 在已添加的网段右侧点击image:/images/ks-qkcp/zh/icons/copy-light.svg[copy-light,18,18]可创建网段副本。 +* 在已添加的网段右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除网段。 +* 点击**添加新网段**可设置多个网段。 + +|端口 +|白名单条目放行的端口号。 + +* 对于出站白名单条目，此处的端口为企业空间外部地址的端口。 + +* 对于入站白名单条目，此处的端口为当前项目容器组的端口。 + +* 在已添加的端口右侧点击image:/images/ks-qkcp/zh/icons/copy-light.svg[copy-light,18,18]可创建端口副本。 +* 在已添加的端口右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除端口。 +* 点击**添加新端口范围**可设置多个端口范围，点击**添加新端口**可设置多个端口。 +|=== +-- + +白名单条目创建完成后将显示在内部白名单或外部白名单列表中。 +==== + +. 在**外部白名单**列表中，点击条目名称可查看条目详情，在条目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] > **编辑**，编辑白名单条目详情。 + +=== 删除白名单 + +// Warning +include::../../../../../../_ks_components/admonitions/warning.adoc[] + +删除白名单条目可能会导致当前项目中的容器组网络连接中断，请谨慎执行此操作。 + +include::../../../../../../_ks_components/admonitions/admonEnd.adoc[] + +. 在**网络隔离**页面，点击**内部白名单**或**外部白名单**页签。 + +. 在需要删除的内部白名单条目右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]；在需要删除的外部白名单条目右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除白名单条目**对话框，输入白名单条目的名称，然后点击**确定**。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/_index.adoc new file mode 100644 index 000000000..6819aaee6 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/07-network-isolation/_index.adoc @@ -0,0 +1,26 @@ +--- +title: "网络隔离" +keywords: "Kubernetes, {ks_product}, 企业空间, 网络策略, 项目设置, 网络隔离" +description: "介绍如何为企业空间和项目启用网络隔离。" +weight: 07 +--- + + +本节介绍如何为企业空间和项目启用网络隔离。 + +网络隔离功能用于控制企业空间和项目中容器组的出站和入站流量。您可以使用网络隔离功能实现以下目的： + +* 只允许当前企业空间和项目的容器组访问特定的其他容器组或网段。 + +* 只允许当前企业空间和项目的容器组被特定的其他容器组或网段访问。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +启用企业空间网络隔离会自动在相应集群中为该企业空间下的所有项目创建网络策略。若企业空间有新增项目，会自动为该项目创建网络策略。若从企业空间移除项目，该项目的网络策略也会自动移除。 + +启用项目网络隔离会自动在相应集群中为该项目创建网络策略。 +|=== diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/_index.adoc new file mode 100644 index 000000000..c89e9cbb0 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/01-network-policies/_index.adoc @@ -0,0 +1,15 @@ +--- +title: "网络策略" +keywords: "Kubernetes, {ks_product}, 集群管理, 网络策略" +description: "介绍如何管理集群网络策略。" +weight: 01 +--- + + +本节介绍如何管理网络策略。 + +网络策略用于控制集群中容器组的访问和被访问权限，允许在同个集群内实现网络的隔离。您可以使用网络策略实现以下目的： + +* 只允许容器组访问特定的其他容器组或网段。 + +* 只允许容器组被特定的其他容器组或网段访问。 diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/01-create-a-pod-ip-pool.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/01-create-a-pod-ip-pool.adoc new file mode 100644 index 000000000..597e7c28e --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/01-create-a-pod-ip-pool.adoc @@ -0,0 +1,153 @@ +--- +title: "创建容器组 IP 池" +keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 容器组 IP 池, 创建容器组 IP 池" +description: "介绍如何创建容器组 IP 池。" +weight: 01 +--- + +:ks_permission: **集群网络资源管理** +:ks_navigation: **网络 > 容器组 IP 池** + + +本节介绍如何创建容器组 IP 池。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**创建容器组 IP 池**对话框，设置容器组 IP 池的参数，然后点击**下一步**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|IP 地址 +|容器组 IP 池对应网段的网络地址。 + +|掩码 +|容器组 IP 池对应网段的掩码位数。 + +|数量 +|创建容器组 IP 池的数量。最多可同时创建 10 个容器组 IP 池。如果创建数量大于或等于 2，系统将根据自动填充其他 IP 池的网络地址。您也可以根据需要自定义其他 IP 池的网络地址。 +|=== +-- + +. 在**容器组 IP 池**对话框，点击image:/images/ks-qkcp/zh/icons/pen-light.svg[pen,18,18]，在弹出的**编辑容器组 IP 池**区域，设置以下参数，然后点击**创建**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|网段 +|容器组 IP 池的 IP 范围。 + +|名称 +|容器组 IP 池名称。您可以修改系统默认生成的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头或结尾，最长 63 个字符。 + +|IP 池块大小 +|IP 池用于分配 IP 的 block 的 CIDR 大小。 + +|NAT outgoing +|是否允许通过 NAT 方式跨 IP 池通信。 + +启用此功能后，来自此 IP 池中的 Calico 网络容器发送到任何 Calico IP 池之外的目的地的数据包将被伪装。 + +若启用 IPIP 或 VXLAN 模式，建议开启 NAT outgoing，否则运行 Calico 的工作负载和主机之间的路由是非对称的，并且可能由于 RPF 检查失败而导致流量被过滤。 + +|别名 +|容器组 IP 池的别名。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|容器组 IP 池的描述信息。描述可包含任意字符，最多包含 256 个字符。 + +|选择节点 +|使用标签选择器为 IP 池匹配合适的节点。 + +* **节点范围** + +** 全部：匹配标签选择范围内的所有节点。 +** 全部禁止：禁止自动分配 IP 池的 IP 地址到任一节点的容器组。 + +* **标签选择** + +ifeval::["{file_output_type}" == "html"] +** 键：节点标签的键。点击输入自定义的键。有关节点标签的更多信息，请参阅link:../../../../07-cluster-management/03-nodes/06-edit-node-labels.adoc[编辑节点标签]。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +** 键：节点标签的键。点击输入自定义的键。有关节点标签的更多信息，请参阅《{ks_product_right}集群管理指南》的“节点”章节。 +endif::[] + +** 操作符：筛选条件的操作符。 + +*** 包含：键对应的值包含特定的字符串。 + +*** 不包含：键对应的值不包含特定的字符串。 + +*** 存在：节点标签中存在特定的键。 + +*** 不存在：节点标签中不存在特定的键。 + +** 值: 键对应的值必须包含的字符串。按 **Enter** 可设置多个字符串，键对应的值包含其中一个字条串即满足条件。 + +** 点击**添加**可同时创建多个标签。 + +** 在已添加的标签右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] 可删除标签。 + +* **自定义** + +通过自定义表达式来筛选符合条件的节点。有关表达式的更多信息，请参阅link:https://docs.tigera.io/calico/latest/reference/resources/ippool#node-selector[节点选择器]。 + +|IPIP 模式 + +|IPIP 模式属于 Overlay 模式之一，不能与 VXLAN 模式同时设置。若两者都设置为 Never，则使用 BGP 模式。 + +IPIP 模式: 在每个节点上创建一个 IP in IP 隧道来实现容器之间的通信。取值如下: + +** Always: 永远进行 IPIP 封装（默认）。 + +** CrossSubnet: 只在跨网段时才进行 IPIP 封装。 + +** Never: 从不进行 IPIP 封装。 + + +|VXLAN 模式 + +|VXLAN 模式属于 Overlay 模式之一，不能与 IPIP 模式同时设置。若两者都设置为 Never，则使用 BGP 模式。 + +VXLAN 模式：在每个节点上创建一个 VXLAN 隧道来实现容器之间的通信。取值如下: + +** Always: 永远进行 VXLAN 封装。 + +** CrossSubnet: 只在跨网段时才进行 VXLAN 封装。 + +** Never: 从不进行 VXLAN 封装。 +|=== + +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/02-view-a-pod-ip-pool-list.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/02-view-a-pod-ip-pool-list.adoc new file mode 100644 index 000000000..53b9f9b0c --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/02-view-a-pod-ip-pool-list.adoc @@ -0,0 +1,77 @@ +--- +title: "查看容器组 IP 池列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 容器组 IP 池, 查看容器组 IP 池列表" +description: "介绍如何查看容器组 IP 池列表。" +weight: 02 +--- + +:ks_permission: **集群网络资源查看** +:ks_navigation: **网络 > 容器组 IP 池** + + +本节介绍如何查看容器组 IP 池列表。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +* 容器组 IP 池列表提供以下信息： ++ +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|容器组 IP 池的名称。 + +|状态 +|容器组 IP 池的状态。 + +|网段 +|容器组 IP 池包含的网段。 + +|已用 IP 地址 +|容器组 IP 池中已经使用的 IP 地址数量和 IP 地址总数。 + +|IP 池块大小 +|IP 池用于分配 IP 的 block 的 CIDR 大小。 + +|Overlay 模式 +|容器之间的通信模式。支持 IPIP 模式和 VXLAN 模式。如果未设置，则使用 BGP 模式。 + +|NAT outgoing +|是否允许通过 NAT 方式跨 IP 池通信。 +|=== ++ +include::../../../../../_ks_components/admonitions/note.adoc[] + +{ks_product_right}安装完成后系统会自动创建容器组 IP 池 **default-ipv4-ippool**。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + ++ +* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的容器组 IP 池。 ++ +include::../../../../../_ks_components/oper-refreshListData.adoc[] ++ +include::../../../../../_ks_components/oper-customizeColumns.adoc[] + diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/03-view-pod-ip-pool-details.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/03-view-pod-ip-pool-details.adoc new file mode 100644 index 000000000..fbe71653f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/03-view-pod-ip-pool-details.adoc @@ -0,0 +1,89 @@ +--- +title: "查看容器组 IP 池详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 容器组 IP 池, 查看容器组 IP 池详情" +description: "介绍如何查看容器组 IP 池详情。" +weight: 03 +--- + +:ks_permission: **集群网络资源查看** +:ks_navigation: **网络 > 容器组 IP 池** + + +本节介绍如何查看容器组 IP 池详情。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在容器组 IP 池列表中点击一个容器组 IP 池的名称打开其详情页面。 + +. 在容器组 IP 池详情页面左侧的**属性**区域查看容器组 IP 池的基本信息。 ++ +-- + +[%header,cols="2,5"] +|=== +|参数 |描述 + +|状态 +|容器组 IP 池的状态。 + +|网段 +|容器组 IP 池包含的网段。 + +|已用 IP 地址 +|已使用的 IP 地址数量。 + +|IP 池块大小 +|IP 池用于分配 IP 的 block 的 CIDR 大小。 + +|NAT outgoing +|是否允许通过 NAT 方式跨 IP 池通信。 + +|Overlay 模式 +|容器之间的通信模式。支持 IPIP 模式和 VXLAN 模式。 + +|掩码 +|容器组 IP 池对应网段的掩码位数。 + +|网络 +|容器组 IP 池对应网络的 IP 地址。 + +|起始 IP 地址/结束 IP 地址 +|容器组 IP 池包含的 IP 地址范围。 + +|创建时间 +|容器组 IP 池的创建时间。 + +|创建者 +|创建容器组 IP 池的用户。 +|=== +-- + +. 在容器组 IP 池详情页面右侧的**项目**页签，查看可以使用容器组 IP 池的项目名称、已使用 IP 地址数量和项目管理员。 + +. 在容器组 IP 池右侧的**容器组**页签，查看使用容器组 IP 池的全部容器组。 ++ +-- +include::../../../../_custom/clusterManagement/nodes/nodes-para-podList.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/04-assign-a-project-to-a-ip-pool.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/04-assign-a-project-to-a-ip-pool.adoc new file mode 100644 index 000000000..8e909eebe --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/04-assign-a-project-to-a-ip-pool.adoc @@ -0,0 +1,47 @@ +--- +title: "将容器组 IP 池分配到项目" +keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 容器组 IP 池, 禁止自动分配" +description: "介绍如何禁用和启用容器组 IP 池自动分配。" +weight: 04 +--- + +:ks_permission: **集群网络资源管理** +:ks_navigation: **网络 > 容器组 IP 池** + + +本节介绍如何将容器组 IP 池分配到项目。 + +若项目被分配到容器组 IP 池，在该项目中创建工作负载和任务时，若不指定容器组 IP 池，项目中的容器组会默认分配到该容器组 IP 池。 + +若项目未分配到容器组 IP 池，即项目未与任何容器组 IP 池绑定，在该项目中创建工作负载和任务时，若不指定容器组 IP 池，项目中的容器组将被分配到任一可用的容器组 IP 池。 + +一个 IP 池可以分配给多个项目，一个项目可以绑定多个 IP 池。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + +. 在容器组 IP 池列表中点击一个容器组 IP 池的名称打开其详情页面。 + +. 在**项目**页签下点击**新增项目**，在下拉列表中选择一个项目，然后点击**确定**。 + +. 点击项目右侧的image:/images/ks-qkcp/zh/icons/trash-light.svg[trash,18,18]，解除容器组 IP 池和该项目的绑定。点击右上角的**移除全部**，解除容器组 IP 池和所有已分配项目的绑定。 ++ +移除项目后，项目将不再受该 IP 池的资源分配限制，已经分配 IP 地址的项目容器组不受影响。 diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/05-edit-pod-ip-pool-information.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/05-edit-pod-ip-pool-information.adoc new file mode 100644 index 000000000..88f2cb769 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/05-edit-pod-ip-pool-information.adoc @@ -0,0 +1,55 @@ +--- +title: "编辑容器组 IP 池信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 容器组 IP 池, 编辑容器组 IP 池信息" +description: "介绍如何编辑容器组 IP 池信息。" +weight: 05 +--- + +:ks_permission: **集群网络资源管理** +:ks_navigation: **网络 > 容器组 IP 池** + + +本节介绍如何编辑容器组 IP 池信息。 + +您可以编辑容器组 IP 池的别名和描述。{ks_product_right}不支持编辑容器组 IP 池的名称。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的容器组 IP 池右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置容器组 IP 池的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|容器组 IP 池的别名。不同容器组 IP 池的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|容器组 IP 池的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|=== +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/06-edit-overlay-mode.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/06-edit-overlay-mode.adoc new file mode 100644 index 000000000..93070f65c --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/06-edit-overlay-mode.adoc @@ -0,0 +1,72 @@ +--- +title: "编辑 Overlay 模式" +keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 容器组 IP 池, 编辑 Overlay 模式" +description: "介绍如何编辑 Overlay 模式。" +weight: 06 +--- + +:ks_permission: **集群网络资源管理** +:ks_navigation: **网络 > 容器组 IP 池** + + +本节介绍如何编辑 Overlay 模式。 + +Overlay 模式可以实现容器的跨主机互相通信，而无需对宿主机的物理网络进行改动。 + +== 前提条件 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ +* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的容器组 IP 池右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑 Overlay 模式**。 + +. 在**编辑 Overlay 模式**对话框，选择 IPIP 模式或 VXLAN 模式，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|模式 |描述 + +|IPIP 模式 +|在每个节点上创建一个 IP in IP 隧道来实现容器之间的通信。取值如下： + +** **Always**: 永远进行 IPIP 封装(默认)。 + +** **CrossSubnet**: 只在跨网段时才进行 IPIP 封装。 + +** **Never**: 从不进行 IPIP 封装。 + +|VXLAN 模式 +|在每个节点上创建一个 VXLAN 隧道来实现容器之间的通信。取值如下： + +** **Always**: 永远进行 VXLAN 封装。 + +** **CrossSubnet**: 只在跨网段时才进行 VXLAN 封装。 + +** **Never**: 从不进行 VXLAN 封装。 +|=== +-- + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +若两者都设置为 Never，则使用 BGP 模式。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/07-edit-yaml-for-a-pod-ip-pool.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/07-edit-yaml-for-a-pod-ip-pool.adoc new file mode 100644 index 000000000..2db777277 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/07-edit-yaml-for-a-pod-ip-pool.adoc @@ -0,0 +1,51 @@ +--- +title: "编辑节点选择" +keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 容器组 IP 池, 禁止自动分配" +description: "介绍如何设置容器组 IP 池的自动分配。" +weight: 07 +--- + +:ks_permission: **集群网络资源管理** +:ks_navigation: **网络 > 容器组 IP 池** + + +本节介绍如何编辑容器组 IP 池的自动分配节点，以便为容器组 IP 池自动匹配合适的节点。 + +创建容器组 IP 池时，默认其 IP 地址可分配给所有节点的容器组。您可以设置节点选择器，以限制符合特定条件的节点上的容器组才能使用该 IP 池的 IP 地址。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的容器组 IP 池右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑 yaml**。 + +. 在 **spec.nodeSelector** 参数下输入表达式，通过自定义表达式来筛选符合条件的节点。有关表达式的更多信息，请参阅link:https://docs.tigera.io/calico/latest/reference/resources/ippool#node-selector[节点选择器]。 + + +[.admon.attention,cols="a"] +|=== +|注意 + +| +* 容器组 IP 池的 CIDR 不得与节点的 CIDR 以及服务的 CIDR 重复。 +* 修改相关字段时，您必须明确操作后带来的影响，请谨慎操作。 +|=== diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/08-disable-and-enable-pod-ip-pool.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/08-disable-and-enable-pod-ip-pool.adoc new file mode 100644 index 000000000..2bc3dd03f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/08-disable-and-enable-pod-ip-pool.adoc @@ -0,0 +1,56 @@ +--- +title: "禁用和启用容器组 IP 池" +keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 容器组 IP 池, 禁用和启用容器组 IP 池" +description: "介绍如何禁用和启用容器组 IP 池。" +weight: 08 +--- + +:ks_permission: **集群网络资源管理** +:ks_navigation: **网络 > 容器组 IP 池** + + +本节介绍如何禁用和启用容器组 IP 池。 + +容器组 IP 池禁用后将不会继续 IP 地址的分配，也不会影响已经分配 IP 地址的容器组的网络，但禁用容器组 IP 池会自动解除其绑定的项目。迁移容器组 IP 池时，新 IP 池可用地址数量不能少于当前 IP 池使用的 IP 地址。 + +//warning +[.admon.warning,cols="a"] +|=== +|警告 + +| +迁移完成后，将重启工作负载。请谨慎执行此操作。 + +|=== + +== 前提条件 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ +* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ +. 在需要操作的容器组 IP 池右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**禁用**。 + +. 在**禁用容器组 IP 池**对话框，点击**确定**。 + +. 在已禁用的容器组 IP 池右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**启用**可启用容器组 IP 池。 + ++ +-- +若被禁用的容器组 IP 池中有已分配的 IP，勾选**迁移容器组 IP 池**，可将已经分配 IP 地址的容器组迁移至新的容器组 IP 池。 +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/09-delete-pod-ip-pools.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/09-delete-pod-ip-pools.adoc new file mode 100644 index 000000000..6c17d0abf --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/09-delete-pod-ip-pools.adoc @@ -0,0 +1,68 @@ +--- +title: "删除容器组 IP 池" +keywords: "Kubernetes, {ks_product}, 集群管理, 网络, 容器组 IP 池, 删除容器组 IP 池信息" +description: "介绍如何删除容器组 IP 池。" +weight: 09 +--- + +:ks_permission: **集群网络资源管理** +:ks_navigation: **网络 > 容器组 IP 池** + + +本节介绍如何删除容器组 IP 池。 + +// Warning +include::../../../../../_ks_components/admonitions/warning.adoc[] + +容器组 IP 池删除后不能恢复，请谨慎执行此操作。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网络**扩展组件。 + + +include::../../../../_custom/clusterManagement/podIpPools/podIpPools-prer-notUsed.adoc[] + + +== 删除单个容器组 IP 池 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要删除的容器组 IP 池右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除容器组 IP 池**对话框，输入容器组 IP 池的名称，然后点击**确定**。 + + +== 批量删除容器组 IP 池 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 选择需要删除的容器组 IP 池左侧的复选框，然后在容器组 IP 池列表上方点击**删除**。 + +. 在**批量删除容器组 IP 池**对话框，输入容器组 IP 池的名称，然后点击**确定**。 ++ +-- +include::../../../../_custom/note-separateNamesByComma.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/_index.adoc new file mode 100644 index 000000000..092f344c7 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/02-pod-ip-pools/_index.adoc @@ -0,0 +1,11 @@ +--- +title: "容器组 IP 池" +keywords: "Kubernetes, {ks_product}, 集群管理, 容器组 IP 池" +description: "介绍如何管理集群容器组 IP 池。" +weight: 02 +--- + + +本节介绍如何管理集群的容器组 IP 池。 + +容器组 IP 池用于为容器组分配 IP 地址。每个容器组 IP 池包含一个可在集群内部访问的私网 IP 网段，您可以在创建工作负载或任务时指定容器组 IP 池。 diff --git a/content/zh/docs/v4.1/11-use-extensions/11-network/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/11-network/_index.adoc new file mode 100644 index 000000000..900ac6c7a --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/11-network/_index.adoc @@ -0,0 +1,18 @@ +--- +title: "KubeSphere 网络" +keywords: "Kubernetes, {ks_product}, 集群管理, 项目管理, 网络, 网络策略, 容器组 IP 池, 网络隔离" +description: "介绍如何管理网络策略和容器组 IP 池。" +weight: 11 +--- + + +本节介绍如何使用“KubeSphere 网络”扩展组件来管理集群的网络策略和容器组 IP 池，以及企业空间和项目的网络隔离配置。 + +“KubeSphere 网络”扩展组件包含网络策略和容器组 IP 池两个组件。使用该扩展组件，您可以控制集群和项目中容器组的访问和被访问权限；当创建工作负载或任务时，通过选择**容器组 IP 池**，为容器组分配 IP 地址，确保每个容器组都有一个唯一的 IP 地址。 + +安装“KubeSphere 网络”扩展组件后， + +- 集群左侧导航栏的**网络**菜单下将显⽰**网络策略**和**容器组 IP 池**选项； +- 企业空间左侧导航栏的**基本信息**页面将支持启用企业空间网络隔离； +- 项目左侧导航栏的**项目设置**菜单下将显⽰**网络隔离**选项。 +- 创建工作负载或任务时，**高级设置**页签将显示**容器组 IP 池**选项。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/01-enable-a-project-gateway.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/01-enable-a-project-gateway.adoc new file mode 100644 index 000000000..2fb571699 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/01-enable-a-project-gateway.adoc @@ -0,0 +1,44 @@ +--- +title: "启用项目网关" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 网关设置, 启用项目网关" +description: "介绍如何启用项目网关。" +weight: 01 +--- + + +:ks_permission: **项目网关管理** +:ks_navigation: **项目设置 > 网关设置** + + +本节介绍如何启用项目网关。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在页面右侧点击**启用网关**。 + +. 在弹出的对话框，设置网关的参数，然后点击**确定**。 ++ +-- +include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway_v4.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/02-view-project-gateway-information.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/02-view-project-gateway-information.adoc new file mode 100644 index 000000000..9be95e282 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/02-view-project-gateway-information.adoc @@ -0,0 +1,38 @@ +--- +title: "查看项目网关信息" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 网关设置, 查看项目网关信息" +description: "介绍如何查看项目网关信息。" +weight: 02 +--- + +:ks_permission: **项目网关查看** +:ks_navigation: **项目设置 > 网关设置** + + +本节介绍如何查看项目网关信息。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +-- +**网关设置**页面提供以下信息： + +include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-para-gatewayCard.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/03-view-project-gateway-details.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/03-view-project-gateway-details.adoc new file mode 100644 index 000000000..36847c84b --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/03-view-project-gateway-details.adoc @@ -0,0 +1,37 @@ +--- +title: "查看项目网关详情" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 网关设置, 查看项目网关详情" +description: "介绍如何查看项目网关详情。" +weight: 03 +--- + + +:ks_permission: **项目网关查看** +:ks_navigation: **项目设置 > 网关设置** + + +本节介绍如何查看项目网关详情。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/04-edit-project-gateway-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/04-edit-project-gateway-settings.adoc new file mode 100644 index 000000000..6e09381c9 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/04-edit-project-gateway-settings.adoc @@ -0,0 +1,37 @@ +--- +title: "编辑项目网关设置" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 网关设置, 编辑项目网关设置" +description: "介绍如何编辑项目网关设置。" +weight: 04 +--- + + +:ks_permission: **项目网关管理** +:ks_navigation: **项目设置 > 网关设置** + + +本节介绍如何编辑项目网关设置。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings_v4.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/05-disable-a-project-gateway.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/05-disable-a-project-gateway.adoc new file mode 100644 index 000000000..32123bf95 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/05-disable-a-project-gateway.adoc @@ -0,0 +1,38 @@ +--- +title: "禁用项目网关" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 网关设置, 禁用项目网关" +description: "介绍如何禁用项目网关。" +weight: 05 +--- + +:ks_permission: **项目网关管理** +:ks_navigation: **项目设置 > 网关设置** + + +本节介绍如何禁用项目网关。 + +include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-warn-disableGateway.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-disableGateway.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/_index.adoc new file mode 100644 index 000000000..fbfa88175 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/01-project-gateway/_index.adoc @@ -0,0 +1,22 @@ +--- +title: "项目网关" +keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 网关设置" +description: "介绍如何管理项目网关。" +weight: 01 +--- + + + +本节介绍如何管理项目网关。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +项目网关启用后，除了在项目网关设置页面对其进行管理，还可以在集群和企业空间的网关设置页面查看、编辑和禁用项目网关。 +|=== + + + diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/01-enable-workspace-gateway.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/01-enable-workspace-gateway.adoc new file mode 100644 index 000000000..6516c14c6 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/01-enable-workspace-gateway.adoc @@ -0,0 +1,52 @@ +--- +title: "启用企业空间网关" +keywords: "Kubernetes, {ks_product}, 企业空间管理, 企业空间设置,启用企业空间网关" +description: "介绍如何启用企业空间网关。" +weight: 01 +--- + +:ks_permission: **企业空间网关管理** +:ks_navigation: **企业空间设置 > 网关设置** + + +本节介绍如何启用企业空间网关。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在页面右侧的**网关设置**页面，点击**启用网关**。 ++ +-- +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +不支持在企业空间的**网关设置**页面启用项目网关。如果您需要启用项目网关，请前往对应的项目。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +. 在弹出的**启用网关**对话框，设置网关的参数，然后点击**确定**。 ++ +-- +include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway_v4.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/02-view-workspace-gateway-info.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/02-view-workspace-gateway-info.adoc new file mode 100644 index 000000000..f72c048c9 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/02-view-workspace-gateway-info.adoc @@ -0,0 +1,47 @@ +--- +title: "查看企业空间网关信息" +keywords: "Kubernetes, {ks_product}, 企业空间管理, 企业空间设置, 网关设置, 查看企业空间网关信息" +description: "介绍如何查看企业空间网关信息。" +weight: 02 +--- + + +:ks_permission: **企业空间网关查看** +:ks_navigation: **企业空间设置 > 网关设置** + + +本节介绍如何查看企业空间网关信息。 + +[.admon.note,cols="a"] +|=== +|说明 + +| +如果已启用集群网关，在企业空间的网关设置页面也可以查看集群网关的信息。 +|=== + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +-- +**网关设置**页面提供以下信息： + +include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-para-gatewayCard.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/03-view-workspace-gateway-details.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/03-view-workspace-gateway-details.adoc new file mode 100644 index 000000000..ec2bb298e --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/03-view-workspace-gateway-details.adoc @@ -0,0 +1,37 @@ +--- +title: "查看企业空间网关详情" +keywords: "Kubernetes, {ks_product}, 企业空间管理, 企业空间设置, 网关设置, 查看企业空间网关详情" +description: "介绍如何查看企业空间网关详情。" +weight: 03 +--- + + +:ks_permission: **企业空间网关查看** +:ks_navigation: **企业空间设置 > 网关设置** + + +本节介绍如何查看企业空间网关详情。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails_v4.adoc[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/04-edit-workspace-gateway-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/04-edit-workspace-gateway-settings.adoc new file mode 100644 index 000000000..b3aed5e67 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/04-edit-workspace-gateway-settings.adoc @@ -0,0 +1,37 @@ +--- +title: "编辑企业空间网关设置" +keywords: "Kubernetes, {ks_product}, 企业空间管理, 企业空间设置, 网关设置,编辑企业空间网关设置" +description: "介绍如何编辑企业空间网关设置。" +weight: 04 +--- + +:ks_permission: **企业空间网关管理** +:ks_navigation: **企业空间设置 > 网关设置** + + +本节介绍如何编辑企业空间网关设置。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings_v4.adoc[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/05-disable-workspace-gateway.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/05-disable-workspace-gateway.adoc new file mode 100644 index 000000000..1b771d595 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/05-disable-workspace-gateway.adoc @@ -0,0 +1,39 @@ +--- +title: "禁用企业空间网关" +keywords: "Kubernetes, {ks_product}, 企业空间管理, 企业空间设置, 网关设置,禁用企业空间网关" +description: "介绍如何禁用企业空间网关。" +weight: 05 +--- + +:ks_permission: **企业空间网关管理** +:ks_navigation: **企业空间设置 > 网关设置** + + +本节介绍如何禁用企业空间网关。 + +include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-warn-disableGateway.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/workspaceManagement/workspaceManagement-oper-openWorkspacePage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-disableGateway.adoc[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/_index.adoc new file mode 100644 index 000000000..fc565b48f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/02-workspace-gateway/_index.adoc @@ -0,0 +1,19 @@ +--- +title: "企业空间网关" +keywords: "Kubernetes, {ks_product}, 网关设置, 企业空间，网关设置" +description: "介绍本节介绍如何设置企业空间网关。" +weight: 02 +--- + + + +本节介绍如何管理企业空间网关。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +企业空间网关启用后，除了在企业空间网关设置页面对其进行管理，还可以在集群网关设置页面查看、编辑和禁用企业空间网关。 +|=== diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/01-enable-a-cluster-gateway.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/01-enable-a-cluster-gateway.adoc new file mode 100644 index 000000000..969210698 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/01-enable-a-cluster-gateway.adoc @@ -0,0 +1,52 @@ +--- +title: "启用集群网关" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 网关设置, 启用集群网关" +description: "介绍如何启用集群网关。" +weight: 01 +--- + +// :ks_permission: **集群设置管理** +:ks_navigation: **集群设置 > 网关设置** + + +本节介绍如何启用集群网关。 + +[.admon.attention,cols="a"] +|=== +|注意 + +| +若未启用企业空间网关或项目网关，启用集群网关后，将不能再启用企业空间网关和项目网关。 +|=== + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 + +// :relfileprefix: ../../../../ +// * {empty} +// include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +// :relfileprefix: ./ + +* 您需要加入一个集群并在集群中具有 **cluster-admin** 角色。有关更多信息，请参阅link:../../../../07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和link:../../../../07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 + + +== 操作步骤 + +// include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + +. 以具有 **cluster-admin** 角色的用户登录{ks_product_left} Web 控制台。 ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在页面右侧点击**启用网关**。 + +. 在弹出的对话框，设置网关的参数，然后点击**确定**。 ++ +-- +include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-para-enableGateway_v4.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/02-view-gateway-information.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/02-view-gateway-information.adoc new file mode 100644 index 000000000..d3ce94ff1 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/02-view-gateway-information.adoc @@ -0,0 +1,44 @@ +--- +title: "查看网关信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 网关设置, 查看网关信息" +description: "介绍如何查看网关信息。" +weight: 02 +--- + +// :ks_permission: **集群设置查看** +:ks_navigation: **集群设置 > 网关设置** + + +本节介绍如何查看网关信息。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 + +// :relfileprefix: ../../../../ +// * {empty} +// include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +// :relfileprefix: ./ + +* 您需要加入一个集群并在集群中具有 **cluster-admin** 角色。有关更多信息，请参阅link:../../../../07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和link:../../../../07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 + + +== 操作步骤 + +// include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + +. 以具有 **cluster-admin** 角色的用户登录{ks_product_left} Web 控制台。 + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**网关设置**页面，点击**集群网关**，查看集群网关的信息。 ++ +-- +include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-para-gatewayCard.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/03-view-cluster-gateway-details.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/03-view-cluster-gateway-details.adoc new file mode 100644 index 000000000..1f1fe57d0 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/03-view-cluster-gateway-details.adoc @@ -0,0 +1,40 @@ +--- +title: "查看集群网关详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 网关设置, 查看集群网关详情" +description: "介绍如何查看网关信息。" +weight: 03 +--- + +:ks_permission: **集群设置查看** +:ks_navigation: **集群设置 > 网关设置** + + +本节介绍如何查看集群网关详情。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 + +// :relfileprefix: ../../../../ +// * {empty} +// include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +// :relfileprefix: ./ + +* 您需要加入一个集群并在集群中具有 **cluster-admin** 角色。有关更多信息，请参阅link:../../../../07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和link:../../../../07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 + + +== 操作步骤 + +// include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + +. 以具有 **cluster-admin** 角色的用户登录{ks_product_left} Web 控制台。 + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-viewGatewayDetails_v4.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/04-edit-cluster-gateway-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/04-edit-cluster-gateway-settings.adoc new file mode 100644 index 000000000..0cd9fe12f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/04-edit-cluster-gateway-settings.adoc @@ -0,0 +1,39 @@ +--- +title: "编辑集群网关设置" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 网关设置, 编辑集群网关设置" +description: "介绍如何编辑集群网关设置。" +weight: 04 +--- + +// :ks_permission: **集群设置管理** +:ks_navigation: **集群设置 > 网关设置** + + +本节介绍如何编辑集群网关设置。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 + +// :relfileprefix: ../../../../ +// * {empty} +// include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +// :relfileprefix: ./ + +* 您需要加入一个集群并在集群中具有 **cluster-admin** 角色。有关更多信息，请参阅link:../../../../07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和link:../../../../07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 + + +== 操作步骤 + +// include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] +. 以具有 **cluster-admin** 角色的用户登录{ks_product_left} Web 控制台。 + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-editGatewaySettings_v4.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/05-disable-a-cluster-gateway.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/05-disable-a-cluster-gateway.adoc new file mode 100644 index 000000000..a91574c8e --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/05-disable-a-cluster-gateway.adoc @@ -0,0 +1,42 @@ +--- +title: "禁用集群网关" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 网关设置, 禁用集群网关" +description: "介绍如何禁用集群网关。" +weight: 05 +--- + + +// :ks_permission: **集群设置管理** +:ks_navigation: **集群设置 > 网关设置** + + +本节介绍如何禁用集群网关。 + +include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-warn-disableGateway.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 网关**扩展组件。 + +// :relfileprefix: ../../../../ +// * {empty} +// include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +// :relfileprefix: ./ + +* 您需要加入一个集群并在集群中具有 **cluster-admin** 角色。有关更多信息，请参阅link:../../../../07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和link:../../../../07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 + + +== 操作步骤 + +// include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] +. 以具有 **cluster-admin** 角色的用户登录{ks_product_left} Web 控制台。 + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-oper-disableGateway.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/_index.adoc new file mode 100644 index 000000000..96d7557a5 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/03-cluster-gateway/_index.adoc @@ -0,0 +1,20 @@ +--- +title: "集群网关" +keywords: "Kubernetes, {ks_product}, 集群管理, 集群设置, 网关设置" +description: "介绍如何管理集群网关和项目网关。" +weight: 03 +--- + + + +本节介绍如何管理集群网关。 + +//note +[.admon.note,cols="a"] +|=== +|说明 + +| +若已启用企业空间网关或项目网关，可在集群的网关设置页面查看、编辑和禁用企业空间网关或项目网关。 +|=== + diff --git a/content/zh/docs/v4.1/11-use-extensions/12-gateway/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/12-gateway/_index.adoc new file mode 100644 index 000000000..f85ec61b5 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/12-gateway/_index.adoc @@ -0,0 +1,35 @@ +--- +title: "KubeSphere 网关" +weight: 12 +--- + +本节介绍如何使用“KubeSphere 网关”扩展组件，启用和管理集群、企业空间和项目的网关。 + +include::../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-desc-gateway.adoc[] + +{ks_product_right}对每个集群提供一个集群网关，对集群中每个企业空间提供一个企业空间网关，并且对企业空间中每个项目提供一个项目网关，分别用于为整个集群、单个企业空间和单个项目中的服务提供反向代理。 + +安装“KubeSphere 网关”组件后， + +* 集群左侧导航栏的**集群设置**菜单下将显⽰**网关设置**选项； +* 企业空间左侧导航栏的**企业空间设置**菜单下将显⽰**网关设置**选项； +* 项目左侧导航栏的**项目设置**菜单下将显⽰**网关设置**选项。 + +[.admon.tip,cols="a"] +|=== +|提示 + +| +启用集群网关、企业空间网关、或项目网关后，在集群或项目的**应用负载 > 应用路由**菜单下创建应用路由时，可在**高级设置**页签选择对应网关的 IngressClassName。 +|=== + + +[.admon.note,cols="a"] +|=== +|说明 + +| +* 如需使用链路追踪功能，{ks_product_right}平台需要安装并启用 **KubeSphere 服务网格**扩展组件。 +* 如需使用网关监控功能，{ks_product_right}平台需要安装并启用 **WhizardTelemetry 监控**扩展组件。 +* 如需使用网关日志搜索功能，{ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志管理**扩展组件。 +|=== \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/01-create-a-volume-snapshot.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/01-create-a-volume-snapshot.adoc new file mode 100644 index 000000000..4931abdbb --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/01-create-a-volume-snapshot.adoc @@ -0,0 +1,66 @@ +--- +title: "创建卷快照" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照, 创建卷快照" +description: "介绍如何创建卷快照。" +weight: 01 +--- + +:ks_permission: **卷快照管理** +:ks_navigation: **存储 > 卷快照** + + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-desc-createAVolumeSnapshot.adoc[] + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-para-volumeSnapshot.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] + +:relfileprefix: ./ + + +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc[] + +// :relfileprefix: ../../../../ +// * 请确保后端存储系统支持卷快照功能，并已在持久卷声明对应的存储类上启用卷快照功能。有关更多信息，请参阅xref:07-cluster-management/08-storage/02-storage-classes/05-enable-and-disable-volume-operations.adoc[启用和禁用卷操作]。 + +// :relfileprefix: ./ + +* 请确保后端存储系统支持卷快照功能，并已在持久卷声明对应的存储类上启用卷快照功能。操作方法：存储类 > 更多操作 > 设置卷操作 > 启用卷快照创建。 + +== 方法 1：卷快照 > 创建卷快照 + +在集群中，可在**卷快照**菜单下直接为持久卷声明创建卷快照。 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAVolumeSnapshot.adoc[] + +== 方法 2：持久卷声明 > 创建卷快照 + +在集群或项目中，可在**持久卷声明**菜单下为持久卷声明创建卷快照。 + +. 以具有**持久卷声明管理**权限以及pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 + +. 在左侧导航栏选择**存储 > 持久卷声明**。 + +. 在持久卷声明列表中点击一个持久卷声明的名称打开其详情页面。 ++ +include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-createAVolumeSnapshot.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/02-view-a-volume-snapshot-list.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/02-view-a-volume-snapshot-list.adoc new file mode 100644 index 000000000..c241a3f4b --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/02-view-a-volume-snapshot-list.adoc @@ -0,0 +1,45 @@ +--- +title: "查看卷快照列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照, 查看卷快照列表" +description: "介绍如何查看卷快照。" +weight: 02 +--- + + +:ks_permission: **卷快照查看** +:ks_navigation: **存储 > 卷快照** + + +include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewAVolumeSnapshotList.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +==== +include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotList_v4.adoc[] + +* 在列表左上角的下拉列表中选择一个项目，可查看特定项目中的卷快照。 + +include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-searchForVolumeSnapshots.adoc[] + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/03-view-volume-snapshot-details.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/03-view-volume-snapshot-details.adoc new file mode 100644 index 000000000..4a4b7cd82 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/03-view-volume-snapshot-details.adoc @@ -0,0 +1,41 @@ +--- +title: "查看卷快照详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照, 查看卷快照详情" +description: "介绍如何查看卷快照的详情。" +weight: 03 +--- + + +:ks_permission: **卷快照查看** +:ks_navigation: **存储 > 卷快照** + + +include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-viewVolumeSnapshotDetails.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-viewVolumeSnapshotDetails_v4.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/04-create-a-persistent-volume-from-a-volume-snapshot.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/04-create-a-persistent-volume-from-a-volume-snapshot.adoc new file mode 100644 index 000000000..436960ab3 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/04-create-a-persistent-volume-from-a-volume-snapshot.adoc @@ -0,0 +1,41 @@ +--- +title: "使用卷快照创建持久卷" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照, 创建持久卷声明" +description: "介绍如何使用卷快照创建持久卷。" +weight: 04 +--- + + +:ks_permission: **卷快照管理** +:ks_navigation: **存储 > 卷快照** + + +include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-createAPersistentVolumeFromAVolumeSnapshot.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-openDetailsPage.adoc[] + ++ + +include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-createAPersistentVolumeFromAVolumeSnapshot.adoc[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/05-delete-volume-snapshots.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/05-delete-volume-snapshots.adoc new file mode 100644 index 000000000..2359be770 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/05-delete-volume-snapshots.adoc @@ -0,0 +1,51 @@ +--- +title: "删除卷快照" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照, 删除卷快照" +description: "介绍如何删除卷快照。" +weight: 05 +--- + + +:ks_permission: **卷快照管理** +:ks_navigation: **存储 > 卷快照** + + +include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-deleteVolumeSnapshots.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_clusterandproject.adoc[] + +:relfileprefix: ./ + + + +== 删除单个卷快照 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteASingleVolumeSnapshot.adoc[] + + +== 批量删除卷快照 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-oper-deleteMultipleVolumeSnapshots.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/06-view-a-volume-snapshot-content-list.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/06-view-a-volume-snapshot-content-list.adoc new file mode 100644 index 000000000..9a4bd778d --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/06-view-a-volume-snapshot-content-list.adoc @@ -0,0 +1,80 @@ +--- +title: "查看卷快照内容列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照, 查看卷快照列表" +description: "介绍如何查看卷快照。" +weight: 06 +--- + + +:ks_permission: **卷快照内容查看** +:ks_navigation: **存储 > 卷快照** + + +本节介绍如何查看卷快照内容列表。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-oper-openListPage.adoc[] + ++ +==== +* 卷快照列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|卷快照内容的名称。 + +|状态 +| +include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-status.adoc[] + +|容量 +| +include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-capacity.adoc[] + +|卷快照类 +| +include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-volumeSnapshotClass.adoc[] + +|删除策略 +| +include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc[] + +|创建时间 +|卷快照内容的创建时间。 +|=== +-- + +* 在列表左上角的下拉列表中选择一个项目，可查看特定项目中的卷快照。 + +* 在列表上方点击搜索框并设置搜索条件，可按名称或状态搜索卷快照内容。 + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/07-view-volume-snapshot-content-details.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/07-view-volume-snapshot-content-details.adoc new file mode 100644 index 000000000..386e10844 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/07-view-volume-snapshot-content-details.adoc @@ -0,0 +1,84 @@ +--- +title: "查看卷快照内容详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 卷快照内容, 查看卷快照内容详情" +description: "介绍如何查看集群中持久卷的详情。" +weight: 07 +--- + +:ks_permission: **卷快照内容查看** +:ks_navigation: **存储 > 卷快照** + + +本节介绍如何查看卷快照内容详情。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在**卷快照**页面点击**卷快照内容**，然后点击一个卷快照内容的名称打开其详情页面。 + +. 在卷快照内容详情页面左侧的**属性**区域查看卷快照的资源属性。 ++ +-- + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|状态 +| +include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-status.adoc[] + +|容量 +| +include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-capacity.adoc[] + +|卷快照类 +| +include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-volumeSnapshotClass.adoc[] + +|快照句柄 +|卷快照内容在后端存储系统的唯一标识符。 + +|供应者 +|卷快照类对应的存储插件。 + +|删除策略 +| +include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc[] + +|创建时间 +|卷快照内容的创建时间。 + +|创建者 +|创建卷快照内容的用户。 +|=== +-- + +. 在持久卷详情页面右侧的**资源状态**页签查看卷快照内容对应的卷快照名称和卷快照类。 + +. 在持久卷详情页面右侧点击**元数据**页签查看卷快照内容的标签和注解。 + +. 在持久卷详情页面右侧点击**事件**页签查看卷快照内容的事件。 ++ +-- +include::../../../../_custom/clusterManagement/clusterManagement-para-eventsTab.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/08-edit-volume-snapshot-content-information.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/08-edit-volume-snapshot-content-information.adoc new file mode 100644 index 000000000..bdd324c80 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/08-edit-volume-snapshot-content-information.adoc @@ -0,0 +1,57 @@ +--- +title: "编辑卷快照内容信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 卷快照内容" +description: "介绍如何编辑卷快照内容的信息。" +weight: 08 +--- + +:ks_permission: **卷快照内容管理** +:ks_navigation: **存储 > 卷快照** + + +本节介绍如何编辑卷快照内容的信息。 + +您可以编辑卷快照内容的别名和描述。{ks_product_right}不支持编辑卷快照内容的名称。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-oper-openListPage.adoc[] + ++ + +. 在需要操作的卷快照内容右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置卷快照内容的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|卷快照内容的别名。不同卷快照内容的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|卷快照内容的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|=== +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/09-delete-a-volume-snapshot-content.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/09-delete-a-volume-snapshot-content.adoc new file mode 100644 index 000000000..0be3ad3da --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/09-delete-a-volume-snapshot-content.adoc @@ -0,0 +1,82 @@ +--- +title: "删除卷快照内容" +keywords: "Kubernetes, {ks_product}, 集群管理, 卷快照内容, 删除卷快照内容" +description: "介绍如何编辑卷快照内容的信息。" +weight: 09 +--- + + +:ks_permission: **卷快照内容管理** +:ks_navigation: **存储 > 卷快照** + + +本节介绍如何删除卷快照内容。 + +[.admon.note,cols="a"] +|=== +|说明 + +| +当卷快照和卷快照内容绑定的时候，卷快照内容不允许删除。若要删除卷快照内容，必须首先删除卷快照。卷快照被删除后，系统将根据卷快照内容的删除策略，决定是否自动删除卷快照内容。 +|=== + +// Warning +include::../../../../../_ks_components/admonitions/warning.adoc[] + +卷快照内容删除后无法恢复，并且后端存储系统中保存的快照数据也将被删除，请谨慎执行此操作以避免快照数据丢失。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 删除单个卷快照内容 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-oper-openListPage.adoc[] + ++ + +. 在需要删除的卷快照内容右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除卷快照内容**对话框，输入卷快照内容的名称，然后点击**确定**。 + + +== 批量删除卷快照内容 + +. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的集群或项目。 + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-oper-openListPage.adoc[] + ++ + +. 选择需要删除的卷快照内容左侧的复选框，然后在列表上方点击**删除**。 + +. 在**批量删除卷快照内容**对话框，输入卷快照的名称，然后点击**确定**。 ++ +-- +include::../../../../_custom/note-separateNamesByComma.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/_index.adoc new file mode 100644 index 000000000..8ab33f683 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/13-storage/03-volume-snapshots/_index.adoc @@ -0,0 +1,17 @@ +--- +title: "卷快照" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照" +description: "介绍如何管理卷快照。" +weight: 03 +--- + + +include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-desc-volumeSnapshots.adoc[] + +[.admon.note,cols="a"] +|=== +|说明 + +| +如果您在安装{ks_product_both}时未指定外部持久化存储系统，{ks_product_right}将使用集群节点的本地存储系统作为持久化存储系统。通常情况下，集群节点的本地存储系统不支持卷快照功能。创建卷快照前，您需要为{ks_product_both}集群安装存储插件，确保后端存储系统支持卷快照功能，并创建link:../04-volume-snapshot-classes/01-create-a-volume-snapshot-class[卷快照类]。 +|=== diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/01-create-a-volume-snapshot-class.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/01-create-a-volume-snapshot-class.adoc new file mode 100644 index 000000000..2a8492769 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/01-create-a-volume-snapshot-class.adoc @@ -0,0 +1,81 @@ + +--- +title: "创建卷快照类" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照, 创建卷快照类" +description: "介绍如何创建卷快照。" +weight: 01 +--- + + +:ks_permission: **卷快照类管理** +:ks_navigation: **存储 > 卷快照类** + + +本节介绍如何创建卷快照类。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* 为使卷快照类可以正常提供存储资源，您需要提前配置存储系统并安装与存储系统对应的存储插件。有关更多信息，请联系您的存储系统提供商。 + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**基本信息**页签，设置卷快照类的基本信息，然后点击**下一步**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|卷快照类的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 + +|存储类型 +|块存储、对象存储或文件存储。 + +|别名 +|卷快照类的别名。不同卷快照类的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|卷快照类的描述信息。描述可包含任意字符，最长 256 个字符。 +|=== +-- + +. 在**卷快照类设置**页签，设置卷快照类的供应者和删除策略，然后点击**创建**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|供应者 +|卷快照类使用的存储插件。 + +|删除策略 +| +include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc[] +|=== + +卷快照类创建完成后将显示在卷快照类列表中。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/02-view-a-volume-snapshot-class-list.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/02-view-a-volume-snapshot-class-list.adoc new file mode 100644 index 000000000..3cb6b40c6 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/02-view-a-volume-snapshot-class-list.adoc @@ -0,0 +1,69 @@ +--- +title: "查看卷快照类列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照类, 查看卷快照类列表" +description: "介绍如何查看卷快照类列表。" +weight: 02 +--- + + +:ks_permission: **卷快照类查看** +:ks_navigation: **存储 > 卷快照类** + + +本节介绍如何查看卷快照类列表。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ +==== +* 卷快照类列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|卷快照类的名称、别名和描述信息。 + +|卷快照 +|通过卷快照类创建的卷快照数量。 + +|供应者 +|卷快照类使⽤的存储插件。 + +|删除策略 +| +include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc[] + +|创建时间 +|卷快照类的创建时间。 +|=== + +-- + +* 在列表上方点击搜索框并设置搜索条件，可搜索名称搜索卷快照类。 + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/03-view-volume-snapshot-class-details.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/03-view-volume-snapshot-class-details.adoc new file mode 100644 index 000000000..43086c33a --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/03-view-volume-snapshot-class-details.adoc @@ -0,0 +1,83 @@ +--- +title: "查看卷快照类详情" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照类, 查看卷快照类详情" +description: "介绍如何查看卷快照类详情。" +weight: 03 +--- + +:ks_permission: **卷快照类查看** +:ks_navigation: **存储 > 卷快照类** + + +本节介绍如何查看卷快照类详情。 + + +== 前提条件 + + +* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在卷快照类列表中点击一个卷快照类的名称打开卷快照类详情页面。 + +. 在卷快照类详情页面左侧的**属性**区域查看卷快照类的资源属性。 ++ +-- + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|供应者 +| +卷快照类对应的存储插件。 + +|删除策略 +| +include::../../../../_custom/clusterManagement/volumeSnapshotContents/volumeSnapshotContents-para-deletionPolicy.adoc[] + +|创建时间 +|卷快照类的创建时间。 +|=== +-- + +. 在卷快照类详情页面右侧的**卷快照**区域查看使用卷快照类创建的卷快照。 ++ +-- + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|卷快照的名称。 + +|状态 +| +include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-para-volumeSnapshotStatus_v4.adoc[] + +|容量 +| +include::../../../../_custom/clusterManagement/volumeSnapshots/volumeSnapshots-para-capacity.adoc[] + +|创建时间 +|卷快照的创建时间。 +|=== +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/04-edit-volume-snapshot-class-information.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/04-edit-volume-snapshot-class-information.adoc new file mode 100644 index 000000000..11b38fd08 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/04-edit-volume-snapshot-class-information.adoc @@ -0,0 +1,55 @@ +--- +title: "编辑卷快照类信息" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照类, 编辑卷快照类信息" +description: "介绍如何编辑卷快照类的信息。" +weight: 04 +--- + + +:ks_permission: **卷快照类管理** +:ks_navigation: **存储 > 卷快照类** + + +本节介绍如何编辑卷快照类的信息。 + +您可以编辑卷快照类的别名和描述。{ks_product_right}不支持编辑卷快照类的名称。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的卷快照类右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。 + +. 在**编辑信息**对话框，设置卷快照类的别名和描述，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|别名 +|卷快照类的别名。不同卷快照类的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|卷快照类的描述信息。描述可包含任意字符，最多包含 256 个字符。 +|=== +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/05-delete-volume-snapshot-classes.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/05-delete-volume-snapshot-classes.adoc new file mode 100644 index 000000000..1a50739c8 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/05-delete-volume-snapshot-classes.adoc @@ -0,0 +1,65 @@ +--- +title: "删除卷快照类" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照类, 删除卷快照类" +description: "介绍如何编辑卷快照类的信息。" +weight: 05 +--- + +:ks_permission: **卷快照类管理** +:ks_navigation: **存储 > 卷快照类** + + +本节介绍如何删除卷快照类。 + +// Warning +include::../../../../../_ks_components/admonitions/warning.adoc[] + +卷快照类删除后，基于卷快照类创建的卷快照和卷快照内容不会被删除，但用户将无法再通过该卷快照类将快照数据保存到后端存储系统。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + + +== 删除单个卷快照类 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要删除的卷快照类右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除卷快照类**对话框，输入卷快照类的名称，然后点击**确定**。 + + +== 批量删除卷快照类 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 选择需要删除的卷快照类左侧的复选框，然后在列表上方点击**删除**。 + +. 在**批量删除卷快照类**对话框，输入卷快照的名称，然后点击**确定**。 ++ +-- +include::../../../../_custom/note-separateNamesByComma.adoc[] +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/_index.adoc new file mode 100644 index 000000000..187a37beb --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/13-storage/04-volume-snapshot-classes/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "卷快照类" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 卷快照类" +description: "介绍如何管理卷快照类。" +weight: 04 +--- + + + +本节介绍如何管理卷快照类。 + +卷快照类定义了可供容器使用的一类卷快照。创建卷快照类前，请为{ks_product_both}集群安装存储插件，并确保后端存储系统支持卷快照功能。有关更多信息，请联系您的存储系统提供商。 diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/05-storage-classes/01-set-authorization-rules.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/05-storage-classes/01-set-authorization-rules.adoc new file mode 100644 index 000000000..efa7b2c47 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/13-storage/05-storage-classes/01-set-authorization-rules.adoc @@ -0,0 +1,56 @@ +--- +title: "设置授权规则" +weight: 01 +--- + +:ks_permission: **存储类访问规则管理** +:ks_navigation: **存储 > 存储类** + + +本节介绍如何为存储类设置授权规则。 + +设置并启用授权规则后，用户只能在特定项目和企业空间使用存储类。 + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/storageClasses/systemClasses-oper-openDetailsPage.adoc[] + ++ + +. 在存储类详情页面的左上角，选择**更多操作 > 设置授权规则**。 + +. 在**设置授权规则**对话框，点击页面右侧的**已禁用**按钮启用授权规则。 ++ +-- +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +若要禁用授权规则，在页面右侧点击**已启用**。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +. 在**授权规则**设置区域，设置在特定的项目和企业空间使用该存储类。 ++ +image:/images/ks-qkcp/zh/v4.1/storage1.png[ rule,100%] + +. 设置完成后，点击**确定**。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/05-storage-classes/02-set-auto-expansion.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/05-storage-classes/02-set-auto-expansion.adoc new file mode 100644 index 000000000..5c5985b77 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/13-storage/05-storage-classes/02-set-auto-expansion.adoc @@ -0,0 +1,71 @@ +--- +title: "设置存储卷自动扩展" +keywords: "Kubernetes, {ks_product}, 集群管理, 存储, 持久卷声明, 持久卷,自动扩展" +description: "介绍如何设置存储卷自动扩展。" +weight: 02 +--- + +:ks_permission: **存储类管理** +:ks_navigation: **存储 > 存储类** + + +本节介绍如何设置存储卷自动扩展。 + +卷容量自动扩展指系统在卷剩余空间低于阈值时自动扩展卷容量。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 存储**扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +// include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc[] + +ifeval::["{file_output_type}" == "html"] +* 请确保后端存储系统支持卷扩展功能，且存储类已启用卷扩展功能。有关更多信息，请参阅link:../../../../07-cluster-management/08-storage/02-storage-classes/05-enable-and-disable-volume-operations[启用和禁用卷操作]。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +* 请确保后端存储系统支持卷扩展功能，且存储类已启用卷扩展功能。有关更多信息，请参阅《{ks_product_right}集群管理指南》的“存储类 > 启用和禁用卷操作”章节。 +endif::[] + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/clusterManagement/storageClasses/systemClasses-oper-openDetailsPage.adoc[] + ++ + +. 在存储类详情页面的左上角，选择**更多操作 > 设置自动扩展**。 + +. 在**设置自动扩展**对话框，点击页面右侧的**已禁用**按钮启用自动扩展功能。 ++ +-- +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +如果您需要禁用自动扩展功能，在页面右侧点击**已启用**。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +. 在**自动扩展**设置区域，设置扩展的最大容量、阈值、以及增量。 ++ +image:/images/ks-qkcp/zh/v4.1/storage2.png[ scale,100%] + +. （可选）如果您需要系统自动检查卷状态并重启工作负载，请勾选**自动重启工作负载**。 + +. 设置完成后，点击**确定**。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/05-storage-classes/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/05-storage-classes/_index.adoc new file mode 100644 index 000000000..c798cd7c4 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/13-storage/05-storage-classes/_index.adoc @@ -0,0 +1,11 @@ +--- +title: "存储类" +weight: 05 +--- + +本节介绍如何为存储类设置授权规则和自动扩展。 + +安装“KubeSphere 存储”扩展组件后，集群左侧导航栏的**存储**菜单下的**存储类**会显示**设置授权规则**和**设置自动扩展**操作项。 + +* 设置授权规则：用户只能在特定项目和企业空间使用存储类。 +* 设置自动扩展：系统在卷剩余空间低于阈值时自动扩展卷容量。 diff --git a/content/zh/docs/v4.1/11-use-extensions/13-storage/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/13-storage/_index.adoc new file mode 100644 index 000000000..5d7fd2708 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/13-storage/_index.adoc @@ -0,0 +1,34 @@ +--- +title: "KubeSphere 存储" +keywords: "Kubernetes, {ks_product}, 存储, 卷快照" +description: "介绍如何管理存储组件。" +weight: 13 +--- + + +本节介绍如何使用“KubeSphere 存储”扩展组件。 + +该扩展组件包含多个存储相关的实用工具： + +* snapshot-controller: 用于为 PVC 创建快照。 +* snapshotclass-controller: 用于为快照计数。 +* pvc-auto-resizer: 用于为 PVC 在容量不足的情况下实现自动扩容。 +* storageclass-accessor: 提供准入控制器，用来验证是否准许在某个命名空间或企业空间创建 PVC。 + + +安装“KubeSphere 存储”扩展组件后， + +* 集群左侧导航栏的**存储**菜单下将显⽰**卷快照**和**卷快照类**选项，**存储**菜单下的**存储类**将显示**设置授权规则**和**设置自动扩展**操作项。 +* 项目左侧导航栏的**存储**菜单下将显⽰**卷快照**选项。 + +[.admon.note,cols="a"] +|=== +|说明 + +| +* 存储类的自动扩展功能支持在 PVC 容量不足的情况下实现自动扩容。仅控制是否允许用户在 KubeSphere 企业版 Web 控制台使用相关操作，存储类是否实际支持这些操作取决于后端存储系统。 +* 设置自动扩展需要连接 prometheus 服务才能工作。有关更多信息，请参阅扩展中心“KubeSphere 存储”扩展组件的详情页说明。 +|=== + + + diff --git a/content/zh/docs/v4.1/11-use-extensions/16-dmp/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/16-dmp/_index.adoc new file mode 100644 index 000000000..a6b6b4931 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/16-dmp/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "RadonDB DMP" +weight: 16 +--- + +RadonDB DMP 是青云科技全新发布的企业级云原生数据库管理平台。在 KubeSphere LuBan 云原生可扩展开放架构之上，RadonDB DMP 能轻松实现多类型主流数据库的跨云部署、多云管理、智能观测与统一运维等，并完整构建围绕高性能、高可用、业务追踪、数据流转等场景下的生态闭环，助力客户真正实现数据库即服务。 + +安装 RadonDB DMP 扩展组件后，点击顶部导航栏上的image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，点击 RadonDB DMP，进入数据库管理平台。 + +有关如何使用 RadonDB DMP 数据库管理平台，请参阅 link:https://radondb-docs.kubesphere.com.cn/[RadonDB DMP 使用指南]。 diff --git a/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/01-add-an-edge-node.adoc b/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/01-add-an-edge-node.adoc new file mode 100644 index 000000000..25b697fbb --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/01-add-an-edge-node.adoc @@ -0,0 +1,143 @@ +--- +title: "添加边缘节点" +keywords: "Kubernetes, {ks_product}, 集群管理, 节点, 添加边缘节点" +description: "介绍如何添加边缘节点。" +weight: 01 +--- + +:ks_permission: **节点管理** +:ks_navigation: **节点 > 边缘节点** + +本节介绍如何添加边缘节点。 + + +== 前提条件 + +:relfileprefix: ../../../ +* {empty} +include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeEdge** 扩展组件。 + +* 待添加的边缘节点需要能够访问{ks_product_both}集群主节点的 **30000**、**30001**、**30002**、**30004** 端口。 + +* 待添加的边缘节点已安装 Docker、containerd、CRI-O 或 Virtlet 作为容器运行时。KubeEdge 边缘节点默认使用 containerd 作为运行时。有关更多信息，请参阅 link:https://docs.kubeedge.io/zh/docs/advanced/cri/[KubeEdge 官方文档]。 + +* 已获取待添加的边缘节点的 SSH 登录信息。 + + +== 配置边缘节点 + +执行以下步骤在边缘节点上配置 link:https://kubeedge.io/zh/docs/advanced/edgemesh/[EdgeMesh]。 + +. 执行以下命令编辑 **/etc/nsswitch.conf** 文件： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +vi /etc/nsswitch.conf + +---- +-- + +. 在 **/etc/nsswitch.conf** 文件中添加以下内容，然后保存文件： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +hosts:          dns files mdns4_minimal [NOTFOUND=return] + +---- +-- + +. 执行以下命令在边缘节点上启用 IP 转发： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +sudo echo "net.ipv4.ip_forward = 1" >> /etc/sysctl.conf + +---- +-- + +. 执行以下命令验证配置结果： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +sudo sysctl -p | grep ip_forward + +---- + +如果显示以下信息，则表明配置成功： + +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +net.ipv4.ip_forward = 1 + +---- +-- + + +== 添加边缘节点 + +include::../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在页面右侧点击**添加**。 + +. 在**添加边缘节点**对话框，设置边缘节点的参数。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|边缘节点的名称。系统会自动为边缘节点生成名称，您也可以手动设置边缘节点的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 + +// |内部 IP 地址 +// |边缘节点在{ks_product_both}集群内部的 IP 地址。边缘节点的内部 IP 地址不能与{ks_product_both}集群现有节点的内部 IP 地址相同。 + +|添加默认污点 +|是否为边缘节点添加污点以阻止容器组调度到边缘节点上。 +|=== +-- + +. 点击**验证**生成边缘节点配置命令。 + +. 点击**复制**将边缘节点配置命令复制到剪贴板，然后进行以下修改。 ++ +将边缘节点配置命令中的 10000,10001,10002,10004 端口修改为 cloudcore 服务暴露出来的端口 30000,30001,30002,30004。 ++ +image:/images/ks-qkcp/zh/v4.1/kubeedge-port.png[ port,100%] + + +. 登录边缘节点并执行已修改的命令。 ++ +-- +// Note +include::../../../../_ks_components/admonitions/note.adoc[] + +* 请确保边缘节点能够通过 **--cloudcore-ipport** 参数指定的 IP 地址访问{ks_product_both}集群主节点。 + +* 请确保边缘节点能够通过 **--cloudcore-ipport**、**--quicport**、**--certport**、**--tunnelport** 参数指定的端口号分别访问{ks_product_both}集群主节点的 **30000**、**30001**、**30002**、**30004** 端口。 + +* 取决于您的网络环境，您可能需要设置防火墙和流量转发规则。 + +include::../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +. 刷新{ks_product_left} Web 控制台的**边缘节点**页面。如果添加成功，边缘节点将显示在边缘节点列表。 diff --git a/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/02-view-an-edge-node-list.adoc b/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/02-view-an-edge-node-list.adoc new file mode 100644 index 000000000..97242d36f --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/02-view-an-edge-node-list.adoc @@ -0,0 +1,68 @@ +--- +title: "查看边缘节点列表" +keywords: "Kubernetes, {ks_product}, 集群管理, 边缘节点, 查看边缘节点列表" +description: "介绍如何查看边缘节点列表。" +weight: 02 +--- + +:ks_permission: **节点查看** + + +本节介绍如何查看边缘节点列表。 + + +== 前提条件 + +:relfileprefix: ../../../ +* {empty} +include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeEdge** 扩展组件。 + +== 操作步骤 + +include::../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + +. 在左侧导航栏选择**节点 > 边缘节点**打开节点列表。 + ++ + +==== +* 节点列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|各节点的主机名称和在子网内部的 IP 地址。 +// 各节点的主机名称由用户安装集群时在安装配置文件 **config-sample.yaml** 中设置。 + +|状态 +| +include::../../../_custom/clusterManagement/nodes/nodes-para-nodeStatus_new.adoc[] + +ifeval::["{file_output_type}" == "html"] +如果节点上存在污点，**状态**列还将显示节点上污点的数量。将光标悬停在污点数字上查看污点的具体信息。有关更多信息，请参阅link:../../../07-cluster-management/03-nodes/05-edit-node-taints/[设置节点污点]。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +如果节点上存在污点，**状态**列还将显示节点上污点的数量。将光标悬停在污点数字上查看污点的具体信息。有关更多信息，请参阅《{ks_product_right}集群管理指南》的“节点”章节。 +endif::[] + +|角色 +| +各节点在集群中的角色，取值为**代理/边缘节点**。 + +|=== +-- + +* 在列表上方点击搜索框并设置搜索条件，可按名称、状态或角色搜索节点。 + +include::../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/03-delete-an-edge-node.adoc b/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/03-delete-an-edge-node.adoc new file mode 100644 index 000000000..5b5c6e1ed --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/03-delete-an-edge-node.adoc @@ -0,0 +1,76 @@ +--- +title: "删除边缘节点" +keywords: "Kubernetes, {ks_product}, 集群管理, 节点, 删除边缘节点" +description: "介绍如何删除边缘节点。" +weight: 03 +--- + +:ks_permission: **节点管理** +:ks_menu: **节点 > 边缘节点** + +本节介绍如何删除边缘节点。 + + +== 前提条件 + +:relfileprefix: ../../../ +* {empty} +include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **KubeEdge** 扩展组件。 + +* 已获取{ks_product_both}集群主节点和边缘节点的 SSH 登录信息。 + + +== 操作步骤 + +. 登录边缘节点并执行以下命令删除边缘节点中的配置： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + + ./keadm reset + +---- + +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +apt remove mosquitto + +---- + +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +rm -rf /var/lib/kubeedge /var/lib/edged /etc/kubeedge/ca /etc/kubeedge/certs + +---- +-- + +. 登录{ks_product_both}集群主节点并执行以下命令删除边缘节点。 ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +kubectl delete node + +---- +-- + +. 在{ks_product_both}集群主节点执行以下命令检查当前的节点： ++ +-- +// Bash +include::../../../../_ks_components/code/bash.adoc[] + +kubectl get node + +---- + +如果命令回显中没有显示需要删除的边缘节点，则表明边缘节点删除成功。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/_index.adoc new file mode 100644 index 000000000..b3a169bf0 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/17-kubeedge/_index.adoc @@ -0,0 +1,27 @@ +--- +title: "KubeEdge" +keywords: "Kubernetes, {ks_product}, 集群管理, 边缘节点" +description: "介绍如何管理边缘节点。" +weight: 17 +--- + + +本节介绍如何使用 KubeEdge 扩展组件管理集群的边缘节点。 + +KubeEdge 包含云端和边缘端两部分，可将本机容器化应用编排和管理扩展到边缘端设备。它基于 Kubernetes 构建，为网络和应用程序提供核心基础架构支持，并在云端和边缘端部署应用、同步元数据。使用 KubeEdge，可以很容易地将应用程序部署到边缘端并进行使用。通过在边缘端处理数据，响应速度会显著提高，数据隐私也可以得到更好地保护。 + +安装 KubeEdge 扩展组件后，集群左侧导航栏的**节点**菜单下将显⽰**边缘节点**选项。 + +{ks_product_right}平台支持两类节点： + +* 集群节点：{ks_product_right}集群本地的节点，通常所有集群节点都属于同一个私有网络。 + +* 边缘节点：部署在边缘环境中受{ks_product_both}管理的节点。通常边缘节点相较集群节点更为轻量，与普通节点属于不同的私有网络。 + +ifeval::["{file_output_type}" == "html"] +边缘节点和集群节点的部分操作相同，如查看节点详情、阻⽌和允许容器组调度、编辑节点污点和标签。有关更多信息，请参阅link:../../07-cluster-management/03-nodes[节点管理]。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +边缘节点和集群节点的部分操作相同，如查看节点详情、阻⽌和允许容器组调度、编辑节点污点和标签。有关更多信息，请参阅《{ks_product_right}集群管理指南》的“节点”章节。 +endif::[] diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/01-create-a-deployment-and-register-the-deployment-as-a-microservice.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/01-create-a-deployment-and-register-the-deployment-as-a-microservice.adoc new file mode 100644 index 000000000..776d0799e --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/01-create-a-deployment-and-register-the-deployment-as-a-microservice.adoc @@ -0,0 +1,300 @@ +--- +title: "创建部署并注册为微服务" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 创建部署并注册为微服务" +description: "介绍如何创建部署并将部署注册为微服务。" +weight: 01 +--- + + +:ks_permission: ** Spring Cloud 微服务管理** +:ks_navigation:  **Spring Cloud > 微服务** + + +本节介绍如何创建部署并将部署注册为微服务。 + +Spring Cloud 微服务实例通过 Kubernetes 部署管理，部署的容器组副本即微服务的实例。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* 创建部署所使用的容器镜像中的应用程序需要符合 Nacos 规范。有关更多信息，请参阅 link:https://nacos.io[Nacos 官方文档]。 + + +== 操作步骤 + +请参阅link:#_参数描述[参数描述]设置部署的参数。 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 点击**启用 Spring Cloud**。 + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**基本信息**页签，设置**部署**的基本信息，然后点击**下一步**。 + +. 在**容器组设置**页签，为**部署**管理的容器组设置副本数量、容器、更新策略、安全上下文、调度规则和元数据，然后点击**下一步**。 + +. 在**存储设置**页签，为部署管理的容器挂载卷，然后点击**下一步**。 + +. 在**高级设置**页签，为部署管理的容器组指定节点，并设置部署的元数据，然后点击**创建**。 ++ +-- +部署创建完成后将被注册为微服务，并显示在微服务列表中。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +在 **Spring Cloud > 微服务**页面创建的部署将被自动注册为微服务。如需对微服务实例进行操作（例如调整实例数量），您需要前往**工作负载 > 部署**页面对微服务对应的部署进行操作。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + + +== 参数描述 + +* 基本信息 ++ +-- +设置部署的基本信息。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|部署的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 253 个字符。 + +|别名 +|部署的别名。不同部署的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。 + +|描述 +|部署的描述信息。描述可包含任意字符，最长 256 个字符。 +|=== +-- + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podReplicas.adoc[] + +* 容器组设置 > 添加容器 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addContainer.adoc[] +-- + +* 容器组设置 > 添加容器 > 容器设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-setImageNameTypeResource.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerImage.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerName.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerType.adoc[] + +include::../../../../_custom/clusterManagement/projects/projects-para-containerQuotas.adoc[] +|=== +-- + +* 容器组设置 > 添加容器 > 端口设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-Port.adoc[] +-- + +* 容器组设置 > 添加容器 > 镜像拉取策略 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[] +-- + +* 容器组设置 > 添加容器 > 健康检查 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[] +-- + +* 容器组设置 > 添加容器 > 健康检查 > 添加探针 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addProbe.adoc[] +-- + +* 容器组设置 > 添加容器 > 生命周期管理 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-lifecycleManagement.adoc[] +-- + +* 容器组设置 > 添加容器 > 生命周期管理 > 添加动作 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addAction.adoc[] +-- + +* 容器组设置 > 添加容器 > 启动命令 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[] +-- + +* 容器组设置 > 添加容器 > 环境变量 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[] +-- + +* 容器组设置 > 添加容器 > 容器组安全上下文 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-containerSecurityContext.adoc[] +-- + +* 容器组设置 > 添加容器 > 同步主机时区 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-syncTimeZone.adoc[] +-- + +* 容器组设置 > 更新策略 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-updatePolicy.adoc[] +-- + +* 容器组设置 > 更新策略 > 滚动更新设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-rollingUpdate.adoc[] +-- + +* 容器组设置 > 容器组安全上下文 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSecurityContext.adoc[] +-- + +* 容器组设置 > 容器组调度规则 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-podSchedulingRules.adoc[] +-- + +* 容器组设置 > 容器组调度规则 > 自定义规则 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-customRules.adoc[] +-- + +* 容器组设置 > 容器组优雅终止 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodGracePeriod.adoc[] +-- + +* 容器组设置 > 添加元数据 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-PodMetadata.adoc[] +-- + +* 存储设置 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-mountVolume.adoc[] + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-collectLogsOnVolume.adoc[] + +// include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-desc-enableLogCollectionCluster.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-addPVCTemplate.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountVolume.adoc[] + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountSecretOrConfigmap.adoc[] +|=== + +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-oper-editDeleteVolume.adoc[] +-- + +* 存储设置 > 添加持久卷声明模板 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-volumeTemplate.adoc[] +-- + +* 存储设置 > 挂载卷 > 持久卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-persistentVolume.adoc[] +-- + +* 存储设置 > 挂载卷 > 临时卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-temporaryVolume.adoc[] +-- + +* 存储设置 > 挂载卷 > HostPath 卷 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-hostpathVolume.adoc[] +-- + +* 存储设置 > 挂载配置字典或保密字典 ++ +-- +include::../../../../_custom/clusterManagement/workloads/createWorkload/workloads-para-mountConfigmapSecret.adoc[] +-- + +* 高级设置 ++ +-- +为部署管理的容器组指定节点，并设置部署的元数据。 + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +// |容器组 IP 池 +// |选择用于为容器组副本分配虚拟 IP 地址的 IP 池。 + +|选择节点 +|将容器组副本调度到具有指定标签的节点上。 + +* 您可以手动输入目标节点的标签键值对，也可以点击**指定节点**选择一个节点。 +* 点击**添加节点选择器**可设置多个标签，容器组副本将被调度具有所有指定标签的节点上。 +* 在已创建的标签右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除标签。 + +|添加元数据 +|设置部署的标签和注解。 + +* 点击添加可设置多条标签或注解。 +* 在已创建的标签或注解右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除标签或注解。 +|=== +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/02-view-a-microservice-list.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/02-view-a-microservice-list.adoc new file mode 100644 index 000000000..f4a71046b --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/02-view-a-microservice-list.adoc @@ -0,0 +1,62 @@ +--- +title: "查看微服务列表" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 查看微服务列表" +description: "介绍如何查看微服务列表。" +weight: 02 +--- + + +:ks_permission: ** Spring Cloud 微服务查看** +:ks_navigation:  **Spring Cloud > 微服务** + + +本节介绍如何查看微服务列表。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +==== +* 服务注册中心显示服务注册中心的地址、微服务的数量、微服务实例的数量和健康实例的数量。 + +* 微服务列表显示每个微服务的实例数量、健康实例数量和当前微服务是否已触发健康保护机制。 ++ +-- +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +* 为了防止因过多实例不健康导致流量全部流向健康实例，继而造成流量压力把健康实例压垮并形成雪崩效应，Nacos 支持设置健康保护阈值。当健康实例数量占微服务总实例数的比例小于该值时，无论实例是否健康，都会将这个实例返回给客户端。 + +* {ks_product_right}的默认健康保护阈值为 0，即默认不使用健康保护机制。您可以参阅 link:https://nacos.io[Nacos 官方文档]设置 Nacos 的健康保护阈值。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] +-- + +* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的微服务。 + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== + +. 在微服务右侧点击image:/images/ks-qkcp/zh/icons/plus-square.svg[plus-square,18,18]查看微服务的所有实例。 ++ +-- +include::../../../../_custom/projectManagement/microservices/microservices-para-instances.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/03-edit-the-weight-of-a-microservice.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/03-edit-the-weight-of-a-microservice.adoc new file mode 100644 index 000000000..d43b0afb8 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/03-edit-the-weight-of-a-microservice.adoc @@ -0,0 +1,45 @@ +--- +title: "编辑微服务实例权重" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 编辑微服务实例权重" +description: "介绍编辑微服务实例权重。" +weight: 03 +--- + + +:ks_permission: ** Spring Cloud 微服务管理** +:ks_navigation:  **Spring Cloud > 微服务** + + +本节介绍如何编辑微服务实例权重。 + +微服务实例的权重用于决定微服务实例的流量分配，发送给微服务的流量将根据微服务实例的权重分配给微服务实例。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/projectManagement/microservices/microservices-oper-openInstanceList.adoc[] + ++ + +. 在需要操作的微服务实例右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑权重**。 + +. 在**编辑权重**对话框，设置微服务实例的权重，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/04-take-a-microservice-instance-offline-and-online.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/04-take-a-microservice-instance-offline-and-online.adoc new file mode 100644 index 000000000..0480ae590 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/04-take-a-microservice-instance-offline-and-online.adoc @@ -0,0 +1,43 @@ +--- +title: "下线和上线微服务实例" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 下线微服务实例" +description: "介绍如何下线和上线微服务实例。" +weight: 04 +--- + + +:ks_permission: ** Spring Cloud 微服务管理** +:ks_navigation:  **Spring Cloud > 微服务** + + +本节介绍如何下线和上线微服务实例。微服务实例下线后将不再接收业务流量。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/projectManagement/microservices/microservices-oper-openInstanceList.adoc[] + ++ + +. 在需要操作的微服务实例右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**下线**可下线微服务。 + +. 在已下线的微服务实例右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**上线**可重新上线微服务。 diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/_index.adoc new file mode 100644 index 000000000..554ef9845 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/01-microservices/_index.adoc @@ -0,0 +1,10 @@ +--- +title: "微服务" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 微服务" +description: "介绍如何管理微服务。" +weight: 01 +--- + + + +本节介绍如何管理微服务。 diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/01-create-a-microservice-configuration.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/01-create-a-microservice-configuration.adoc new file mode 100644 index 000000000..3a5e34fc4 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/01-create-a-microservice-configuration.adoc @@ -0,0 +1,53 @@ +--- +title: "创建微服务配置" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 创建微服务路由" +description: "介绍如何创建微服务路由。" +weight: 01 +--- + +:ks_permission: ** Spring Cloud 微服务管理** +:ks_navigation:  **Spring Cloud > 微服务配置** + + +本节介绍如何创建微服务配置。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**创建微服务配置**对话框，设置微服务配置的参数，然后点击**创建**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|微服务配置的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。 + +|数据 +|微服务配置数据。点击下拉列表可选择数据的格式。有关微服务配置数据的更多信息，请参阅 link:https://nacos.io[Nacos 官方文档]。 +|=== +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/02-view-a-microservice-configuration-list.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/02-view-a-microservice-configuration-list.adoc new file mode 100644 index 000000000..bcd385b12 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/02-view-a-microservice-configuration-list.adoc @@ -0,0 +1,65 @@ +--- +title: "查看微服务配置列表" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 查看微服务配置列表" +description: "介绍如何查看微服务配置列表。" +weight: 02 +--- + +:ks_permission: ** Spring Cloud 微服务查看** +:ks_navigation:  **Spring Cloud > 微服务配置** + + +本节介绍如何查看微服务配置列表。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +==== +* 微服务配置列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|微服务配置的名称。 + +|状态 +|微服务配置的状态。 + +* **已发布**：微服务配置创建成功并且可供微服务使用。 + +* **失败**：微服务配置创建过程中出现系统错误导致创建失败。 + +|数据 ID +|微服务配置的全局唯一标识符，由 <微服务配置名称>.<格式> 组成。 + +|创建时间 +|微服务配置的创建时间。 +|=== +-- + +* 在列表上方点击搜索框并输入关键字，可按名称和状态搜索微服务配置。 + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/03-view-microservice-configuration-details.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/03-view-microservice-configuration-details.adoc new file mode 100644 index 000000000..948872c29 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/03-view-microservice-configuration-details.adoc @@ -0,0 +1,56 @@ +--- +title: "查看微服务配置详情" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 查看微服务配置详情" +description: "介绍如何查看微服务配置详情。" +weight: 03 +--- + +:ks_permission: ** Spring Cloud 微服务查看** +:ks_navigation:  **Spring Cloud > 微服务配置** + + +本节介绍如何查看微服务配置详情。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/projectManagement/microserviceConfiguration/microserviceConfiguration-oper-openDetailsPage.adoc[] ++ +-- +* 微服务配置详情页面左侧的**属性**区域显示微服务配置所属的项目、集群和创建时间。 + +* 微服务配置详情页面右侧的**数据**页签显示微服务配置所包含的数据。 +-- + +. 在微服务详情页面右侧点击**历史版本**页签查看微服务配置的修改记录。 ++ +-- +* 每次编辑微服务配置都会生成修改记录，可用于回退微服务配置。 + +* 点击修改记录可查看微服务配置的数据内容。 +-- + +. 在微服务配置详情页面右侧点击**事件**页签查看微服务配置的事件。 ++ +-- +include::../../../../_custom/clusterManagement/clusterManagement-para-eventsTab.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/04-edit-a-microservice-configuration.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/04-edit-a-microservice-configuration.adoc new file mode 100644 index 000000000..df0f03892 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/04-edit-a-microservice-configuration.adoc @@ -0,0 +1,39 @@ +--- +title: "编辑微服务配置" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 编辑微服务配置" +description: "介绍如何编辑微服务配置。" +weight: 04 +--- + + +:ks_permission: ** Spring Cloud 微服务管理** +:ks_navigation:  **Spring Cloud > 微服务配置** + + +本节介绍如何编辑微服务配置。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的微服务配置右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑**。 + +. 在**编辑微服务配置**对话框，设置微服务配置的新数据，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/05-replicate-a-microservice-configuration.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/05-replicate-a-microservice-configuration.adoc new file mode 100644 index 000000000..3dcfab2d6 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/05-replicate-a-microservice-configuration.adoc @@ -0,0 +1,51 @@ +--- +title: "复制微服务配置" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 复制微服务配置" +description: "介绍如何复制微服务配置。" +weight: 05 +--- + +:ks_permission: ** Spring Cloud 微服务管理** +:ks_navigation:  **Spring Cloud > 微服务配置** + + +本节介绍如何复制微服务配置。 + +您可以使用已有的微服务配置创建一个名称不同但数据完全相同的微服务配置。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要操作的微服务配置右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**复制**。 + +. 在**复制微服务配置**对话框，设置新微服务配置的名称，然后点击**确定**。 ++ +-- +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +根据需要，您也可以修改配置数据。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + +复制完成后，复制生成的微服务配置将显示在列表中。 +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/06-roll-back-a-microservice-configuration.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/06-roll-back-a-microservice-configuration.adoc new file mode 100644 index 000000000..c57896fb4 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/06-roll-back-a-microservice-configuration.adoc @@ -0,0 +1,44 @@ +--- +title: "回退微服务配置" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 回退微服务配置" +description: "介绍如何回退微服务配置。" +weight: 06 +--- + +:ks_permission: ** Spring Cloud 微服务管理** +:ks_navigation:  **Spring Cloud > 微服务配置** + + +本节介绍如何回退微服务配置。 + +每次编辑微服务配置都会生成修改记录，您可以使用修改记录将微服务配置回退到历史版本。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../_custom/projectManagement/microserviceConfiguration/microserviceConfiguration-oper-openDetailsPage.adoc[] + ++ + +. 在微服务配置详情页面左上角，选择**更多操作 > 回退**。 + +. 在**回退**对话框，选择目标修改记录，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/07-delete-microservice-configurations.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/07-delete-microservice-configurations.adoc new file mode 100644 index 000000000..bb3155179 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/07-delete-microservice-configurations.adoc @@ -0,0 +1,57 @@ +--- +title: "删除微服务配置" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 删除微服务配置" +description: "介绍如何删除微服务配置。" +weight: 07 +--- + +:ks_permission: ** Spring Cloud 微服务管理** +:ks_navigation:  **Spring Cloud > 微服务配置** + + +本节介绍如何删除微服务配置。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 删除单个微服务配置 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要删除的微服务配置右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除微服务配置**对话框，输入微服务配置的名称，然后点击**确定**。 + + +== 批量删除微服务配置 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 选择需要删除的微服务配置左侧的复选框，然后在列表上方点击**删除**。 + +. 在**批量删除微服务配置**对话框，输入微服务配置的名称，然后点击**确定**。 ++ +-- +include::../../../../_custom/note-separateNamesByComma.adoc[] +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/_index.adoc new file mode 100644 index 000000000..77bc93a97 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/02-microservice-configurations/_index.adoc @@ -0,0 +1,19 @@ +--- +title: "微服务配置" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 微服务配置" +description: "介绍如何管理微服务配置。" +weight: 02 +--- + + + +本节介绍如何管理微服务配置。 + +微服务配置中存储供微服务使用的键值数据，可用于分离微服务及其配置数据。 + +// Note +include::../../../../../_ks_components/admonitions/note.adoc[] + +本节仅介绍如何管理微服务配置。有关应用程序如何获取配置数据，请参阅 link:https://nacos.io[Nacos 官方文档]。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/01-create-a-microservice-gateway.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/01-create-a-microservice-gateway.adoc new file mode 100644 index 000000000..06396b11b --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/01-create-a-microservice-gateway.adoc @@ -0,0 +1,53 @@ +--- +title: "创建微服务网关" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 创建微服务网关" +description: "介绍如何创建微服务网关。" +weight: 01 +--- + +:ks_permission: ** Spring Cloud 微服务管理** +:ks_navigation:  **Spring Cloud > 微服务网关** + + +本节介绍如何创建微服务网关。 + +创建微服务网关过程中实际上创建了一个运行 Spring Cloud Gateway 的部署。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* 您需要提前准备 Spring Cloud Gateway 容器镜像。有关更多信息，请参阅 link:https://spring.io/projects/spring-cloud-gateway#overview[Spring Cloud Gateway] 官方文档。本节使用 registry.cn-beijing.aliyuncs.com/kse/spring-cloud-gateway:latest 容器镜像作为示例，您也可以根据需要自行构建容器镜像。 + + +== 操作步骤 + +请参阅link:#_参数描述[参数描述]设置微服务网关的参数。 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**网关设置**页签，设置微服务网关的参数，然后点击**下一步**。 + +. 在**高级设置**页签，选择是否启用外部访问和外部访问模式，然后点击**创建**。 + + +== 参数描述 + +include::../../../../_custom/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/02-view-microservice-gateway-information.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/02-view-microservice-gateway-information.adoc new file mode 100644 index 000000000..c18b64fb5 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/02-view-microservice-gateway-information.adoc @@ -0,0 +1,78 @@ +--- +title: "查看微服务网关信息" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 查看微服务网关信息" +description: "介绍如何查看微服务网关信息。" +weight: 02 +--- + +:ks_permission: ** Spring Cloud 微服务查看** +:ks_navigation:  **Spring Cloud > 微服务网关** + + +本节介绍如何查看微服务网关信息。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] ++ +-- +**微服务网关**页面提供以下信息： + +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|类型 +|网关的类型。对于微服务网关参数值为**微服务网关**。 + +|状态 +|网关当前的状态。 + +* **运行中**：微服务网关运行正常。 + +* **更新中**：微服务网关正在创建中或正在更新设置。 + +|创建者 +|创建网关的用户。 + +|创建时间 +|网关的创建时间。 + +|访问模式 +|网关的访问模式。 + +include::../../../../_custom/clusterManagement/services/services-para-externalAccess.adoc[tag=bullets] + +* **ClusterIP**：网关不能从 KubeSphere 集群外部访问，只能在 KubeSphere 集群内部通过虚拟 IP 地址访问。 + +|网关地址 +| +网关的访问地址。 + +include::../../../../_custom/clusterManagement/gatewaySettings/gatewaySettings-para-address.adoc[tag=bullets] + +* 如果网关的访问模式为 ClusterIP，网关不能从集群外部访问，**网关地址**为网关在 KubeSphere 集群内部的虚拟 IP 地址。 + +|节点端口 +|网关服务的 HTTP 和 HTTPS 节点端口。仅在网关的外部访问模式为 NodePort 时显示。 + +|副本 +|网关工作负载的容器组副本数量。 +|=== +-- diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/03-view-microservice-gateway-details.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/03-view-microservice-gateway-details.adoc new file mode 100644 index 000000000..007d19be1 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/03-view-microservice-gateway-details.adoc @@ -0,0 +1,73 @@ +--- +title: "查看微服务网关详情" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 查看微服务网关详情" +description: "介绍如何查看微服务网关详情。" +weight: 03 +--- + +:ks_permission: ** Spring Cloud 微服务查看** +:ks_navigation:  **Spring Cloud > 微服务网关** + + +本节介绍如何查看微服务网关详情。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在页面右侧选择**管理 > 查看详情**打开网关详情页面。 + +. 在网关详情页面左侧的**属性**区域查看网关的资源属性。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|集群 +|网关所属的集群。 + +|创建时间 +|网关的创建时间。 + +|更新时间 +|网关的更新时间 + +|创建者 +|启用网关的用户。 +|=== +-- + +. 在网关详情页面右侧是的**资源状态**页签查看网关的容器组副本数量、容器端口和容器组。 ++ +==== +* **副本**区域显示网关的期望容器组副本数量和当前容器组副本数量。 + +* **端口**区域显示网关的容器端口名称、协议和端口号。 + +* **容器组**区域显示网关的所有容器组副本。 ++ +-- +include::../../../../_custom/clusterManagement/nodes/nodes-para-podList.adoc[] +-- +==== + +. 在网关详情页面右侧点击**元数据**页签查看网关的标签和注解。 diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/04-edit-microservice-gateway-settings.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/04-edit-microservice-gateway-settings.adoc new file mode 100644 index 000000000..5bb5298d2 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/04-edit-microservice-gateway-settings.adoc @@ -0,0 +1,47 @@ +--- +title: "编辑微服务网关" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 编辑微服务网关" +description: "介绍如何编辑微服务网关。" +weight: 04 +--- + +:ks_permission: ** Spring Cloud 微服务管理** +:ks_navigation:  **Spring Cloud > 微服务网关** + + +本节介绍如何编辑微服务网关。 + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在页面右侧选择**管理 > 编辑**。 + +. 在**编辑微服务网关**对话框，修改微服务网关的参数，然后点击**确定**。 ++ +-- +有关微服务网关参数的更多信息，请参阅link:#_参数描述[参数描述]。 +-- + + +== 参数描述 + +include::../../../../_custom/projectManagement/microserviceGateway/microserviceGateway-para-microserviceGatewaySettings.adoc[] diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/05-delete-a-microservice-gateway.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/05-delete-a-microservice-gateway.adoc new file mode 100644 index 000000000..4ae0abbd6 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/05-delete-a-microservice-gateway.adoc @@ -0,0 +1,45 @@ +--- +title: "删除微服务网关" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 删除微服务网关" +description: "介绍如何删除微服务网关。" +weight: 05 +--- + +:ks_permission: ** Spring Cloud 微服务管理** +:ks_navigation:  **Spring Cloud > 微服务网关** + + +本节介绍如何删除微服务网关。 + +// Warning +include::../../../../../_ks_components/admonitions/warning.adoc[] + +删除微服务网关将导致微服务的业务中断，请谨慎执行此操作。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +* {ks_product_right}平台需要安装并启用 **KubeSphere Spring Cloud** 扩展组件。 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + + +== 操作步骤 + +include::../../../../_custom/projectManagement/projectManagement-oper-openProjectPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在页面右侧选择**管理 > 删除**。 + +. 在**删除**对话框，输入微服务网关的名称，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/_index.adoc new file mode 100644 index 000000000..a962566f4 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/03-microservice-gateway/_index.adoc @@ -0,0 +1,12 @@ +--- +title: "微服务网关" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud, 微服务网关" +description: "介绍如何管理微服务网关。" +weight: 03 +--- + + + +本节介绍如何管理微服务网关。 + +微服务网关是微服务的反向代理。来自客户端的请求先发送给微服务网关，再由微服务网关根据微服务路由转发给微服务。 diff --git a/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/_index.adoc new file mode 100644 index 000000000..6a773b0f3 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/18-spring-cloud/_index.adoc @@ -0,0 +1,13 @@ +--- +title: "KubeSphere Spring Cloud" +keywords: "Kubernetes, {ks_product}, 项目管理, Spring Cloud" +description: "介绍如何使用 Spring Cloud 功能。" +weight: 18 +--- + + +本节介绍如何使用 KubeSphere Spring Cloud 扩展组件。 + +KubeSphere Spring Cloud 扩展组件提供了微服务、微服务配置和微服务网关功能。微服务注册和配置功能基于 link:https://nacos.io[Nacos] 实现，微服务网关基于 Spring Cloud Gateway 实现。如果您原有的应用程序符合 Nacos 规范，KubeSphere Spring Cloud 功能可以帮助您在保持原有框架不变的同时获得容器化应用的运维效率。 + +安装 KubeSphere Spring Cloud 扩展组件后，项⽬左侧导航栏将显⽰ **Spring Cloud** 选项。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/19-tower/02-add-a-member-cluster-using-proxy-connection.adoc b/content/zh/docs/v4.1/11-use-extensions/19-tower/02-add-a-member-cluster-using-proxy-connection.adoc new file mode 100644 index 000000000..c398dea2b --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/19-tower/02-add-a-member-cluster-using-proxy-connection.adoc @@ -0,0 +1,110 @@ +--- +title: "通过代理连接添加成员集群" +keywords: "Kubernetes, {ks_product}, 多集群管理, 集群, 添加成员集群, 通过代理连接添加成员集群" +description: "介绍如何通过代理连接添加成员集群。" +weight: 02 +--- + + +本节介绍如何通过代理连接添加成员集群。 + +如果主集群无法访问成员集群的 Kubernetes API 服务，您可以设置成员集群连接到主集群对外暴露的 **tower** 服务从而添加成员集群。 + + +== 前提条件 + +* 您需要在主集群中具有 **platform-admin** 角色。 + +* {ks_product_right}平台需要安装并启用 **KubeSphere 多集群代理连接**扩展组件。 + +* 成员集群所有节点必须能访问主集群 **tower** 服务的外部访问地址。取决于您的网络环境，您可能需要配置防火墙和流量转发规则。 + +== 设置代理服务地址 + +在主集群安装“KubeSphere 多集群代理连接”扩展组件后，将在系统项目 kubesphere-system 中自动创建一个名为 tower 的服务。 + + +=== 集群中有可用的 LoadBalancer + +如果主集群中有可用的 LoadBalancer 插件，在主集群节点执行以下命令，可以看到 tower 服务有相应的 `EXTERNAL-IP` 地址。该地址将由 KubeSphere 自动获取并配置代理服务地址，这意味着您可以跳过设置代理服务地址这一步。 + +执行以下命令确认是否有 LoadBalancer 插件。 + +[,bash] +---- +kubectl -n kubesphere-system get svc +---- + +命令输出结果可能如下所示： + +[,bash] +---- +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +tower LoadBalancer 10.233.63.191 139.198.110.23 8080:30721/TCP 16h +---- + +[.admon.note,cols="a"] +|=== +|说明 + +| +主流公有云厂商一般会提供 LoadBalancer 解决方案，并且负载均衡器可以自动分配外部 IP。如果您的集群运行在本地环境中，尤其是在裸机环境中，可以使用 link:https://github.com/kubesphere/openelb[OpenELB] 作为负载均衡器解决方案。 +|=== + +=== 集群中没有可用的 LoadBalancer + +若主集群中没有可用的 LoadBalancer，执行 `kubectl -n kubesphere-system get svc` 命令后，输出结果可能如下所示。 + +[,bash] +---- +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +tower LoadBalancer 10.233.63.191 8080:30721/TCP 16h +---- + +由于 `EXTERNAL-IP` 处于 `pending` 状态，您需要手动设置代理地址，将 proxyPublishAddress 的值添加到 `kubesphere-config` ConfigMap 中。 + +. 在主集群节点，执行以下命令打开 kubesphere-config 配置字典。 ++ +[,bash] +---- +kubectl -n kubesphere-system edit cm kubesphere-config +---- + +. 搜索 `multicluster` 并添加新行，输入 `proxyPublishAddress` 来定义 tower 服务的外部 IP 地址，以便访问 Tower。 ++ +-- +[,bash] +---- +multicluster: + clusterRole: host + proxyPublishAddress: {公有 IP 地址}:{Port} # Add this line to set the address to access tower +---- + +[.admon.note,cols="a"] +|=== +|说明 + +| +您可能需要配置端口转发规则，例如，将公有 IP:Port 转发到 NodeIP:NodePort。 +|=== +-- + +== 添加成员集群 + +include::../../../_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-logInToHost.adoc[] + ++ + +. 点击**集群管理**。 ++ +include::../../../_custom/platformManagement/multiclusterManagement/clusters/clusters-oper-addClusterBasicInfo.adoc[] ++ +在**高级设置**下，设置集群的用途标识。 + +. 在**连接设置**页签，将**连接方式**设置为**代理连接**，点击**下一步**。 + +. 在**集群配置**页签，设置集群配置，然后点击**创建**。 ++ +-- +成员集群添加完成后将显示在**集群管理**页面的集群列表中。 +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/19-tower/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/19-tower/_index.adoc new file mode 100644 index 000000000..f18a08e7a --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/19-tower/_index.adoc @@ -0,0 +1,18 @@ +--- +title: "KubeSphere 多集群代理连接" +weight: 19 +--- + +本节介绍如何使用“KubeSphere 多集群代理连接”扩展组件进行集群间的代理连接。 + +KubeSphere 的组件 Tower 用于代理连接。Tower 是一种通过代理在集群间建立网络连接的工具。如果主集群无法直接访问成员集群，您可以暴露主集群的代理服务地址，这样可以让成员集群通过代理连接到主集群。当成员集群部署在私有环境（例如 IDC）并且主集群可以暴露代理服务时，适用此连接方法。当您的集群分布部署在不同的云厂商上时，同样适用代理连接的方法。 + +在主集群安装“KubeSphere 多集群代理连接”扩展组件后，将在系统项目 kubesphere-system 中自动创建一个名为 tower 的服务。通过此服务，可以通过代理连接添加成员集群。 + +[.admon.note,cols="a"] +|=== +|说明 + +| +有关组件配置的更多信息，请参阅扩展中心“KubeSphere 多集群代理连接”扩展组件的详情页说明。 +|=== \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/01-create-a-constraint-template.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/01-create-a-constraint-template.adoc new file mode 100644 index 000000000..46a6187ed --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/01-create-a-constraint-template.adoc @@ -0,0 +1,56 @@ +--- +title: "创建约束模板" +weight: 01 +--- + +:ks_permission: ** cluster-admin ** +:ks_navigation: ** Gatekeeper > 约束模板** + + +本节介绍如何创建约束模板。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**创建约束模板**对话框，设置约束模板的名称和目标（Targets），然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +| CRD 名称 +|约束模板对应的 CRD 名称。 + +|Targets +|Targets 是约束的目标对象，即需要应用约束规则的资源对象。Targets 可以是 Kubernetes 集群中的各种资源，如 Pod、Deployment、Namespace 等。约束将被应用于这些目标对象，以确保它们满足约束规则的要求。 + +|=== + +您将在**约束模板**页面查看已创建的约束模板。 +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/03-view-constraint-template-details.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/03-view-constraint-template-details.adoc new file mode 100644 index 000000000..0f2ecc92c --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/03-view-constraint-template-details.adoc @@ -0,0 +1,61 @@ +--- +title: "查看约束模板详情" +weight: 03 +--- + +:ks_permission: ** cluster-admin ** +:ks_navigation: ** Gatekeeper > 约束模板** + + +本节介绍如何查看约束模板详情。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在约束模板列表中点击一个约束模板的名称打开其详情页面。 + +. 在约束模板详情页面左侧的**属性**区域，查看约束模板的基本信息。 ++ +-- + +[%header,cols="2,5"] +|=== +|参数 |描述 + +|集群 +|约束模板所属的集群。 + +|创建时间 +|约束模板的创建时间。 + +|CRD +|约束模板对应的 CRD 名称。 +|=== +-- + +. 在约束模板详情页面右侧的**目标**页签，查看约束模板的约束对象。 + +. 在约束模板详情页面右侧点击**状态**页签，查看约束模板的标签和注解。 + +. 在约束模板详情页面右侧点击**约束**页签，查看使用约束模板创建的约束条件。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/04-edit-constraint-template-yaml.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/04-edit-constraint-template-yaml.adoc new file mode 100644 index 000000000..0342beda4 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/04-edit-constraint-template-yaml.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑约束模板配置" +weight: 04 +--- + +:ks_permission: ** cluster-admin ** +:ks_navigation: ** Gatekeeper > 约束模板** + + +本节介绍如何编辑约束模板配置。 + + +== 前提条件 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要编辑的约束模板右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑 YAML**。 + +. 在**编辑 YAML**对话框，修改相关配置，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/07-delete-constraint-templates.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/07-delete-constraint-templates.adoc new file mode 100644 index 000000000..39f170f8e --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/07-delete-constraint-templates.adoc @@ -0,0 +1,45 @@ +--- +title: "删除约束模板" +weight: 07 +--- + +:ks_permission: ** cluster-admin ** +:ks_navigation: ** Gatekeeper > 约束模板** + + +本节介绍如何删除约束模板。 + +// Warning +include::../../../../../_ks_components/admonitions/warning.adoc[] + +约束模板删除后不能恢复，请谨慎执行此操作。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要删除的约束模板右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除约束模板**对话框，输入约束模板的名称，然后点击**确定**。 + + diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/_index.adoc new file mode 100644 index 000000000..2f016c8d8 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/01-constraint-templates/_index.adoc @@ -0,0 +1,9 @@ +--- +title: "约束模板" +weight: 01 +--- + + +约束模板（ConstraintTemplates）是定义和管理约束的模板，用于验证 Gatekeeper 的 Kubernetes 准入控制器中的某些 Kubernetes 对象集。 + +约束模板可以被应用于集群，用于创建实际的约束实例。有关约束模板的更多信息，请参阅 link:https://open-policy-agent.github.io/gatekeeper/website/docs/howto/#constraint-templates[ConstraintTemplates]。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/01-create-a-constraint.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/01-create-a-constraint.adoc new file mode 100644 index 000000000..3b61ddf04 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/01-create-a-constraint.adoc @@ -0,0 +1,71 @@ +--- +title: "创建约束" +weight: 01 +--- + +:ks_permission: ** cluster-admin ** +:ks_navigation: ** Gatekeeper > 约束** + + +本节介绍如何创建约束。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 + +* 已创建一个约束模板。 + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + ++ + +. 在**创建约束条件**对话框，设置以下参数，然后点击**确定**。 ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|约束条件名称 +|约束条件的名称。 + +|约束条件类型 +|约束条件使用的约束模板。 + +|enforcementAction +|`enforcementAction` 字段定义了处理约束违规的操作。默认设置为 `deny`，即默认拒绝任何违规的准入请求。有关更多信息，请参阅link:https://open-policy-agent.github.io/gatekeeper/website/docs/violations/[约束违规处理]。 + +|Match Kinds +|`match` 字段定义了约束适用的资源。有关更多信息，请参阅 link:https://open-policy-agent.github.io/gatekeeper/website/docs/howto/#the-match-field[match]。 + +`kinds` 接受包含 `apiGroups` 和 `kinds` 字段的对象列表，这些字段列出了约束适用对象的 groups/kinds。如果指定了多个 groups/kinds 对象，只需匹配其中一个对象，资源就会在约束的适用范围内。 + +|命名空间标签 +|针对对象所在的命名空间或对象本身（如果对象是一个命名空间）设置的可标识的键值对。 + +|参数 +|用于描述约束的意图。有关更多信息，请参阅 link:https://open-policy-agent.github.io/gatekeeper/website/docs/howto/#the-parameters-field[parameters]。 +|=== + +您将在**约束**页面查看已创建的约束。 +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/02-view-a-constraint-list.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/02-view-a-constraint-list.adoc new file mode 100644 index 000000000..4793a9ec3 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/02-view-a-constraint-list.adoc @@ -0,0 +1,56 @@ +--- +title: "查看约束列表" +weight: 02 +--- + +:ks_permission: ** cluster-admin ** +:ks_navigation: ** Gatekeeper > 约束** + + +本节介绍如何查看约束列表。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ +==== + +* 约束列表提供以下信息： ++ +-- +[%header,cols="1a,4a"] +|=== +|参数 |描述 + +|名称 +|约束的名称。 + +|Kind +|约束使用的约束模板。 +|=== +-- + +* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的约束。 + +include::../../../../../_ks_components/oper-refreshListData.adoc[] + +include::../../../../../_ks_components/oper-customizeColumns.adoc[] +==== diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/03-view-constraint-details.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/03-view-constraint-details.adoc new file mode 100644 index 000000000..64efb6bf5 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/03-view-constraint-details.adoc @@ -0,0 +1,55 @@ +--- +title: "查看约束详情" +weight: 03 +--- + +:ks_permission: ** cluster-admin ** +:ks_navigation: ** Gatekeeper > 约束** + + +本节介绍如何查看约束详情。 + + +== 前提条件 + +:relfileprefix: ../../../../ + +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 + + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在约束列表中点击一个约束的名称打开其详情页面。 + +. 在约束详情页面左侧的**属性**区域，查看约束的基本信息。 ++ +-- + +[%header,cols="2,5"] +|=== +|参数 |描述 + +|集群 +|约束所属的集群。 + +|创建时间 +|约束的创建时间。 + +|=== +-- + +. 在约束详情页面右侧的**Violations**页签，查看违规信息。 diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/04-edit-constraint-yaml.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/04-edit-constraint-yaml.adoc new file mode 100644 index 000000000..17da0ab80 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/04-edit-constraint-yaml.adoc @@ -0,0 +1,36 @@ +--- +title: "编辑约束配置" +weight: 04 +--- + +:ks_permission: ** cluster-admin ** +:ks_navigation: ** Gatekeeper > 约束** + + +本节介绍如何编辑约束的配置。 + + +== 前提条件 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要编辑的约束右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑 YAML**。 + +. 在**编辑 YAML**对话框，修改相关配置，然后点击**确定**。 diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/07-delete-constraints.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/07-delete-constraints.adoc new file mode 100644 index 000000000..55af923df --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/07-delete-constraints.adoc @@ -0,0 +1,44 @@ +--- +title: "删除约束" +weight: 07 +--- + +:ks_permission: ** cluster-admin ** +:ks_navigation: ** Gatekeeper > 约束** + + +本节介绍如何删除约束。 + +// Warning +include::../../../../../_ks_components/admonitions/warning.adoc[] + +约束删除后不能恢复，请谨慎执行此操作。 + +include::../../../../../_ks_components/admonitions/admonEnd.adoc[] + + +== 前提条件 + +:relfileprefix: ../../../../ +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] + +:relfileprefix: ./ + +* {ks_product_right}平台需要安装并启用 **Gatekeeper** 扩展组件。 + + +== 操作步骤 + +include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +. 在需要删除的约束右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。 + +. 在**删除约束**对话框，输入约束的名称，然后点击**确定**。 + diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/_index.adoc new file mode 100644 index 000000000..a4d816be1 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/02-constraints/_index.adoc @@ -0,0 +1,8 @@ +--- +title: "约束" +weight: 02 +--- + +约束（Constraints）是指用于定义和实施集群策略的规则或条件，用于声明需要强制执行的 Gatekeeper 约束模板，是约束模板的实例。 + +有关约束的更多信息，请参阅 link:https://open-policy-agent.github.io/gatekeeper/website/docs/howto/#constraints[Constraints]。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/_index.adoc new file mode 100644 index 000000000..5c2626894 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/20-gatekeeper/_index.adoc @@ -0,0 +1,21 @@ +--- +title: "Gatekeeper" +weight: 20 +--- + +link:https://github.com/open-policy-agent/gatekeeper[Gatekeeper] 是一个用于 Kubernetes 可灵活配置策略的准入控制器，利用 link:https://www.openpolicyagent.org/[Open Policy Agent (OPA)] 验证在 Kubernetes 集群上创建和更新资源的请求。 + +// Gatekeeper 可以根据 Gatekeeper 验证策略对集群中的资源进行验证。参阅：https://open-policy-agent.github.io/gatekeeper-library/website/ + +link:https://open-policy-agent.github.io/gatekeeper-library/website/[OPA Gatekeeper Library] 提供了一些常用的安全准入策略，其中包含一系列可在 Gatekeeper 使用的约束模板（ConstraintTemplates）和约束（Constraints）。约束模板可直接应用于集群，约束可用于定制策略，以满足您的特定需求。 + +借助 Gatekeeper 灵活地定义准入策略，在集群层面强制执行安全准入审查，从而确保 Kubernetes 集群的稳定性和安全合规。 + +Gatekeeper 的主要特性包括： + +* **灵活**: Gatekeeper 允许用户声明式的定义准入策略，作用于选定的 namespace 与选定的资源类型。 +* **可编程**: Gatekeeper 使用 Open Policy Agent（OPA）作为决策引擎，可借助 Rego 实现复杂的安全策略定义。 +* **滚动发布**: 支持以循序渐进的方式逐步执行准入策略，从而规避中断工作负载的风险。 +* **预发布机制**: Gatekeeper 提供在强制执行之前测试安全策略影响和范围的机制。 + + diff --git a/content/zh/docs/v4.1/11-use-extensions/_index.adoc b/content/zh/docs/v4.1/11-use-extensions/_index.adoc new file mode 100644 index 000000000..69a38de65 --- /dev/null +++ b/content/zh/docs/v4.1/11-use-extensions/_index.adoc @@ -0,0 +1,42 @@ +--- +title: "扩展组件使用" +keywords: "Kubernetes, {ks_product}, 扩展组件, 使用指南, DevOps, DMP, whizard, 可观测组件" +description: "介绍如何使用各个扩展组件。" +weight: 11 +--- + +ifeval::["{file_output_type}" == "html"] +本节介绍如何使用{ks_product_both}的各个扩展组件。使用前，请先link:../06-extension-user-guide/01-install-components-pdf/[安装扩展组件]。 +endif::[] + +ifeval::["{file_output_type}" == "pdf"] +本节介绍如何使用{ks_product_both}的各个扩展组件。使用前，请参阅《{ks_product_right}扩展组件管理指南》，安装扩展组件。 + +== 产品版本 + +本文档适用于{ks_product_left} v4.1.0 版本。 + +== 读者对象 + +本文档主要适用于以下读者： + +* {ks_product_right}用户 + +* 交付工程师 + +* 运维工程师 + +* 售后工程师 + + +== 修订记录 + +[%header,cols="1a,1a,3a"] +|=== +|文档版本 |发布日期 |修改说明 + +|01 +|{pdf_releaseDate} +|第一次正式发布。 +|=== +endif::[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/20-release-notes/01-kse-4.1.0.adoc b/content/zh/docs/v4.1/20-release-notes/01-kse-4.1.0.adoc new file mode 100644 index 000000000..6e6ebd18e --- /dev/null +++ b/content/zh/docs/v4.1/20-release-notes/01-kse-4.1.0.adoc @@ -0,0 +1,731 @@ +--- +title: "KubeSphere 企业版 v4.1.0 版本说明" +keywords: "v4.1.0 版本说明, KubeSphere 企业版" +description: "介绍 KubeSphere 企业版新特性、功能增强以及问题修复。" +weight: 01 +--- + + +== KubeSphere Core + +KubeSphere 企业版（KSE）v4.1.0 是青云科技 KubeSphere 团队匠心打造的全新云原生操作系统，是 KubeSphere 企业版架构革新后的第一个全功能版本。 + +KubeSphere 企业版 v4.1.0 在 KubeSphere LuBan 全新云原生可扩展开放架构的基础上，将 KubeSphere 企业版 v3.x 的全产品功能解耦，并基于可插拔的架构规范进行重构、升级。自此，各 KubeSphere 扩展组件可独立发版、迭代。用户可根据需要的产品能力安装扩展组件，保持平台的轻量与灵活，轻松定制“千人千面”的专属操作系统。 + +KubeSphere 企业版 v4.1.0 内置丰富全能的 KubeSphere 扩展市场。其中发布的扩展组件均经过严格审校，优质可控，覆盖云原生核心业务的方方面面。用户可自助式一键安装扩展组件，通过扩展中心一站式管理扩展组件的全生命周期。 此外，企业或个人开发者也可根据 KubeSphere LuBan 的开发规范，将自己的软件和服务上架到 KubeSphere 扩展市场进行分发与商业售卖，丰富多元的云原生应用生态。 + +=== 新特性 + +- 基于全新微内核架构 KubeSphere LuBan 重构 +- 内置 KubeSphere 扩展市场 +- 支持通过扩展中心统一管理扩展组件 +- 支持 UI、API 扩展 +- 支持通过 kubeconfig 一键导入 member 集群 +- 支持 KubeSphere 服务帐户 +- 支持基于 TOTP 的二次认证 +- 支持动态扩展 Resource API +- 支持添加集群、企业空间、项目到快捷访问 +- 支持通过容器终端进行文件上传和下载 +- 支持适配不同厂商的云原生网关（Kubernetes Ingress API） + +=== 优化 + +- 创建企业空间时支持选取所有集群 +- 优化 web kubectl，支持 pod 动态回收、切换集群时支持模糊搜索 +- 优化节点管理列表，将默认排序修改为升序 +- 仅允许受信的 OAuth Client 直接使用用户名和密码对用户身份进行校验 +- 精简 member 集群中部署的 Agent 组件 +- 拆分 KubeSphere Config 中部分配置作为独立的配置项 +- 容器镜像搜索调整为按时间倒序进行排序 +- 支持编辑用户别名 +- 集群列表新增调度状态的展示 +- 配置字典详情页支持 binaryData 数据显示 +- 重构工作台管理页面 + + +=== 缺陷修复 + +- 修复节点终端一直显示 connecting 的问题 +- 修复潜在的企业空间资源越权访问的问题 +- 修复潜在的企业空间集群授权 API 越权访问的问题 +- 修复因错误配置导致会话异常登出的问题 +- 修复添加镜像服务信息从指定仓库拉取镜像时异常的问题 +- 编辑保密字典编辑时 ownerReferences 丢失的问题 +- 修复首次登录白屏和页面错误重定向的问题 +- 修复 Windows 环境下，选择框滚动的问题 +- 修复当 cluster-admin 登录时找不到集群管理入口的问题 + +=== API 更新 + +==== **API 移除** + +v4.1 版本将停止提供以下 API： + +**多集群** + +`/API_PREFIX/clusters/{cluster}/API_GROUP/API_VERSION/...` 多集群代理请求 API 被移除。请使用新的多集群代理请求路径规则代替，`/clusters/{cluster}/API_PREFIX/API_GROUP/API_VERSION/...`。 + +**访问控制** + +- `iam.kubesphere.io/v1alpha2` API 版本被移除。请使用 `iam.kubesphere.io/v1beta1` API 版本代替。 + +- `iam.kubesphere.io/v1beta1` 中的显著变化： +Role、RoleBinding、ClusterRole、ClusterRoleBinding 资源的 API Group 从 `rbac.authorization.k8s.io` 变更为 `iam.kubesphere.io`。 + + +**多租户** + +- `tenant.kubesphere.io/v1alpha1` 和 `tenant.kubesphere.io/v1alpha2` API 版本部分 API 被移除。请使用 `tenant.kubesphere.io/v1beta1` API 版本代替。 + +- `tenant.kubesphere.io/v1beta1` 中的显著变化： +`Workspace` 中 `spec.networkIsolation` 被移除。 + + +**kubectl** + +- `/resources.kubesphere.io/v1alpha2/users/{user}/kubectl` 接口已移除，终端相关操作无需再调用该接口 +- 用户 web kubectl 终端 API 路径从 `/kapis/terminal.kubesphere.io/v1alpha2/namespaces/{namespace}/pods/{pod}/exec` 调整为 `/kapis/terminal.kubesphere.io/v1alpha2/users/{user}/kubectl` + +**gateway** + +`gateway.kubesphere.io/v1alpha1` API 版本被移除。 + +- 配置 Ingress 查询相关网关的 API 调整为 ++ +[,bash] +---- +/kapis/gateway.kubesphere.io/v1alpha2/namespaces/{namespace}/availableingressclassscopes +---- + + +==== **API 弃用** + +以下 API 标记为弃用，将在未来的版本中移除： + +- Cluster validation API +- Config configz API +- OAuth token review API +- Operations job rerun API +- Resources v1alpha2 API +- Resources v1alpha3 API +- Tenant v1alpha3 API +- Legacy version API + +=== 已知问题 + +- LDAP Identity Provider 将在后续版本中支持 +- 企业空间部门管理将在后续版本中支持 +- KEDA 将在后续版本中支持 + +=== 其他 + +- 默认移除除英文和简体中文之外的所有语言选项 +- 移除系统组件相关内容 + + +== 可观测性 + +原 KubeSphere 企业版 v3.x 中的可观测性相关功能如监控、告警、日志、审计、事件、通知与事件告警等在 v4.1.0 进行了比较大的重构和优化，逐渐统一在 `WhizardTelemetry 可观测平台` 中持续演进，并随 KubeSphere 企业版 v4.1.0 发布 v1.0.0 版本。除了架构、API、技术栈等方向的优化与重构之外，减少不必要的工作负载也是 WhizardTelemetry 可观测平台 v1.0.0 这个版本的重要目标： + +- 原 v3.x 中的可观测性相关功能拆分成 10 个符合 KubeSphere LuBan 架构的扩展组件，包括 `WhizardTelemetry 平台服务`、`WhizardTelemetry 监控`、`WhizardTelemetry 告警管理`、`WhizardTelemetry 日志管理`、`WhizardTelemetry 事件管理`、`WhizardTelemetry 审计管理`、`WhizardTelemetry 通知管理`、`WhizardTelemetry 事件告警`、`WhizardTelemetry 数据流水线`、`OpenSearch 分布式检索与分析引擎`，这些扩展组件共同形成了 `WhizardTelemetry 可观测平台`。用户可以根据自己的需求安装所需的扩展组件，而不必如 KubeSphere 企业版 v3.5.0 及之前版本一样，将一些不需要的组件也默认安装。 + +- 监控 API 在保有原来 KubeSphere 监控 API 风格的前提下，有了较大的调整及变更。 + +- 告警与通知同样进行了较大的架构及 API 优化与调整，包括： ++ +-- + - 多集群模式下流程的优化，尤其是在启用可观测中心场景下显著缩短了流程。 + - 多集群模式下 member 集群的轻量化，在启用可观测中心场景下，member 集群无需部署用于告警的工作负载。 + - 原需部署到每个集群的 Alertmanager 和 Notification Manager 改为只部署到 host 集群；同时 host 集群新增 Alertmanager Proxy 用于接收 member 集群发过来的告警进而转发给 Alertmanager。 +-- + +- 日志、审计、事件及通知历史等功能也做了架构上较大的重构与优化，实现了真正的多集群架构： ++ +-- + - 原用于日志、审计、事件、通知历史等信息采集的 Agent 由 `Fluent Bit` 替换为 `Vector Agent`，新增 `Vector Aggregator` 用于部署到 host 集群收集通知历史等信息。 + - 原每个集群都会部署的 `OpenSearch` 改为可以被属于相同区域或组织的多个集群共用，而不必每个集群都安装，不同的集群会创建以集群名称为前缀的 index。 + - 用于接收审计数据的 kube-auditing-webhook 已被移除，审计数据落盘后将被 Vector Agent 收集。 + - 原用于管理 Kubernetes 原生事件的 kube-events controller，ruler，CRDs 已被移除，仅保留 kube-events-exporter 用于导出 Kubernetes 事件。 + - K8s 及 KubeSphere 审计信息的归档改为统一由 Vector Agent 从写到磁盘的文件收集，去掉了之前的 Webhook。 + - 原事件及审计的告警功能合并为 `WhizardTelemetry 事件告警`，未来会在此组件里支持日志告警；事件和审计各自的告警规则也被合并为一个 CRD `ClusterRuleGroup.logging.whizard.io`。 +-- + +=== WhizardTelemetry 平台服务 v1.0.0 + +`WhizardTelemetry 平台服务` 是从原 KubeSphere APIServer 中将可观测相关功能剥离出来形成的新增服务，是 `WhizardTelemetry 可观测平台` 中各个可观测服务共用的 `APIServer`，为所有可观测功能提供公共的后端平台服务，目前提供监控、日志、审计、事件、通知等服务的 API。 + + +==== **新特性** + +- 接入 KubeSphere 鉴权认证，支持用户权限校验 +- 监控 API 支持通过模板文件加载 PromQL 查询表达式 +- 监控 API 支持自定义组件查询 + +==== **优化** + +- 优化监控 API 查询性能 +- 优化日志 API 查询性能 +- 优化审计 API 查询性能 +- 优化事件 API 查询性能 +- 优化通知历史 API 查询性能 + +==== **弃用** + +- 监控 API `monitoring.kubesphere.io/v1alpha3` 已在 KubeSphere 企业版 v3.5.0 弃用，并且在 KubeSphere 企业版 v4.1.0 正式移除 +- 日志、审计、事件 API `tenant.kubesphere.io/v1alpha2` 已在 KubeSphere 企业版 v4.1.0 正式移除 + +==== **API 更新** + +- 监控 API 已升级为 `monitoring.kubesphere.io/v1beta1` 版本，更多 API 细节可参考 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/montoring-extension-dev-guide.md#whizardtelemetry-monitoring-api-%E5%8F%82%E8%80%83[WhizardTelemetry Monitoring API 参考]及 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/swagger.json[Swagger] +- 日志、审计、事件、通知历史 API 已升级为 `logging.kubesphere.io/v1alpha2` 版本，更多 API 细节可参考 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/logging-dev-guide.md[WhizardTelemetry API 参考]及 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/swagger.json[Swagger] + + +=== WhizardTelemetry 监控 v1.0.0 + +`WhizardTelemetry 监控` 是 WhizardTelemetry 可观测平台中提供监控功能的扩展组件。其中包含 Whizard 可观测中心，可提供多租户视角的云原生资源监控能力，包括针对多集群，节点， 工作负载、GPU、K8s 控制面等对象的核心监控指标实时和历史数据展示等功能。 + +可通过该扩展组件部署与管理如下组件： + +- Whizard Prometheus 长期存储 ++ +Whizard 是一个企业级多云多集群监控告警产品，解决可观测领域基于指标（Metrics）监控、告警的长期存储问题。 + +- Kube-Prometheus-Stack ++ +Kube-Prometheus-Stack 是使用 Prometheus 监控 Kubernetes 集群及运行在上面的应用的监控栈，包含 Prometheus Operator、kube-state-metrics、node-exporter 等组件，以及 Kubernetes 组件指标收集配置清单和相关 Prometheus Rules。 + +- Calico Exporter（部署在 Kube-Prometheus-Stack 的 node-exporter 内，可单独启用） ++ +Calico Exporter 是一个用于收集 Calico 网络性能指标的指标导出器。 + +- Process-exporter （部署在 Kube-Prometheus-Stack 的 node-exporter 内， 可单独启用） ++ +Process-exporter 是一个用于收集进程性能指标的指标导出器。 + +- DCGM-Exporter ++ +DCGM-Exporter 是一个用于收集 Nvidia GPU 性能和健康度指标的指标导出器。 + +- Whizard Monitoring Helper ++ +便于部署 `WhizardTelemetry 监控` 的助手工具。 + + +==== **新特性** + +- Whizard Gateway 支持暴露查询 UI，并支持查询外部数据源 +- Whizard 支持接入外部数据源鉴权认证 +- Whizard 支持 Services 层级组件配置，支持配置差异化 +- Whizard 优化内部 TLS 配置，提升查询性能 +- Whizard 更多特性及优化可参考 Whizard v0.10.0 Release +- Kube-Prometheus-Stack 与社区项目 link:https://github.com/prometheus-operator/kube-prometheus[kube-prometheus] 完全兼容 +- 集成 Calico Exporter 与 Process-exporter 到 Kube-Prometheus-Stack 的 node-exporter 内 +- DCGM-Exporter 优化默认指标配置，支持更多 GPU 指标采集 + +==== **优化** + +- 优化 Kube-Prometheus-Stack 中 recording rules 配置，同步社区最新更新 +- 优化 Kube-Prometheus-Stack 各组件资源配额，剪裁无用指标，提升性能 + +==== **缺陷修复** + +- 修复启用可观测中心时，集群/项目的规则组页面自定义规则无法自动提示的问题 + +==== **API 更新** + +- 监控 API 已集成到 `WhizardTelemetry 平台服务` 中，API 变更请参考 WhizardTelemetry 平台服务 + +==== **其他** + +- Whizard 升级至 v0.10.0 +- Prometheus Operator 升级至 v0.68.0 +- Prometheus 升级至 v2.50.1 +- kube-state-metrics 升级至 v2.8.2 +- node-exporter 升级至 v1.6.0 +- DCGM-Exporter 升级至 v3.4.0 + + +=== WhizardTelemetry 告警管理 v1.0.0 + +`WhizardTelemetry 告警管理` 是 WhizardTelemetry 可观测平台中基于监控指标进行告警的扩展组件，提供多集群的规则组管理、评估和告警等功能。 + +可通过该扩展组件部署与管理如下组件： + +- apiserver: 提供规则组和告警的相关 APIs +- controller-manager: 提供规则组的同步管理等功能 +- ruler: 负责规则组的规则评估和告警功能 + +与 KubeSphere 企业版 v3.5.0 相比，该扩展组件还从架构设计上对多集群告警的流程以及轻量化方面进行了显著优化。 + +==== **优化** + +- 告警流程优化，尤其在启用可观测中心的场景下显著缩短了告警流程 +- 降低 member 集群的告警负载，在启用可观测中心的场景下实现 member 集群的告警负载轻量化 + +==== **缺陷修复** + +- 修复规则检查时间短暂出现零时间戳的问题 +- 修复在告警页面使用多个过滤条件查询告警时数据未显示和分页异常等问题 + +==== **API 更新** + +与 KubeSphere 企业版 v3.5.0 相比，API 更新主要体现在请求路径的变更上： + +- 集群级别和项目级别的规则组和告警，API 路径前缀由 `[apis|kapis]/clusters/{cluster}/alerting.kubesphere.io/v2beta1/` 更新为 `/proxy/alerting.kubesphere.io/v2beta1/clusters/{cluster}/` +- 全局级别的规则组和告警，API 路径前缀由 `[apis/kapis]/alerting.kubesphere.io/v2beta1/` 更新为 `/proxy/alerting.kubesphere.io/v2beta1/` +- 对于内置的规则组，当可观测中心未启用时，通过集群级别规则组的 API 路径以及一个 `builtin=true` 的请求参数进行访问。例如请求 ++ +[,bash] +---- +/proxy/alerting.kubesphere.io/v2beta1/clusters/{cluster}/[clusterrulegroups|clusteralerts]?builtin=true +---- ++ +可分别访问内置规则组和它们的告警 + +请求体和响应的数据结构保持不变。 + +更多细节请参考 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/altering-api_zh.md[API 文档]。 + +==== **其他** + +- process-exporter-rules 规则组作为内置规则组，支持在启用可观测中心的场景下通过全局规则组进行管理 + + +=== WhizardTelemetry 日志管理 v1.0.0 + +`WhizardTelemetry 日志管理` 是 WhizardTelemetry 可观测平台中用于日志采集、处理、存储和查询的扩展组件。 + +可通过该扩展组件部署与管理如下组件： + +- logsidecar-injector 用于采集 Pod 中容器输出的落盘日志（不同于普通容器输出到 stdout 的日志） +- K8s 日志采集与转换 +- 缺省的 OpenSearch sink + + +==== **新特性** + +- 新增 Vector Agent 用于缺省的落盘日志采集 +- 原每个集群都会部署的 OpenSearch 改为可以多集群共用，不同的集群会创建以集群名称为前缀的 index +- 支持一部分集群（可用区 a 或部门 a）输出日志到一个 OpenSearch，另一部分集群（可用区 b 或部门 b）输出日志到不同的 OpenSearch，经过配置后可在同一日志控制台进行查询。具体细节请参考 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/logging-README_zh.md[README] + +==== **缺陷修复** + +- 修复日志查询前端页面访问缓慢的问题 + +==== **弃用** + +- 原用作采集落盘日志的 filebeat 已被废弃并将在后续版本移除 + +=== WhizardTelemetry 事件管理 v1.0.0 + +`WhizardTelemetry 事件管理` 是 WhizardTelemetry 可观测平台中用于 Kubernetes 原生事件导出的扩展组件。该扩展组件可以部署与管理 kube-events-exporter。主要负责： + +- 收集 Kubernetes 原生事件并导出到 stdout +- 由 Vector Agent 收集落盘的 Kubernetes 事件日志并进行格式转换后，发送给用户指定的接收者如 OpenSearch +- UI 上支持查询各集群的 Kubernetes 事件日志 + +==== **新特性** + +- 新增用于导出 Kubernetes 原生事件的 kube-events-exporter +- Kubernetes 事件由之前的 Webhook 方式接收改为由 Vector Agent 收集由 kube-events-exporter 输出到 stdout 进而落盘的 Kubernetes 事件，并发送到 OpenSearch 等用于归档或查询 + +==== **弃用** + +- 弃用并移除原 kube-events 项目定义的 CRDs，Ruler 及 Controller + + +=== WhizardTelemetry 审计管理 v1.0.0 + +`WhizardTelemetry 审计管理` 是 WhizardTelemetry 可观测平台中用于对 Kubernetes 和 KubeSphere 的审计信息进行归档和查询的扩展组件。该扩展组件主要负责： + +- 由 Vector Agent 收集落盘的 Kubernetes 及 KubeSphere 审计日志并进行格式转换 +- 转换后的审计日志被发送给用户指定的接收者如 OpenSearch +- UI 上支持查询各集群的审计日志 + +==== **优化** + +- 审计日志收集由之前的 Webhook 方式接收改为由 Vector Agent 收集落盘的审计日志文件 + +==== **弃用** + +- 原接收审计日志的 Webhook 已被弃用并移除 +- 原定义审计告警规则的 CRD Rule.auditing.kubesphere.io 已被弃用并移除 + + +=== WhizardTelemetry 通知管理 v2.5.1 + +`WhizardTelemetry 通知管理` 是 WhizardTelemetry 可观测平台中提供通知功能的扩展组件，可提供电子邮件、Slack、企业微信、钉钉、飞书、Webhook 等多渠道通知功能。 + +可通过该扩展组件部署与管理如下组件： + +- Notification Manager +- Notification History +- Alertmanager +- Alertmanager Proxy + + +==== **新特性** + +- 支持通知历史配置接收者 + +==== **优化** + +- 优化通知历史收集方式，移除 notification adaptor 组件 +- 支持在通知中显示 receiver 名称 +- 支持为 notification manager deployment 添加注解和标签 + +==== **缺陷修复** + +- 修复正则匹配会匹配所有告警的问题 +- 修复编辑订阅条件，选择过滤条件为“包含”后，页面白屏的问题 + +==== **弃用** + +- v2beta1 版本的 CRD 已被移除 +- 移除 notification adaptor 组件 + +==== **其他** + +- Notification Manager 升级至 v2.5.1 +- Alertmanager 升级至 v0.26.0 + + +=== WhizardTelemetry 事件告警 v1.0.0 + +`WhizardTelemetry 事件告警` 是 WhizardTelemetry 可观测平台中提供事件告警功能的扩展组件，它可以为 K8s 原生事件和 K8s/KubeSphere 审计事件定义告警规则，对传入的事件数据进行评估，并将告警发送到指定的接收器如 HTTP 端点。 + +此为本扩展组件的第一个正式版本，适配 KubeSphere 企业版 v4.1.0。 + +==== **新特性** + +- 为发出的告警新增 `cluster` 字段以区分事件告警来自于哪个集群 +- 支持通过配置接收器将消息发送至 Webhook 或其他目的地，如 host 集群上部署的 Alertmanager Proxy: `http://< host node ip >:31093/api/v1/alerts` + +==== **优化** + +- 合并原 `kube-events` 与 `kube-auditing` 项目中根据告警规则对 K8s 原生事件与 K8s/KubeSphere 审计事件进行评估的功能到 `WhizardTelemetry 事件告警` +- 合并原 `kube-events` 与 `kube-auditing` 项目中各自的告警规则至同一个 CRD `ClusterRuleGroup.logging.whizard.io` + + +=== OpenSearch 分布式检索与分析引擎 v2.11.1 + +`OpenSearch 分布式检索与分析引擎` 是 WhizardTelemetry 可观测平台中内置的分布式检索与分析引擎， 是用于存储、检索与分析日志、审计、事件、通知历史等可观测数据的扩展组件。 + +可通过该扩展组件部署与管理如下组件： + +- OpenSearch 的 Master 节点 +- OpenSearch 的 Data 节点 +- OpenSearch Dashboard +- OpenSearch Curator (用于定期清理过期数据) + +==== **优化** + +- 调整 OpenSearch Data 节点的 Service 为 NodePort 类型（端口 30920） +- 降低 OpenSearch Master 节点与 Data 节点请求的 CPU 与 Memory +- 调整 OpenSearch Curator 索引清理规则 + +==== **其他** + +- OpenSearch 升级至 v2.11.1 +- OpenSearch Dashboard 升级至 v2.11.1 + + +=== WhizardTelemetry 数据流水线 v1.0.0 + +`WhizardTelemetry 数据流水线` 是 WhizardTelemetry 可观测平台中提供可观测性数据收集、转换和路由能力的扩展组件。 + +==== **新特性** + +- 原用于日志、审计、事件、通知历史等信息采集的 Agent 由 Fluent Bit 替换为 Vector Agent +- 新增 Vector Aggregator 用于部署到 host 集群收集通知历史等信息 +- 为 Vector 新增 vector-config sidecar 容器，用于监听存储 Vector 配置的 Secret，并自动生成 Vector 的配置文件 +- 定制 Vector Helm Chart， 使得可以将 Vector 配置存储在 Secret，取代 Vector 上游将包含敏感信息的 Vector 配置存储在 ConfigMap 的做法 + + +==== **弃用** + +- 原用于日志、审计、事件、通知历史等信息采集的 Fluent Bit 及 FluentBit Operator 已被弃用并移除 + + +== 平台管理 + +=== 应用商店管理 v2.0.0 + +`应用商店管理` 是一个基于 OpenPitrix 自研的多云应用管理平台，用于上传、审核并管理多云环境中不同类型的应用。 + +在 v2.0.0 中，进一步提升仓库应用的同步性能，支持使用 YAML 文件创建应用模板。 + +==== **新特性** + +- 支持应用上传、统一审核与上下架管控 +- 支持使用 YAML 文件创建应用模板 +- 支持外置 S3 对象存储 +- 支持全局应用仓库配置 +- 支持更细粒度的权限配置，包含应用、应用版本、应用实例的查看、创建、删除与整体管理 + +==== **优化** + +- 优化产品交互，划定 KubeSphere 应用商店与应用商店管理的功能边界 +- 移除内置的开源仓库和开源应用模板 +- 提升仓库应用的同步性能 + +==== **缺陷修复** + +- 修复安装 helm 应用 CRD 不能立即使用的问题 + +==== **弃用** + +- 移除 openpitrix.io/v1 系列的 API +- 移除 manifests.application.kubesphere.io 系列 API + +==== **API 更新** + +- 增加创建 YAML 应用的 API +- 使用 KubeSphere 平台统一的分页，筛选条件查询 + +=== 服务网格 v1.0.0 + +`服务网格` 是一款强大的微服务治理与微服务可视化管理工具。它提供包括蓝绿部署、金丝雀发布与流量镜像三种灰度发布策略，与流量监控、链路追踪两项可观测能力。 + +==== **新特性** + +- 支持更细粒度的权限配置，包含服务网格管理与查看 + +==== **优化** + +- 优化产品交互，改变“自制应用”与“灰度发布”的入口位置 + +==== **其他** + +- Istio 从 v1.14.6 升级至 v1.16.5 +- Kiali 从 v1.50 升级至 v1.59 +- Jaeger 从 v1.29 升级至 v1.35 + + +=== Spring Cloud v1.0.0 + +`Spring Cloud` 是一个提供微服务、微服务配置和微服务网关功能的扩展组件。 + +==== **新特性** + +- 支持更细粒度的权限配置，包含 Spring Cloud 的管理与查看 + +==== **优化** + +- 减少 spring-cloud-controller 中不必要的日志记录 +- 存量项目下启用 Spring Cloud 功能时增加友好提醒 + +==== **其他** + +- spring-cloud-controller 从 v0.1.0 升级至 v0.1.1 + + +=== 多集群代理连接 v1.0.0 + +`多集群代理连接` 是一种通过代理在集群间建立网络连接的工具。如果主集群无法直接访问成员集群，您可以暴露主集群的代理服务地址，这样可以让成员集群通过代理连接到主集群。 + +该扩展组件将 KubeSphere 企业版 v3.5.0 中的多集群代理连接模块，基于全新的微内核架构 KubeSphere LuBan 重构，整体功能没有改变。 + + +=== 联邦集群应用管理 v1.0.0 + +`联邦集群应用管理` 是一个旨在简化跨多个联邦 Kubernetes 集群管理应用程序的扩展组件，用户可以轻松地在多个联邦集群中部署、更新和管理应用程序，同时提供灵活的配置选项以满足不同需求。 + +该扩展组件将 KubeSphere 企业版 v3.5.0 中的多集群项目模块，基于全新的微内核架构 KubeSphere LuBan 重构，整体功能没有改变。 + + +=== KubeEdge 边缘计算框架 v1.0.0 + +`KubeEdge 边缘计算框架` 是 KubeEdge 的扩展组件，可将本机容器化应用编排和管理扩展到边缘端设备。 + +可通过该扩展组件部署与管理如下组件： + +- cloudcore: 提供云端接入功能 +- frontend: 提供前端界面功能 + +==== **其他** + +- 该扩展组件暂时只支持 host 集群 + + +=== Metrics Server v0.7.0 + +`Metrics Server` 是一个可扩展、高效的容器资源度量源，为 Kubernetes 内置的自动扩展管道提供服务。 + +该扩展组件将 link:https://github.com/kubernetes-sigs/metrics-server[metrics-server] 基于全新的微内核架构 KubeSphere LuBan 重构，其代码、镜像等没有改变。 + +==== **其他** + +- metrics-server 从 v0.4.2 升级至 v0.7.0 + + +== 数据库与中间件 + +=== RadonDB DMP v2.1.0 + +`RadonDB DMP` 扩展组件提供数据库/中间件的可视化统一管理界面，支持数据库/中间件实例的全生命周期管理与运维。支持手动备份、自动化备份、从备份中恢复等功能；支持监控指标展示和告警功能（需安装可观测组件）。支持以下数据库/中间件：MySQL、PostgreSQL、MongoDB、Redis、OpenSearch、Kafka、RabbitMQ。 + + +==== **新特性** + +- 支持通过编辑 YAML 的方式修改数据库实例 +- 支持独立配置数据库备份 S3 地址 + +==== **缺陷修复** + +- 修复在命令行直接修改数据库配置会被重置的问题 +- 修复 Logstash 没有关联 role 导致无法写入 OpenSearch 数据的问题 +- 修复 OpenSearch 监控按条件查询无响应的问题 +- 调整 PostgreSQL 的资源规格避免内存不足导致 pod 重启 + +==== **弃用** + +- 弃用 `manifests.application.kubesphere.io` + +==== **已知问题** + +- MySQL 集群的备份恢复功能需要手动修复 +- PostgreSQL 集群的备份恢复功能需要手动修复 + +== DevOps + +=== DevOps v1.1.0 + +`KubeSphere DevOps 系统` 是专为 Kubernetes 中的 CI/CD 工作流设计的。它提供一站式的解决方案，帮助开发和运维团队用非常简单的方式构建、测试和发布应用到 Kubernetes。具有**插件管理、代码依赖缓存、代码质量分析、流水线日志**等功能，**兼容第三方私有镜像仓库（如 Harbor）和代码库（如 GitLab/GitHub/SVN/BitBucket）**。为用户提供全面的、可视化的 CI/CD 流水线，打造极佳的用户体验，而且这种兼容性强的流水线能力在离线环境中非常有用。 + +与 KubeSphere 企业版 v3.5.0 相比，该扩展组件不仅修复了已知问题，完善了功能，优化了使用体验，而且为适配 KubeSphere 企业版 v4.1.0，大量减少了对 KubeSphere Core 的依赖，使 DevOps 组件更加独立，版本管理更加灵活。 + +==== **新特性** + +- 部署时自动识别运行时环境，以便自动适配 Agent 镜像 +- 支持查看已取消的流水线详情 +- 调整 DevOps RoleTemplates 适配 KubeSphere LuBan IAM，DevOps 权限管理更加灵活便捷 + +==== **优化** + +- 支持流水线详情页日志查看功能 +- 优化 devops-controller 日志输出，信息更明确 +- 调整多分支流水线关于过期分支清理的描述 + +==== **缺陷修复** + +- 修复 devops-controller 由于流水线 cloneOptions.time 为空导致启动失败的问题 +- 修复流水线中定义的参数未传到 Jenkins 服务的问题 +- 修复流水线“打印消息”步骤包含双引号时报错的问题 +- 修复多分支流水线里附件下载失败的问题 +- 修复回放运行流水线失败的问题 +- 修复查询 DevOps 项目别名过滤无效的问题 + + +==== **已知问题** + +- 镜像构建器（S2I、B2I）功能在此版本暂不可用 +- kubeconfig 类型的凭证在此版本暂不可用 + +==== **API 更新** + +- ks-core 中 DevOps 相关 APIs 移动到此扩展组件中，路径中 `kapis/tenant.kubesphere.io/v1alpha2` 更新为 `kapis/devops.kubesphere.io/v1alpha3` +- 请求路径中把 DevOps 视为普通 Namespace，即把路径中 `devops` 改成 `namespaces`， 如: `kapis/devops.kubesphere.io/v1alpha3/workspaces/../devops/../` 更新为 `kapis/devops.kubesphere.io/v1alpha3/workspaces/../namespaces/../` +- DevOps 项目成员管理 API 更新: `kapis/iam.kubesphere.io/v1alpha2/devops/../members` 更新为 `kapis/iam.kubesphere.io/v1beta1/namespaces/../namespacemembers` +- DevOps 项目角色管理 API 更新：`kapis/iam.kubesphere.io/v1alpha2/devops/../roles?annotation=kubesphere.io/creator` 更新为 `kapis/iam.kubesphere.io/v1beta1/namespaces/../roles?annotation=kubesphere.io/creator` +- DevOps 项目权限项管理 API 更新：`kapis/iam.kubesphere.io/v1alpha2/devops/../roles?label=iam.kubesphere.io/role-template=true` 更新为 `kapis/iam.kubesphere.io/v1beta1/roletemplates?labelSelector=iam.kubesphere.io/scope=namespace，devops.kubesphere.io/managed=true` + +==== **其他** + +- 更新 devops-jenkins 认证方式为 ks-core OpenId Connect Authentication，移除对 LDAP 认证方式的依赖 + +== 网络 + +=== 网关 v1.0.0 + +`网关` 是聚合服务、管理 KubeSphere 平台外部访问的扩展组件。基于全新的微内核架构 KubeSphere LuBan 重构，支持一键启用和管理集群网关、企业空间网关、项目网关，帮助企业实现各层级网络配置的全覆盖。 + +==== **新特性** + +- 调整网关的架构，便于解耦不同厂商的网关 +- 整合网关创建、编辑时的配置步骤 +- 通过编辑网关 YAML 管理网关 values 中所有配置项 +- 可配置通过 NodePort 对外暴露时展示网关地址 +- 支持更细粒度的权限配置，包含网关管理与查看 + +==== **缺陷修复** + +- 修复网关日志导出异常的 bug + +==== **弃用** + +- 移除 Gateway v1alpha1 CRD +- 移除 Nginx v1alpha1 CRD + +==== **API 更新** + +- 新增 Gateway v2alpha1 CRD + +==== **其他** + +- nginx-ingress 从 v1.3.1 升级至 v1.4.0 + + +=== 网络 v1.0.0 + +`网络` 扩展组件基于全新微内核架构 KubeSphere LuBan 重构，功能基本与 KubeSphere 企业版 v3.5.0 中网络模块的功能一致，目前包含有 IPPool 和 NetworkPolicy 的管理配置，同时也有一部分架构的变化和新特性的增加。 + +- IPPool 弃用原有的 KubeSphere 封装的管理方式（ippools.network.kubesphere.io），直接管理 calico ippool（ippools.crd.projectcalico.org），避免与其他的第三方管理工具冲突；同时支持 calico ippool 更多字段的配置。 +- NetworkPolicy 主要优化用户在项目网络隔离的外部白名单的操作友好性。 + + +==== **新特性** + +- 支持用户通过 YAML 创建 IP 池以及 YAML 的动态编辑 +- 支持 IP 池 nodeSelector、NatOutgoing 等更多字段的 UI 化配置 +- 支持项目网络隔离外部白名单的端口范围的配置 +- 支持项目网络隔离外部白名单的多网段、多端口的配置 +- 支持项目网络隔离外部白名单的配置、基本信息的动态修改 + +==== **弃用** + +- 弃用 ippool 绑定到企业空间，但支持原生 calico ippool 绑定 namespace 的操作 +- 移除 network.kubesphere.io/v1alpha1 中的 ippools、ipamblocks、ipamhandles + +==== **API 更新** + +- ippool 更新为 ippools.crd.projectcalico.org/v1，更多 API 细节可参考 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/network-api_doc.md[Network API 参考]及 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/network-swagger.yaml[Swagger] + + +== 安全 + +=== Gatekeeper v1.0.0 + +link:https://github.com/open-policy-agent/gatekeeper[Gatekeeper] 是一个用于 Kubernetes 可灵活配置策略的准入控制器，使用 link:https://www.openpolicyagent.org/[Open Policy Agent (OPA)] 验证在 Kubernetes 集群上创建和更新资源的请求。 + +借助 Gatekeeper 可以灵活地定义准入策略，在集群层面强制执行安全准入审查，从而确保 Kubernetes 集群的稳定性和安全合规性。 + +==== **新特性** + +- 支持在集群层面配置安全准入策略 + +== 存储 + +=== 存储 v1.0.0 + +`存储` 扩展组件包含多个存储相关的实用工具。 + +可通过该扩展组件部署与管理如下组件： + +- snapshot-controller: 用于为 PVC 创建快照。 +- snapshotclass-controller: 用于为快照计数。 +- pvc-auto-resizer: 用于为 PVC 在容量不足的情况下实现自动扩容。 +- storageclass-accessor: 提供准入控制器，用来验证是否准许在某个命名空间或企业空间创建 PVC。 + +==== **优化** + +- 提高存储类授权规则的验证速度 +- 提高自动扩展的响应速度 + +==== **其他** + +- snapshot-controller 升级至 v4.2.1 + + + + diff --git a/content/zh/docs/v4.1/20-release-notes/_index.adoc b/content/zh/docs/v4.1/20-release-notes/_index.adoc new file mode 100644 index 000000000..d480757e2 --- /dev/null +++ b/content/zh/docs/v4.1/20-release-notes/_index.adoc @@ -0,0 +1,9 @@ +--- +title: "版本说明" +keywords: "Kubernetes, {ks_product}, 版本说明，release notes" +description: "版本说明" +weight: 20 +--- + + +本节介绍从{ks_product} v3.5.0 至 v4.1.0 的版本更新记录。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/25-glossary/_index.adoc b/content/zh/docs/v4.1/25-glossary/_index.adoc new file mode 100644 index 000000000..6c7b51cc6 --- /dev/null +++ b/content/zh/docs/v4.1/25-glossary/_index.adoc @@ -0,0 +1,8 @@ +--- +title: "术语表" +weight: 25 +keywords: 'Kubernetes, KubeSphere, 术语表, 词汇表' +description: 'KubeSphere 中使用的术语表。' +--- + +本术语表包含 KubeSphere 中专有的通用术语和技术术语。 \ No newline at end of file diff --git a/content/zh/docs/v4.1/25-glossary/glossary-final.adoc b/content/zh/docs/v4.1/25-glossary/glossary-final.adoc new file mode 100644 index 000000000..f452ddac1 --- /dev/null +++ b/content/zh/docs/v4.1/25-glossary/glossary-final.adoc @@ -0,0 +1,8 @@ +--- +title: "术语表" +weight: 01 +keywords: 'Kubernetes, KubeSphere, 术语表, 词汇表' +description: 'KubeSphere 中使用的术语表。' +--- + +include::../../_custom/glossary.adoc[] \ No newline at end of file diff --git a/content/zh/docs/v4.1/_index.adoc b/content/zh/docs/v4.1/_index.adoc new file mode 100644 index 000000000..adee0b33b --- /dev/null +++ b/content/zh/docs/v4.1/_index.adoc @@ -0,0 +1,60 @@ +--- +title: KubeSphere 企业版 +weight: 45 +css: scss/docs.scss +LinkTitle: KubeSphere 企业版 +pdf_coverDocName: KubeSphere 企业版 v4.1.0 +pdf_projectVersion: '4.1.0' +pdf_releaseDate: 2024-04-12 +section1: + title: KubeSphere 企业版 + content: 了解如何通过 KubeSphere 企业版构建并管理云原生应用程序。获取文档、示例代码与教程等信息。 + image: /images/docs/banner.png +study_section: + - title: 了解 + icon: icon-note_tree_duotone + children: + - title: 产品简介 + children: + - title: 产品优势 + url: 01-intro/01-introduction/ + - title: 应用场景 + url: 01-intro/03-scenarios/ + - title: 上手 + icon: icon-gamepad_2_duotone + children: + - title: 快速入门 + children: + - title: 最小化安装 + url: 02-quickstart/01-install-ks-core + - title: 安装示例组件 + url: 02-quickstart/02-install-a-demo-extension + - title: 控制用户权限 + url: 02-quickstart/03-control-user-permissions + - title: 管理 + icon: icon-simulation_duotone + children: + - title: 管理指南 + children: + - title: 扩展组件管理 + url: 06-extension-user-guide + - title: 集群管理 + url: 07-cluster-management + - title: 企业空间管理 + url: 08-workspace-management + - title: 项目管理 + url: 09-project-management + - title: 使用 + icon: icon-apps_2_duotone + children: + - title: 扩展组件 + children: + - title: DevOps + url: 11-use-extensions/01-devops + - title: 应用商店管理 + url: 11-use-extensions/02-app-store + - title: Whizard 可观测平台 + url: 11-use-extensions/05-observability-platform + - title: KubeSphere 网络 + url: 11-use-extensions/11-network +--- diff --git a/content/zh/docs/v4.1/search.md b/content/zh/docs/v4.1/search.md new file mode 100644 index 000000000..4e9d5c12c --- /dev/null +++ b/content/zh/docs/v4.1/search.md @@ -0,0 +1,5 @@ +--- +title: "搜索功能" +sitemap: +priority : 0.1 +--- diff --git a/static/images/icons/alarm_lamp_fill.svg b/static/images/icons/alarm_lamp_fill.svg new file mode 100644 index 000000000..ead2d7a78 --- /dev/null +++ b/static/images/icons/alarm_lamp_fill.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/static/images/icons/apps_2_duotone.svg b/static/images/icons/apps_2_duotone.svg new file mode 100644 index 000000000..8ce5f99d0 --- /dev/null +++ b/static/images/icons/apps_2_duotone.svg @@ -0,0 +1,4 @@ + + + + diff --git a/static/images/icons/book_4_info_duotone.svg b/static/images/icons/book_4_info_duotone.svg new file mode 100644 index 000000000..466b7eeb8 --- /dev/null +++ b/static/images/icons/book_4_info_duotone.svg @@ -0,0 +1,4 @@ + + + + diff --git a/static/images/icons/caret_down_fill.svg b/static/images/icons/caret_down_fill.svg new file mode 100644 index 000000000..a6fd44480 --- /dev/null +++ b/static/images/icons/caret_down_fill.svg @@ -0,0 +1,3 @@ + + + diff --git a/static/images/icons/caret_up_fill.svg b/static/images/icons/caret_up_fill.svg new file mode 100644 index 000000000..fe2567dbe --- /dev/null +++ b/static/images/icons/caret_up_fill.svg @@ -0,0 +1,3 @@ + + + diff --git a/static/images/icons/chevron_left_circle_fill.svg b/static/images/icons/chevron_left_circle_fill.svg new file mode 100644 index 000000000..e09467cd1 --- /dev/null +++ b/static/images/icons/chevron_left_circle_fill.svg @@ -0,0 +1,3 @@ + + + diff --git a/static/images/icons/chevron_left_fill.svg b/static/images/icons/chevron_left_fill.svg new file mode 100644 index 000000000..0c7f01aee --- /dev/null +++ b/static/images/icons/chevron_left_fill.svg @@ -0,0 +1,3 @@ + + + diff --git a/static/images/icons/chevron_right_circle_fill.svg b/static/images/icons/chevron_right_circle_fill.svg new file mode 100644 index 000000000..5ab168b3b --- /dev/null +++ b/static/images/icons/chevron_right_circle_fill.svg @@ -0,0 +1,3 @@ + + + diff --git a/static/images/icons/close_duotone.svg b/static/images/icons/close_duotone.svg new file mode 100644 index 000000000..7f925fc22 --- /dev/null +++ b/static/images/icons/close_duotone.svg @@ -0,0 +1,3 @@ + + + diff --git a/static/images/icons/code_box_duotone.svg b/static/images/icons/code_box_duotone.svg new file mode 100644 index 000000000..7b4fb4aad --- /dev/null +++ b/static/images/icons/code_box_duotone.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/static/images/icons/copy_fill.svg b/static/images/icons/copy_fill.svg new file mode 100644 index 000000000..a99d90886 --- /dev/null +++ b/static/images/icons/copy_fill.svg @@ -0,0 +1,4 @@ + + + + diff --git a/static/images/icons/document_question_duotone.svg b/static/images/icons/document_question_duotone.svg new file mode 100644 index 000000000..5b5226e9d --- /dev/null +++ b/static/images/icons/document_question_duotone.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/static/images/icons/format_pdf_2_fill.svg b/static/images/icons/format_pdf_2_fill.svg new file mode 100644 index 000000000..d01916503 --- /dev/null +++ b/static/images/icons/format_pdf_2_fill.svg @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/static/images/icons/format_word_fill.svg b/static/images/icons/format_word_fill.svg new file mode 100644 index 000000000..769042b85 --- /dev/null +++ b/static/images/icons/format_word_fill.svg @@ -0,0 +1,4 @@ + + + + diff --git a/static/images/icons/gamepad_2_duotone.svg b/static/images/icons/gamepad_2_duotone.svg new file mode 100644 index 000000000..b0320b8af --- /dev/null +++ b/static/images/icons/gamepad_2_duotone.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/static/images/icons/github_duotone.svg b/static/images/icons/github_duotone.svg new file mode 100644 index 000000000..9d6bcbc05 --- /dev/null +++ b/static/images/icons/github_duotone.svg @@ -0,0 +1,3 @@ + + + diff --git a/static/images/icons/information_fill.svg b/static/images/icons/information_fill.svg new file mode 100644 index 000000000..0944f2b04 --- /dev/null +++ b/static/images/icons/information_fill.svg @@ -0,0 +1,3 @@ + + + diff --git a/static/images/icons/magnifier_duotone.svg b/static/images/icons/magnifier_duotone.svg new file mode 100644 index 000000000..27632c411 --- /dev/null +++ b/static/images/icons/magnifier_duotone.svg @@ -0,0 +1,4 @@ + + + + diff --git a/static/images/icons/note_tree_duotone.svg b/static/images/icons/note_tree_duotone.svg new file mode 100644 index 000000000..b83d3c25f --- /dev/null +++ b/static/images/icons/note_tree_duotone.svg @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/static/images/icons/play_circle_fill.svg b/static/images/icons/play_circle_fill.svg new file mode 100644 index 000000000..5978d4619 --- /dev/null +++ b/static/images/icons/play_circle_fill.svg @@ -0,0 +1,3 @@ + + + diff --git a/static/images/icons/qingcloud.svg b/static/images/icons/qingcloud.svg new file mode 100644 index 000000000..6e0333096 --- /dev/null +++ b/static/images/icons/qingcloud.svg @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + + + + diff --git a/static/images/icons/share_box_fill.svg b/static/images/icons/share_box_fill.svg new file mode 100644 index 000000000..2359371d7 --- /dev/null +++ b/static/images/icons/share_box_fill.svg @@ -0,0 +1,4 @@ + + + + diff --git a/static/images/icons/simulation_duotone.svg b/static/images/icons/simulation_duotone.svg new file mode 100644 index 000000000..82ed9fe06 --- /dev/null +++ b/static/images/icons/simulation_duotone.svg @@ -0,0 +1,4 @@ + + + + diff --git a/static/images/icons/slash_fill.svg b/static/images/icons/slash_fill.svg new file mode 100644 index 000000000..472b826f6 --- /dev/null +++ b/static/images/icons/slash_fill.svg @@ -0,0 +1,3 @@ + + + diff --git a/static/images/icons/up_3_fill.svg b/static/images/icons/up_3_fill.svg new file mode 100644 index 000000000..b70253017 --- /dev/null +++ b/static/images/icons/up_3_fill.svg @@ -0,0 +1,4 @@ + + + + diff --git a/static/images/icons/warning_2_fill.svg b/static/images/icons/warning_2_fill.svg new file mode 100644 index 000000000..f91ad99f6 --- /dev/null +++ b/static/images/icons/warning_2_fill.svg @@ -0,0 +1,3 @@ + + + diff --git a/static/images/icons/warning_fill.svg b/static/images/icons/warning_fill.svg new file mode 100644 index 000000000..b50d0ac2c --- /dev/null +++ b/static/images/icons/warning_fill.svg @@ -0,0 +1,3 @@ + + + diff --git a/static/images/icons/wrench_duotone.svg b/static/images/icons/wrench_duotone.svg new file mode 100644 index 000000000..ede4878e7 --- /dev/null +++ b/static/images/icons/wrench_duotone.svg @@ -0,0 +1,4 @@ + + + + diff --git a/static/images/ks-qkcp/en/v4.0/install-extensions.png b/static/images/ks-qkcp/en/v4.0/install-extensions.png new file mode 100644 index 000000000..3de944bc2 Binary files /dev/null and b/static/images/ks-qkcp/en/v4.0/install-extensions.png differ diff --git a/static/images/ks-qkcp/zh/access-control/oauth2.svg b/static/images/ks-qkcp/zh/access-control/oauth2.svg new file mode 100644 index 000000000..1c778a85b --- /dev/null +++ b/static/images/ks-qkcp/zh/access-control/oauth2.svg @@ -0,0 +1 @@ +Front endFront endKubeSphereKubeSphereAuthorization serverAuthorization serverResource serverResource serverOAuth 2.0 login requestRedirect to the authorization server with client_idGrant requestRedirect to ks-console with the grant codeLogin request with the grant codeAuthorize by grant codeaccess_token & refresh_tokenDescribe the user requestAuthorize by access_tokenDescribe the user responseUser exists?If not, create the userJWT \ No newline at end of file diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/back-cover.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/back-cover.jpg new file mode 100644 index 000000000..40600718b Binary files /dev/null and b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/back-cover.jpg differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/cover.png b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/cover.png new file mode 100644 index 000000000..fbb7cd394 Binary files /dev/null and b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/cover.png differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-1.png b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-1.png new file mode 100644 index 000000000..0006da4eb Binary files /dev/null and b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-1.png differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-10.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-10.jpg new file mode 100644 index 000000000..f48304e9a Binary files /dev/null and b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-10.jpg differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-11.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-11.jpg new file mode 100644 index 000000000..17f64e42f Binary files /dev/null and b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-11.jpg differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-12.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-12.jpg new file mode 100644 index 000000000..6784389a1 Binary files /dev/null and b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-12.jpg differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-13.png b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-13.png new file mode 100644 index 000000000..d20d7bce9 Binary files /dev/null and b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-13.png differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-2.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-2.jpg new file mode 100644 index 000000000..9896b61b9 Binary files /dev/null and b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-2.jpg differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-3.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-3.jpg new file mode 100644 index 000000000..960333ed0 Binary files /dev/null and b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-3.jpg differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-4.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-4.jpg new file mode 100644 index 000000000..04e9f33f5 Binary files /dev/null and b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-4.jpg differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-5.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-5.jpg new file mode 100644 index 000000000..6a8873b2e Binary files /dev/null and b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-5.jpg differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-6.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-6.jpg new file mode 100644 index 000000000..13eef95e9 Binary files /dev/null and b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-6.jpg differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-7.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-7.jpg new file mode 100644 index 000000000..adf29a622 Binary files /dev/null and b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-7.jpg differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-8.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-8.jpg new file mode 100644 index 000000000..1cb138f93 Binary files /dev/null and b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-8.jpg differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-9.jpg b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-9.jpg new file mode 100644 index 000000000..3b8ea45bc Binary files /dev/null and b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/figure-9.jpg differ diff --git a/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/qr-code.png b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/qr-code.png new file mode 100644 index 000000000..89df7d56b Binary files /dev/null and b/static/images/ks-qkcp/zh/automobile-industry-cloud-native-trend/qr-code.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/examples/build-and-deploy-maven-project/maven-project-jenkins.png b/static/images/ks-qkcp/zh/devops-user-guide/examples/build-and-deploy-maven-project/maven-project-jenkins.png new file mode 100644 index 000000000..52a07efe0 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/examples/build-and-deploy-maven-project/maven-project-jenkins.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/enter-mirror-code.png b/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/enter-mirror-code.png new file mode 100644 index 000000000..dadd6a741 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/enter-mirror-code.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/enter-server-code.png b/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/enter-server-code.png new file mode 100644 index 000000000..b12dccefc Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/enter-server-code.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/gear.png b/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/gear.png new file mode 100644 index 000000000..f951ea547 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/gear.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/github-edit-icon.png b/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/github-edit-icon.png new file mode 100644 index 000000000..483ea7025 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/github-edit-icon.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/maven-public.png b/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/maven-public.png new file mode 100644 index 000000000..bea449afe Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/maven-public.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/maven-snapshots.png b/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/maven-snapshots.png new file mode 100644 index 000000000..d039f1278 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/maven-snapshots.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/modify-pom.png b/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/modify-pom.png new file mode 100644 index 000000000..377ed129a Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/examples/use-nexus-in-pipeline/modify-pom.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/add-credentials.png b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/add-credentials.png new file mode 100644 index 000000000..f4c7ccd61 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/add-credentials.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/generate-a-token.png b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/generate-a-token.png new file mode 100644 index 000000000..faba7d0f3 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/generate-a-token.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/jenkins-projet-key.png b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/jenkins-projet-key.png new file mode 100644 index 000000000..51f668785 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/jenkins-projet-key.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-config-1.png b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-config-1.png new file mode 100644 index 000000000..7e2eb0cd0 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-config-1.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-config-2.png b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-config-2.png new file mode 100644 index 000000000..817eae1a8 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-config-2.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-config-3.png b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-config-3.png new file mode 100644 index 000000000..81b8de1cb Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-config-3.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-create-project.png b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-create-project.png new file mode 100644 index 000000000..b2e9b985b Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-create-project.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-example.png b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-example.png new file mode 100644 index 000000000..7abcc3889 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-example.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-install.png b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-install.png new file mode 100644 index 000000000..db77c0a79 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-install.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-jenkins-settings.png b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-jenkins-settings.png new file mode 100644 index 000000000..d7bf36e72 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-jenkins-settings.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-webhook-1.png b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-webhook-1.png new file mode 100644 index 000000000..68c5ee2af Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-webhook-1.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-webhook-2.png b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-webhook-2.png new file mode 100644 index 000000000..2fa13d324 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/sonarqube-webhook-2.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/token-created.png b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/token-created.png new file mode 100644 index 000000000..f859707d7 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/token-created.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/webhook-page-info.png b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/webhook-page-info.png new file mode 100644 index 000000000..cb5460098 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/tool-integration/integrate-sonarqube-into-pipelines/webhook-page-info.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/choose-jenkins-agent/jenkins-agent.PNG b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/choose-jenkins-agent/jenkins-agent.PNG new file mode 100644 index 000000000..c45b08088 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/choose-jenkins-agent/jenkins-agent.PNG differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-a-jenkinsfile/github-token-scope.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-a-jenkinsfile/github-token-scope.png new file mode 100644 index 000000000..aec1a0abf Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-a-jenkinsfile/github-token-scope.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-a-jenkinsfile/jenkins-edit--2.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-a-jenkinsfile/jenkins-edit--2.png new file mode 100644 index 000000000..db9c8cbf3 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-a-jenkinsfile/jenkins-edit--2.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-a-jenkinsfile/pipeline-overview.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-a-jenkinsfile/pipeline-overview.png new file mode 100644 index 000000000..6da3910d4 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-a-jenkinsfile/pipeline-overview.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/add_artifact_stage.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/add_artifact_stage.png new file mode 100644 index 000000000..6f0054893 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/add_artifact_stage.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/add_nested_step.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/add_nested_step.png new file mode 100644 index 000000000..f003bdeb9 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/add_nested_step.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/add_nested_step_2.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/add_nested_step_2.png new file mode 100644 index 000000000..340f5ce55 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/add_nested_step_2.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/add_parameter.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/add_parameter.png new file mode 100644 index 000000000..a13b108cb Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/add_parameter.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/artifact_info.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/artifact_info.png new file mode 100644 index 000000000..f482772f7 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/artifact_info.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/basic_info.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/basic_info.png new file mode 100644 index 000000000..42bafa189 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/basic_info.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/build_and_push_image.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/build_and_push_image.png new file mode 100644 index 000000000..35306e53b Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/build_and_push_image.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/click-custom-pipeline.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/click-custom-pipeline.png new file mode 100644 index 000000000..bd493c9e9 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/click-custom-pipeline.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/code_analysis_stage.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/code_analysis_stage.png new file mode 100644 index 000000000..303994006 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/code_analysis_stage.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/container_maven.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/container_maven.png new file mode 100644 index 000000000..2efb90742 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/container_maven.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/create_pipeline.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/create_pipeline.png new file mode 100644 index 000000000..579e2f6da Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/create_pipeline.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/credential-list.PNG b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/credential-list.PNG new file mode 100644 index 000000000..95c8ee27c Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/credential-list.PNG differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/deploy_to_dev.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/deploy_to_dev.png new file mode 100644 index 000000000..ce9eee752 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/deploy_to_dev.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/docker_credential.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/docker_credential.png new file mode 100644 index 000000000..3a2c92747 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/docker_credential.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/dockerhub_image.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/dockerhub_image.png new file mode 100644 index 000000000..e878687b9 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/dockerhub_image.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/download_artifact.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/download_artifact.png new file mode 100644 index 000000000..d73bdace7 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/download_artifact.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/edit_panel.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/edit_panel.png new file mode 100644 index 000000000..40ccde438 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/edit_panel.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/edit_pipeline.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/edit_pipeline.png new file mode 100644 index 000000000..11bd0822d Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/edit_pipeline.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/enter_repo_url.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/enter_repo_url.png new file mode 100644 index 000000000..5270528a0 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/enter_repo_url.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/first_stage_set.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/first_stage_set.png new file mode 100644 index 000000000..3133e2764 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/first_stage_set.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/graphical_panel.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/graphical_panel.png new file mode 100644 index 000000000..68fa54247 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/graphical_panel.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/input_message.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/input_message.png new file mode 100644 index 000000000..1e0586b83 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/input_message.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/login_docker_command.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/login_docker_command.png new file mode 100644 index 000000000..8e5715487 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/login_docker_command.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/maven_container.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/maven_container.png new file mode 100644 index 000000000..012eab9d6 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/maven_container.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/maven_set_2.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/maven_set_2.png new file mode 100644 index 000000000..ceb7a9b20 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/maven_set_2.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/nested_step.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/nested_step.png new file mode 100644 index 000000000..0fc7f7961 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/nested_step.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/nested_step_maven.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/nested_step_maven.png new file mode 100644 index 000000000..2a8639e4e Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/nested_step_maven.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/pipeline_list.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/pipeline_list.png new file mode 100644 index 000000000..1e25e5455 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/pipeline_list.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/pipeline_successful.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/pipeline_successful.png new file mode 100644 index 000000000..e57027b6c Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/pipeline_successful.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/push_to_docker.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/push_to_docker.png new file mode 100644 index 000000000..9a3532545 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/push_to_docker.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/run_pipeline.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/run_pipeline.png new file mode 100644 index 000000000..c5cc39f82 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/run_pipeline.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/shell_command.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/shell_command.png new file mode 100644 index 000000000..999c23c65 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/shell_command.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonar-token.PNG b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonar-token.PNG new file mode 100644 index 000000000..7135c2bbc Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonar-token.PNG differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonar_env.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonar_env.png new file mode 100644 index 000000000..7002b2251 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonar_env.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonar_ready.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonar_ready.png new file mode 100644 index 000000000..9a63d66da Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonar_ready.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonarqube_credentials.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonarqube_credentials.png new file mode 100644 index 000000000..c06bc7ba5 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonarqube_credentials.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonarqube_result_detail.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonarqube_result_detail.png new file mode 100644 index 000000000..d70640a06 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonarqube_result_detail.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonarqube_shell_new.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonarqube_shell_new.png new file mode 100644 index 000000000..efc2bfaeb Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/sonarqube_shell_new.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/timeout_set.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/timeout_set.png new file mode 100644 index 000000000..5bc388491 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/timeout_set.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/unit_test.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/unit_test.png new file mode 100644 index 000000000..750306868 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/unit_test.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/waitforqualitygate_set.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/waitforqualitygate_set.png new file mode 100644 index 000000000..9be7e84d6 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/create-a-pipeline-using-graphical-editing-panel/waitforqualitygate_set.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/jenkins-system-settings/plugin-version.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/jenkins-system-settings/plugin-version.png new file mode 100644 index 000000000..87b400d71 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/jenkins-system-settings/plugin-version.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/pipeline-webhook/edit-btn.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/pipeline-webhook/edit-btn.png new file mode 100644 index 000000000..1692443b3 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/pipeline-webhook/edit-btn.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/set-email-server-for-kubesphere-pipelines/set-jenkins-email.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/set-email-server-for-kubesphere-pipelines/set-jenkins-email.png new file mode 100644 index 000000000..590a50b90 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/set-email-server-for-kubesphere-pipelines/set-jenkins-email.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/use-pipeline-templates/ci-stages.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/use-pipeline-templates/ci-stages.png new file mode 100644 index 000000000..807310545 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/use-pipeline-templates/ci-stages.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/use-pipeline-templates/ci-template.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/use-pipeline-templates/ci-template.png new file mode 100644 index 000000000..ca8bcf99d Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/use-pipeline-templates/ci-template.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/use-pipeline-templates/cicd-stages.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/use-pipeline-templates/cicd-stages.png new file mode 100644 index 000000000..7ef95fc38 Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/use-pipeline-templates/cicd-stages.png differ diff --git a/static/images/ks-qkcp/zh/devops-user-guide/use-devops/use-pipeline-templates/cicd-template.png b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/use-pipeline-templates/cicd-template.png new file mode 100644 index 000000000..ee58a95ba Binary files /dev/null and b/static/images/ks-qkcp/zh/devops-user-guide/use-devops/use-pipeline-templates/cicd-template.png differ diff --git a/static/images/ks-qkcp/zh/icons/abtest.svg b/static/images/ks-qkcp/zh/icons/abtest.svg new file mode 100644 index 000000000..f466fd1da --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/abtest.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/acl.svg b/static/images/ks-qkcp/zh/icons/acl.svg new file mode 100644 index 000000000..276e133b1 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/acl.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/add-dark.svg b/static/images/ks-qkcp/zh/icons/add-dark.svg new file mode 100644 index 000000000..40679daf7 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/add-dark.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/add-light.svg b/static/images/ks-qkcp/zh/icons/add-light.svg new file mode 100644 index 000000000..d36158984 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/add-light.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/admin.svg b/static/images/ks-qkcp/zh/icons/admin.svg new file mode 100644 index 000000000..8e630ad11 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/admin.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/ai.svg b/static/images/ks-qkcp/zh/icons/ai.svg new file mode 100644 index 000000000..8fe7c7e46 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/ai.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/aliyun.svg b/static/images/ks-qkcp/zh/icons/aliyun.svg new file mode 100644 index 000000000..7dc914c53 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/aliyun.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/api.svg b/static/images/ks-qkcp/zh/icons/api.svg new file mode 100644 index 000000000..70192740f --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/api.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/appcenter.svg b/static/images/ks-qkcp/zh/icons/appcenter.svg new file mode 100644 index 000000000..a3afe428b --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/appcenter.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/application.svg b/static/images/ks-qkcp/zh/icons/application.svg new file mode 100644 index 000000000..76e5014d4 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/application.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/approve.svg b/static/images/ks-qkcp/zh/icons/approve.svg new file mode 100644 index 000000000..c56e023bd --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/approve.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/arch-linux.svg b/static/images/ks-qkcp/zh/icons/arch-linux.svg new file mode 100644 index 000000000..91e0409dd --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/arch-linux.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/area.svg b/static/images/ks-qkcp/zh/icons/area.svg new file mode 100644 index 000000000..f46a37aec --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/area.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/ascending.svg b/static/images/ks-qkcp/zh/icons/ascending.svg new file mode 100644 index 000000000..8cfa77d24 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/ascending.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/aws.svg b/static/images/ks-qkcp/zh/icons/aws.svg new file mode 100644 index 000000000..779679d89 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/aws.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/backup.svg b/static/images/ks-qkcp/zh/icons/backup.svg new file mode 100644 index 000000000..a501ed2aa --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/backup.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/barchart.svg b/static/images/ks-qkcp/zh/icons/barchart.svg new file mode 100644 index 000000000..94288cfb1 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/barchart.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/bell.svg b/static/images/ks-qkcp/zh/icons/bell.svg new file mode 100644 index 000000000..015033ac0 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/bell.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/bi.svg b/static/images/ks-qkcp/zh/icons/bi.svg new file mode 100644 index 000000000..55a3b5509 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/bi.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/bigdata.svg b/static/images/ks-qkcp/zh/icons/bigdata.svg new file mode 100644 index 000000000..419a37e5f --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/bigdata.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/bill.svg b/static/images/ks-qkcp/zh/icons/bill.svg new file mode 100644 index 000000000..82b381806 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/bill.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/binary.svg b/static/images/ks-qkcp/zh/icons/binary.svg new file mode 100644 index 000000000..db341e907 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/binary.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/bird.svg b/static/images/ks-qkcp/zh/icons/bird.svg new file mode 100644 index 000000000..0cf127871 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/bird.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/bitbucket.svg b/static/images/ks-qkcp/zh/icons/bitbucket.svg new file mode 100644 index 000000000..f0d6c5954 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/bitbucket.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/blockchain.svg b/static/images/ks-qkcp/zh/icons/blockchain.svg new file mode 100644 index 000000000..6862c0bc5 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/blockchain.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/blue-green-deployment.svg b/static/images/ks-qkcp/zh/icons/blue-green-deployment.svg new file mode 100644 index 000000000..e02cec700 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/blue-green-deployment.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/bm.svg b/static/images/ks-qkcp/zh/icons/bm.svg new file mode 100644 index 000000000..21bf29f8f --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/bm.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/box.svg b/static/images/ks-qkcp/zh/icons/box.svg new file mode 100644 index 000000000..1eb8e7760 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/box.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/branch.svg b/static/images/ks-qkcp/zh/icons/branch.svg new file mode 100644 index 000000000..1b1199e7c --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/branch.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/broom.svg b/static/images/ks-qkcp/zh/icons/broom.svg new file mode 100644 index 000000000..3e11ef1b5 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/broom.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/browser.svg b/static/images/ks-qkcp/zh/icons/browser.svg new file mode 100644 index 000000000..4b8c8bd01 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/browser.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/c.svg b/static/images/ks-qkcp/zh/icons/c.svg new file mode 100644 index 000000000..49ea7a2f9 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/c.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/calendar-dark.svg b/static/images/ks-qkcp/zh/icons/calendar-dark.svg new file mode 100644 index 000000000..6fcd1ad34 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/calendar-dark.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/camera.svg b/static/images/ks-qkcp/zh/icons/camera.svg new file mode 100644 index 000000000..939883b03 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/camera.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/car.svg b/static/images/ks-qkcp/zh/icons/car.svg new file mode 100644 index 000000000..5dbad4ba3 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/car.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/cardview.svg b/static/images/ks-qkcp/zh/icons/cardview.svg new file mode 100644 index 000000000..82afa461d --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/cardview.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/caret-down.svg b/static/images/ks-qkcp/zh/icons/caret-down.svg new file mode 100644 index 000000000..a70c3f934 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/caret-down.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/caret-left.svg b/static/images/ks-qkcp/zh/icons/caret-left.svg new file mode 100644 index 000000000..eb1678a85 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/caret-left.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/caret-right.svg b/static/images/ks-qkcp/zh/icons/caret-right.svg new file mode 100644 index 000000000..38b8d0dc4 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/caret-right.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/caret-up.svg b/static/images/ks-qkcp/zh/icons/caret-up.svg new file mode 100644 index 000000000..bd5d25eab --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/caret-up.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/cart.svg b/static/images/ks-qkcp/zh/icons/cart.svg new file mode 100644 index 000000000..00778846c --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/cart.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/catalog.svg b/static/images/ks-qkcp/zh/icons/catalog.svg new file mode 100644 index 000000000..40bdf4d9a --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/catalog.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/cdn.svg b/static/images/ks-qkcp/zh/icons/cdn.svg new file mode 100644 index 000000000..db9ae87a7 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/cdn.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/centos.svg b/static/images/ks-qkcp/zh/icons/centos.svg new file mode 100644 index 000000000..276ae8592 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/centos.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/ceph.svg b/static/images/ks-qkcp/zh/icons/ceph.svg new file mode 100644 index 000000000..ca22b33f3 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/ceph.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/certification.svg b/static/images/ks-qkcp/zh/icons/certification.svg new file mode 100644 index 000000000..9d08e65e2 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/certification.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/chain-off-duotone.svg b/static/images/ks-qkcp/zh/icons/chain-off-duotone.svg new file mode 100644 index 000000000..59227518e --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/chain-off-duotone.svg @@ -0,0 +1,7 @@ + + + + + + + diff --git a/static/images/ks-qkcp/zh/icons/changing-over.svg b/static/images/ks-qkcp/zh/icons/changing-over.svg new file mode 100644 index 000000000..6f356e059 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/changing-over.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/check-dark.svg b/static/images/ks-qkcp/zh/icons/check-dark.svg new file mode 100644 index 000000000..1ed41ab79 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/check-dark.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/check-healthy.svg b/static/images/ks-qkcp/zh/icons/check-healthy.svg new file mode 100644 index 000000000..45da75f20 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/check-healthy.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/check-light.svg b/static/images/ks-qkcp/zh/icons/check-light.svg new file mode 100644 index 000000000..2498e9560 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/check-light.svg @@ -0,0 +1,3 @@ + + + diff --git a/static/images/ks-qkcp/zh/icons/chevron-down.svg b/static/images/ks-qkcp/zh/icons/chevron-down.svg new file mode 100644 index 000000000..1a3e3c0e0 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/chevron-down.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/chevron-left.svg b/static/images/ks-qkcp/zh/icons/chevron-left.svg new file mode 100644 index 000000000..6109a4bdd --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/chevron-left.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/chevron-right.svg b/static/images/ks-qkcp/zh/icons/chevron-right.svg new file mode 100644 index 000000000..f7ab6737d --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/chevron-right.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/chevron-up.svg b/static/images/ks-qkcp/zh/icons/chevron-up.svg new file mode 100644 index 000000000..412fff8aa --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/chevron-up.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/client.svg b/static/images/ks-qkcp/zh/icons/client.svg new file mode 100644 index 000000000..52ff08b1d --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/client.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/clock.svg b/static/images/ks-qkcp/zh/icons/clock.svg new file mode 100644 index 000000000..039ca28dd --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/clock.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/close-dark.svg b/static/images/ks-qkcp/zh/icons/close-dark.svg new file mode 100644 index 000000000..80345b7b4 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/close-dark.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/close-light.svg b/static/images/ks-qkcp/zh/icons/close-light.svg new file mode 100644 index 000000000..374dbf153 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/close-light.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/cloud.svg b/static/images/ks-qkcp/zh/icons/cloud.svg new file mode 100644 index 000000000..e0108aab2 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/cloud.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/cluster.svg b/static/images/ks-qkcp/zh/icons/cluster.svg new file mode 100644 index 000000000..a7525a64f --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/cluster.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/coding.svg b/static/images/ks-qkcp/zh/icons/coding.svg new file mode 100644 index 000000000..08c167bd0 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/coding.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/cogwheel.svg b/static/images/ks-qkcp/zh/icons/cogwheel.svg new file mode 100644 index 000000000..6d5483873 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/cogwheel.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/collapse.svg b/static/images/ks-qkcp/zh/icons/collapse.svg new file mode 100644 index 000000000..6abd2c147 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/collapse.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/column.svg b/static/images/ks-qkcp/zh/icons/column.svg new file mode 100644 index 000000000..4d2fc764b --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/column.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/commit.svg b/static/images/ks-qkcp/zh/icons/commit.svg new file mode 100644 index 000000000..53531eaca --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/commit.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/components.svg b/static/images/ks-qkcp/zh/icons/components.svg new file mode 100644 index 000000000..76694d74b --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/components.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/container.svg b/static/images/ks-qkcp/zh/icons/container.svg new file mode 100644 index 000000000..dd6ff08f6 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/container.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/cookie.svg b/static/images/ks-qkcp/zh/icons/cookie.svg new file mode 100644 index 000000000..2383d43d8 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/cookie.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/copy-light.svg b/static/images/ks-qkcp/zh/icons/copy-light.svg new file mode 100644 index 000000000..2dfaff576 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/copy-light.svg @@ -0,0 +1,4 @@ + + + + diff --git a/static/images/ks-qkcp/zh/icons/copy.svg b/static/images/ks-qkcp/zh/icons/copy.svg new file mode 100644 index 000000000..addf731b9 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/copy.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/coreos.svg b/static/images/ks-qkcp/zh/icons/coreos.svg new file mode 100644 index 000000000..777604c2d --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/coreos.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/cpe.svg b/static/images/ks-qkcp/zh/icons/cpe.svg new file mode 100644 index 000000000..93ac79e7c --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/cpe.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/cpu.svg b/static/images/ks-qkcp/zh/icons/cpu.svg new file mode 100644 index 000000000..755278238 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/cpu.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/creditcard.svg b/static/images/ks-qkcp/zh/icons/creditcard.svg new file mode 100644 index 000000000..f5ea56953 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/creditcard.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/cron-job.svg b/static/images/ks-qkcp/zh/icons/cron-job.svg new file mode 100644 index 000000000..bed2ae0b0 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/cron-job.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/csv.svg b/static/images/ks-qkcp/zh/icons/csv.svg new file mode 100644 index 000000000..02219b829 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/csv.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/dashboard.svg b/static/images/ks-qkcp/zh/icons/dashboard.svg new file mode 100644 index 000000000..a8c311007 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/dashboard.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/data.svg b/static/images/ks-qkcp/zh/icons/data.svg new file mode 100644 index 000000000..cc5aa967c --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/data.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/database.svg b/static/images/ks-qkcp/zh/icons/database.svg new file mode 100644 index 000000000..53b756945 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/database.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/deal.svg b/static/images/ks-qkcp/zh/icons/deal.svg new file mode 100644 index 000000000..2ef309e10 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/deal.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/deamon-set.svg b/static/images/ks-qkcp/zh/icons/deamon-set.svg new file mode 100644 index 000000000..1f8613ef2 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/deamon-set.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/debian.svg b/static/images/ks-qkcp/zh/icons/debian.svg new file mode 100644 index 000000000..a4c1b1c5b --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/debian.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/debug.svg b/static/images/ks-qkcp/zh/icons/debug.svg new file mode 100644 index 000000000..731604abc --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/debug.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/descending.svg b/static/images/ks-qkcp/zh/icons/descending.svg new file mode 100644 index 000000000..60577d366 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/descending.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/desktop-group.svg b/static/images/ks-qkcp/zh/icons/desktop-group.svg new file mode 100644 index 000000000..4c07e031e --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/desktop-group.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/discount.svg b/static/images/ks-qkcp/zh/icons/discount.svg new file mode 100644 index 000000000..5c6821dd9 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/discount.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/display.svg b/static/images/ks-qkcp/zh/icons/display.svg new file mode 100644 index 000000000..8564d89ee --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/display.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/dns.svg b/static/images/ks-qkcp/zh/icons/dns.svg new file mode 100644 index 000000000..aa8fa3667 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/dns.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/docker.svg b/static/images/ks-qkcp/zh/icons/docker.svg new file mode 100644 index 000000000..8d293ea0d --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/docker.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/documentation.svg b/static/images/ks-qkcp/zh/icons/documentation.svg new file mode 100644 index 000000000..5a37963cc --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/documentation.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/dot.svg b/static/images/ks-qkcp/zh/icons/dot.svg new file mode 100644 index 000000000..ae95bbf3d --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/dot.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/download-dark-white.svg b/static/images/ks-qkcp/zh/icons/download-dark-white.svg new file mode 100644 index 000000000..faae515ab --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/download-dark-white.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/download-dark.svg b/static/images/ks-qkcp/zh/icons/download-dark.svg new file mode 100644 index 000000000..bc44b370f --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/download-dark.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/drag-handle.svg b/static/images/ks-qkcp/zh/icons/drag-handle.svg new file mode 100644 index 000000000..7b6ec7fdf --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/drag-handle.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/earth.svg b/static/images/ks-qkcp/zh/icons/earth.svg new file mode 100644 index 000000000..5ed0f35ad --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/earth.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/eip-group.svg b/static/images/ks-qkcp/zh/icons/eip-group.svg new file mode 100644 index 000000000..cffb062d0 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/eip-group.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/eip-pool.svg b/static/images/ks-qkcp/zh/icons/eip-pool.svg new file mode 100644 index 000000000..fc1f24aa8 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/eip-pool.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/eip.svg b/static/images/ks-qkcp/zh/icons/eip.svg new file mode 100644 index 000000000..f8cc5ffa0 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/eip.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/enterprise.svg b/static/images/ks-qkcp/zh/icons/enterprise.svg new file mode 100644 index 000000000..a3fd84c05 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/enterprise.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/error.svg b/static/images/ks-qkcp/zh/icons/error.svg new file mode 100644 index 000000000..6e5db76c3 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/error.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/etcd.svg b/static/images/ks-qkcp/zh/icons/etcd.svg new file mode 100644 index 000000000..0e126e6ad --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/etcd.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/exclamation.svg b/static/images/ks-qkcp/zh/icons/exclamation.svg new file mode 100644 index 000000000..a9612f39b --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/exclamation.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/expand.svg b/static/images/ks-qkcp/zh/icons/expand.svg new file mode 100644 index 000000000..c9a2cea57 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/expand.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/export.svg b/static/images/ks-qkcp/zh/icons/export.svg new file mode 100644 index 000000000..b68d43bfc --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/export.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/eye-closed.svg b/static/images/ks-qkcp/zh/icons/eye-closed.svg new file mode 100644 index 000000000..810b23ce9 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/eye-closed.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/eye.svg b/static/images/ks-qkcp/zh/icons/eye.svg new file mode 100644 index 000000000..bf1952013 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/eye.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/fedora.svg b/static/images/ks-qkcp/zh/icons/fedora.svg new file mode 100644 index 000000000..b4fe2e880 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/fedora.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/file.svg b/static/images/ks-qkcp/zh/icons/file.svg new file mode 100644 index 000000000..5e11ee859 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/file.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/filter.svg b/static/images/ks-qkcp/zh/icons/filter.svg new file mode 100644 index 000000000..81ce063cd --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/filter.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/firewall.svg b/static/images/ks-qkcp/zh/icons/firewall.svg new file mode 100644 index 000000000..03033ed11 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/firewall.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/folder.svg b/static/images/ks-qkcp/zh/icons/folder.svg new file mode 100644 index 000000000..db8eca7cf --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/folder.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/freebsd.svg b/static/images/ks-qkcp/zh/icons/freebsd.svg new file mode 100644 index 000000000..2888e4a59 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/freebsd.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/fuse.svg b/static/images/ks-qkcp/zh/icons/fuse.svg new file mode 100644 index 000000000..f12f50a74 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/fuse.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/git.svg b/static/images/ks-qkcp/zh/icons/git.svg new file mode 100644 index 000000000..248789306 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/git.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/github.svg b/static/images/ks-qkcp/zh/icons/github.svg new file mode 100644 index 000000000..d7f83b241 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/github.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/gitlab.svg b/static/images/ks-qkcp/zh/icons/gitlab.svg new file mode 100644 index 000000000..2d35f18b0 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/gitlab.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/glusterfs.svg b/static/images/ks-qkcp/zh/icons/glusterfs.svg new file mode 100644 index 000000000..9b3b6203a --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/glusterfs.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/golang.svg b/static/images/ks-qkcp/zh/icons/golang.svg new file mode 100644 index 000000000..b00c3c9b8 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/golang.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/google-plus.svg b/static/images/ks-qkcp/zh/icons/google-plus.svg new file mode 100644 index 000000000..08ddb80f8 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/google-plus.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/gradle.svg b/static/images/ks-qkcp/zh/icons/gradle.svg new file mode 100644 index 000000000..acd5c13cc --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/gradle.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/grid.svg b/static/images/ks-qkcp/zh/icons/grid.svg new file mode 100644 index 000000000..e125119ca --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/grid.svg @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/static/images/ks-qkcp/zh/icons/group.svg b/static/images/ks-qkcp/zh/icons/group.svg new file mode 100644 index 000000000..b943850c6 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/group.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/hammer.svg b/static/images/ks-qkcp/zh/icons/hammer.svg new file mode 100644 index 000000000..04bcc689c --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/hammer.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/helm.svg b/static/images/ks-qkcp/zh/icons/helm.svg new file mode 100644 index 000000000..986d91c1c --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/helm.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/home.svg b/static/images/ks-qkcp/zh/icons/home.svg new file mode 100644 index 000000000..b8a9951a1 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/home.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/human.svg b/static/images/ks-qkcp/zh/icons/human.svg new file mode 100644 index 000000000..28383f9cf --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/human.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/image.svg b/static/images/ks-qkcp/zh/icons/image.svg new file mode 100644 index 000000000..56be38131 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/image.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/increase.svg b/static/images/ks-qkcp/zh/icons/increase.svg new file mode 100644 index 000000000..7fb80b12f --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/increase.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/information.svg b/static/images/ks-qkcp/zh/icons/information.svg new file mode 100644 index 000000000..f3a5e05a9 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/information.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/insert-chart.svg b/static/images/ks-qkcp/zh/icons/insert-chart.svg new file mode 100644 index 000000000..cad684b23 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/insert-chart.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/ios.svg b/static/images/ks-qkcp/zh/icons/ios.svg new file mode 100644 index 000000000..f3e029891 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/ios.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/ip-port.svg b/static/images/ks-qkcp/zh/icons/ip-port.svg new file mode 100644 index 000000000..55488d723 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/ip-port.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/ip.svg b/static/images/ks-qkcp/zh/icons/ip.svg new file mode 100644 index 000000000..0be01f4dd --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/ip.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/ipv6.svg b/static/images/ks-qkcp/zh/icons/ipv6.svg new file mode 100644 index 000000000..e4418237c --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/ipv6.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/istio.svg b/static/images/ks-qkcp/zh/icons/istio.svg new file mode 100644 index 000000000..e20d05d42 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/istio.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/item.svg b/static/images/ks-qkcp/zh/icons/item.svg new file mode 100644 index 000000000..04a07c9c7 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/item.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/jar.svg b/static/images/ks-qkcp/zh/icons/jar.svg new file mode 100644 index 000000000..c33bd0ed2 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/jar.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/java.svg b/static/images/ks-qkcp/zh/icons/java.svg new file mode 100644 index 000000000..734293b54 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/java.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/javascript.svg b/static/images/ks-qkcp/zh/icons/javascript.svg new file mode 100644 index 000000000..cc353d464 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/javascript.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/jenkins.svg b/static/images/ks-qkcp/zh/icons/jenkins.svg new file mode 100644 index 000000000..54bfdaf2a --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/jenkins.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/job.svg b/static/images/ks-qkcp/zh/icons/job.svg new file mode 100644 index 000000000..8c58bc5ec --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/job.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/key.svg b/static/images/ks-qkcp/zh/icons/key.svg new file mode 100644 index 000000000..a3db27f41 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/key.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/kubernetes.svg b/static/images/ks-qkcp/zh/icons/kubernetes.svg new file mode 100644 index 000000000..b65fa7335 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/kubernetes.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/kubesphere.svg b/static/images/ks-qkcp/zh/icons/kubesphere.svg new file mode 100644 index 000000000..f0ee5306e --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/kubesphere.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/laptop.svg b/static/images/ks-qkcp/zh/icons/laptop.svg new file mode 100644 index 000000000..cbee7486e --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/laptop.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/layer.svg b/static/images/ks-qkcp/zh/icons/layer.svg new file mode 100644 index 000000000..c30ae5f54 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/layer.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/licenses.svg b/static/images/ks-qkcp/zh/icons/licenses.svg new file mode 100644 index 000000000..1a24c34b1 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/licenses.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/link.svg b/static/images/ks-qkcp/zh/icons/link.svg new file mode 100644 index 000000000..f677dd84f --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/link.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/linux.svg b/static/images/ks-qkcp/zh/icons/linux.svg new file mode 100644 index 000000000..7d57da2d3 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/linux.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/listener.svg b/static/images/ks-qkcp/zh/icons/listener.svg new file mode 100644 index 000000000..2c4923856 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/listener.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/listview.svg b/static/images/ks-qkcp/zh/icons/listview.svg new file mode 100644 index 000000000..a0a934f64 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/listview.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/loadbalancer.svg b/static/images/ks-qkcp/zh/icons/loadbalancer.svg new file mode 100644 index 000000000..c2512c9bd --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/loadbalancer.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/lock.svg b/static/images/ks-qkcp/zh/icons/lock.svg new file mode 100644 index 000000000..eb4a849eb --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/lock.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/log.svg b/static/images/ks-qkcp/zh/icons/log.svg new file mode 100644 index 000000000..be7d21092 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/log.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/login-accounts.svg b/static/images/ks-qkcp/zh/icons/login-accounts.svg new file mode 100644 index 000000000..f4d27fd97 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/login-accounts.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/login-servers.svg b/static/images/ks-qkcp/zh/icons/login-servers.svg new file mode 100644 index 000000000..d915c26f7 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/login-servers.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/logout.svg b/static/images/ks-qkcp/zh/icons/logout.svg new file mode 100644 index 000000000..cb14030a3 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/logout.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/loudspeaker.svg b/static/images/ks-qkcp/zh/icons/loudspeaker.svg new file mode 100644 index 000000000..953e0f7d2 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/loudspeaker.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/macos.svg b/static/images/ks-qkcp/zh/icons/macos.svg new file mode 100644 index 000000000..1a2b399f2 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/macos.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/magnifier@6459d6db89ea40589dffa661d38a7b7d@.svg b/static/images/ks-qkcp/zh/icons/magnifier@6459d6db89ea40589dffa661d38a7b7d@.svg new file mode 100644 index 000000000..3ec076f85 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/magnifier@6459d6db89ea40589dffa661d38a7b7d@.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/mail.svg b/static/images/ks-qkcp/zh/icons/mail.svg new file mode 100644 index 000000000..7ddf29244 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/mail.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/maximize.svg b/static/images/ks-qkcp/zh/icons/maximize.svg new file mode 100644 index 000000000..0f459bf76 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/maximize.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/memory.svg b/static/images/ks-qkcp/zh/icons/memory.svg new file mode 100644 index 000000000..2d955d47b --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/memory.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/mgmt-node.svg b/static/images/ks-qkcp/zh/icons/mgmt-node.svg new file mode 100644 index 000000000..973fa7a58 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/mgmt-node.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/minimize.svg b/static/images/ks-qkcp/zh/icons/minimize.svg new file mode 100644 index 000000000..33ad61995 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/minimize.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/minus-square.svg b/static/images/ks-qkcp/zh/icons/minus-square.svg new file mode 100644 index 000000000..e31ba6504 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/minus-square.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/mirroring.svg b/static/images/ks-qkcp/zh/icons/mirroring.svg new file mode 100644 index 000000000..af156e164 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/mirroring.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/monitor.svg b/static/images/ks-qkcp/zh/icons/monitor.svg new file mode 100644 index 000000000..7e20b3185 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/monitor.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/more.svg b/static/images/ks-qkcp/zh/icons/more.svg new file mode 100644 index 000000000..063b52c2d --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/more.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/nat.svg b/static/images/ks-qkcp/zh/icons/nat.svg new file mode 100644 index 000000000..53f8c1dd7 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/nat.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/network-card.svg b/static/images/ks-qkcp/zh/icons/network-card.svg new file mode 100644 index 000000000..09216ef72 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/network-card.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/network-router.svg b/static/images/ks-qkcp/zh/icons/network-router.svg new file mode 100644 index 000000000..11ab56fea --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/network-router.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/network.svg b/static/images/ks-qkcp/zh/icons/network.svg new file mode 100644 index 000000000..6e62aab24 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/network.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/next.svg b/static/images/ks-qkcp/zh/icons/next.svg new file mode 100644 index 000000000..968096225 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/next.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/nodejs.svg b/static/images/ks-qkcp/zh/icons/nodejs.svg new file mode 100644 index 000000000..3302a1dea --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/nodejs.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/nodes.svg b/static/images/ks-qkcp/zh/icons/nodes.svg new file mode 100644 index 000000000..752997a53 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/nodes.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/notes.svg b/static/images/ks-qkcp/zh/icons/notes.svg new file mode 100644 index 000000000..d5c9abf00 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/notes.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/openpitrix.svg b/static/images/ks-qkcp/zh/icons/openpitrix.svg new file mode 100644 index 000000000..9ca06126e --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/openpitrix.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/opensuse.svg b/static/images/ks-qkcp/zh/icons/opensuse.svg new file mode 100644 index 000000000..3f24c8624 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/opensuse.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/oracle-linux.svg b/static/images/ks-qkcp/zh/icons/oracle-linux.svg new file mode 100644 index 000000000..7a7667b16 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/oracle-linux.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/os-service.svg b/static/images/ks-qkcp/zh/icons/os-service.svg new file mode 100644 index 000000000..7a89ce5b2 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/os-service.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/os.svg b/static/images/ks-qkcp/zh/icons/os.svg new file mode 100644 index 000000000..fde243b0a --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/os.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/paper.svg b/static/images/ks-qkcp/zh/icons/paper.svg new file mode 100644 index 000000000..dd19ba671 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/paper.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/passport.svg b/static/images/ks-qkcp/zh/icons/passport.svg new file mode 100644 index 000000000..c6ede39d9 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/passport.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/pause-light.svg b/static/images/ks-qkcp/zh/icons/pause-light.svg new file mode 100644 index 000000000..3542185c5 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/pause-light.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/pause.svg b/static/images/ks-qkcp/zh/icons/pause.svg new file mode 100644 index 000000000..6015a0d8e --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/pause.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/pdf.svg b/static/images/ks-qkcp/zh/icons/pdf.svg new file mode 100644 index 000000000..71a6045d7 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/pdf.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/pen-dark.svg b/static/images/ks-qkcp/zh/icons/pen-dark.svg new file mode 100644 index 000000000..bc07da1bd --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/pen-dark.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/pen-light.svg b/static/images/ks-qkcp/zh/icons/pen-light.svg new file mode 100644 index 000000000..ec7492cdb --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/pen-light.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/php.svg b/static/images/ks-qkcp/zh/icons/php.svg new file mode 100644 index 000000000..8a1d560fd --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/php.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/picture.svg b/static/images/ks-qkcp/zh/icons/picture.svg new file mode 100644 index 000000000..8943d6824 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/picture.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/pie-chart.svg b/static/images/ks-qkcp/zh/icons/pie-chart.svg new file mode 100644 index 000000000..a3c7eeeb5 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/pie-chart.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/pin.svg b/static/images/ks-qkcp/zh/icons/pin.svg new file mode 100644 index 000000000..07d314eda --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/pin.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/plus-square.svg b/static/images/ks-qkcp/zh/icons/plus-square.svg new file mode 100644 index 000000000..e6c7eff93 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/plus-square.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/pod.svg b/static/images/ks-qkcp/zh/icons/pod.svg new file mode 100644 index 000000000..c6c0b3295 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/pod.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/port.svg b/static/images/ks-qkcp/zh/icons/port.svg new file mode 100644 index 000000000..5c3cf0e46 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/port.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/power.svg b/static/images/ks-qkcp/zh/icons/power.svg new file mode 100644 index 000000000..26117a128 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/power.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/previous.svg b/static/images/ks-qkcp/zh/icons/previous.svg new file mode 100644 index 000000000..52155fdb0 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/previous.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/price.svg b/static/images/ks-qkcp/zh/icons/price.svg new file mode 100644 index 000000000..fe1e0a058 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/price.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/project.svg b/static/images/ks-qkcp/zh/icons/project.svg new file mode 100644 index 000000000..afc8dc370 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/project.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/proportion.svg b/static/images/ks-qkcp/zh/icons/proportion.svg new file mode 100644 index 000000000..9bd358c70 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/proportion.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/pull.svg b/static/images/ks-qkcp/zh/icons/pull.svg new file mode 100644 index 000000000..92bbb74c5 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/pull.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/python.svg b/static/images/ks-qkcp/zh/icons/python.svg new file mode 100644 index 000000000..165ab9cee --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/python.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/qingcloud.svg b/static/images/ks-qkcp/zh/icons/qingcloud.svg new file mode 100644 index 000000000..aa0e10ce8 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/qingcloud.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/question.svg b/static/images/ks-qkcp/zh/icons/question.svg new file mode 100644 index 000000000..c6d33405b --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/question.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/radio.svg b/static/images/ks-qkcp/zh/icons/radio.svg new file mode 100644 index 000000000..0823a4f6c --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/radio.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/record.svg b/static/images/ks-qkcp/zh/icons/record.svg new file mode 100644 index 000000000..776ca15f0 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/record.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/redhat.svg b/static/images/ks-qkcp/zh/icons/redhat.svg new file mode 100644 index 000000000..6145918c1 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/redhat.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/refresh-dark-white.svg b/static/images/ks-qkcp/zh/icons/refresh-dark-white.svg new file mode 100644 index 000000000..a1e26399b --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/refresh-dark-white.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/refresh-dark.svg b/static/images/ks-qkcp/zh/icons/refresh-dark.svg new file mode 100644 index 000000000..6bc2afde1 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/refresh-dark.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/refresh-light.svg b/static/images/ks-qkcp/zh/icons/refresh-light.svg new file mode 100644 index 000000000..9aa0395c9 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/refresh-light.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/remark.svg b/static/images/ks-qkcp/zh/icons/remark.svg new file mode 100644 index 000000000..e2f209d39 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/remark.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/report.svg b/static/images/ks-qkcp/zh/icons/report.svg new file mode 100644 index 000000000..c073f1aa5 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/report.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/resource.svg b/static/images/ks-qkcp/zh/icons/resource.svg new file mode 100644 index 000000000..a460a723a --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/resource.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/restart.svg b/static/images/ks-qkcp/zh/icons/restart.svg new file mode 100644 index 000000000..ec2b9dbc0 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/restart.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/return.svg b/static/images/ks-qkcp/zh/icons/return.svg new file mode 100644 index 000000000..81b3bc043 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/return.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/role.svg b/static/images/ks-qkcp/zh/icons/role.svg new file mode 100644 index 000000000..e5b68e468 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/role.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/router.svg b/static/images/ks-qkcp/zh/icons/router.svg new file mode 100644 index 000000000..0936b1150 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/router.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/safe-notice.svg b/static/images/ks-qkcp/zh/icons/safe-notice.svg new file mode 100644 index 000000000..a70ed4f00 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/safe-notice.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/scaling.svg b/static/images/ks-qkcp/zh/icons/scaling.svg new file mode 100644 index 000000000..4f6817a99 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/scaling.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/scheduler.svg b/static/images/ks-qkcp/zh/icons/scheduler.svg new file mode 100644 index 000000000..5b1cac361 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/scheduler.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/scissors.svg b/static/images/ks-qkcp/zh/icons/scissors.svg new file mode 100644 index 000000000..6888bfc28 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/scissors.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/select.svg b/static/images/ks-qkcp/zh/icons/select.svg new file mode 100644 index 000000000..d6c04cdbc --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/select.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/shield.svg b/static/images/ks-qkcp/zh/icons/shield.svg new file mode 100644 index 000000000..e90b403ea --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/shield.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/shutdown.svg b/static/images/ks-qkcp/zh/icons/shutdown.svg new file mode 100644 index 000000000..511412424 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/shutdown.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/slider.svg b/static/images/ks-qkcp/zh/icons/slider.svg new file mode 100644 index 000000000..eeb296f5c --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/slider.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/snapshot.svg b/static/images/ks-qkcp/zh/icons/snapshot.svg new file mode 100644 index 000000000..61beaeefa --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/snapshot.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/sonarqube.svg b/static/images/ks-qkcp/zh/icons/sonarqube.svg new file mode 100644 index 000000000..7c0a0da4f --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/sonarqube.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/sort-ascending.svg b/static/images/ks-qkcp/zh/icons/sort-ascending.svg new file mode 100644 index 000000000..191ad00e9 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/sort-ascending.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/sort-descending.svg b/static/images/ks-qkcp/zh/icons/sort-descending.svg new file mode 100644 index 000000000..83fa9c252 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/sort-descending.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/sorting.svg b/static/images/ks-qkcp/zh/icons/sorting.svg new file mode 100644 index 000000000..072aa0882 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/sorting.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/ssd.svg b/static/images/ks-qkcp/zh/icons/ssd.svg new file mode 100644 index 000000000..c136fad92 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/ssd.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/ssh.svg b/static/images/ks-qkcp/zh/icons/ssh.svg new file mode 100644 index 000000000..f52db4e87 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/ssh.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/star.svg b/static/images/ks-qkcp/zh/icons/star.svg new file mode 100644 index 000000000..36c50653c --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/star.svg @@ -0,0 +1,3 @@ + + + diff --git a/static/images/ks-qkcp/zh/icons/star_none.svg b/static/images/ks-qkcp/zh/icons/star_none.svg new file mode 100644 index 000000000..29c968c50 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/star_none.svg @@ -0,0 +1,3 @@ + + + diff --git a/static/images/ks-qkcp/zh/icons/start-dark.svg b/static/images/ks-qkcp/zh/icons/start-dark.svg new file mode 100644 index 000000000..18695a7e3 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/start-dark.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/start-light.svg b/static/images/ks-qkcp/zh/icons/start-light.svg new file mode 100644 index 000000000..2bdd67638 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/start-light.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/starter.svg b/static/images/ks-qkcp/zh/icons/starter.svg new file mode 100644 index 000000000..c395096c6 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/starter.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/stateful-set.svg b/static/images/ks-qkcp/zh/icons/stateful-set.svg new file mode 100644 index 000000000..0941cc7e3 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/stateful-set.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/step.svg b/static/images/ks-qkcp/zh/icons/step.svg new file mode 100644 index 000000000..d04223336 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/step.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/stop-dark-white.svg b/static/images/ks-qkcp/zh/icons/stop-dark-white.svg new file mode 100644 index 000000000..970527122 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/stop-dark-white.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/stop.svg b/static/images/ks-qkcp/zh/icons/stop.svg new file mode 100644 index 000000000..b76dee5b2 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/stop.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/storage.svg b/static/images/ks-qkcp/zh/icons/storage.svg new file mode 100644 index 000000000..23c884765 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/storage.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/strategy-group.svg b/static/images/ks-qkcp/zh/icons/strategy-group.svg new file mode 100644 index 000000000..b86669539 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/strategy-group.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/stretch.svg b/static/images/ks-qkcp/zh/icons/stretch.svg new file mode 100644 index 000000000..2caae0f2f --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/stretch.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/substract-dark.svg b/static/images/ks-qkcp/zh/icons/substract-dark.svg new file mode 100644 index 000000000..65998cc20 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/substract-dark.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/substract-light.svg b/static/images/ks-qkcp/zh/icons/substract-light.svg new file mode 100644 index 000000000..6efc13438 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/substract-light.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/substract-unhealthy.svg b/static/images/ks-qkcp/zh/icons/substract-unhealthy.svg new file mode 100644 index 000000000..402b4d542 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/substract-unhealthy.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/success.svg b/static/images/ks-qkcp/zh/icons/success.svg new file mode 100644 index 000000000..4dd2cbe04 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/success.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/svn.svg b/static/images/ks-qkcp/zh/icons/svn.svg new file mode 100644 index 000000000..2e0833a31 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/svn.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/table-chart.svg b/static/images/ks-qkcp/zh/icons/table-chart.svg new file mode 100644 index 000000000..72b4017a1 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/table-chart.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/tag.svg b/static/images/ks-qkcp/zh/icons/tag.svg new file mode 100644 index 000000000..64686cede --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/tag.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/target.svg b/static/images/ks-qkcp/zh/icons/target.svg new file mode 100644 index 000000000..2c05457ce --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/target.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/templet.svg b/static/images/ks-qkcp/zh/icons/templet.svg new file mode 100644 index 000000000..95a49d353 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/templet.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/terminal.svg b/static/images/ks-qkcp/zh/icons/terminal.svg new file mode 100644 index 000000000..e69c87f84 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/terminal.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/text.svg b/static/images/ks-qkcp/zh/icons/text.svg new file mode 100644 index 000000000..ff1ce9c48 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/text.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/textarea.svg b/static/images/ks-qkcp/zh/icons/textarea.svg new file mode 100644 index 000000000..82b1e8d57 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/textarea.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/textfield.svg b/static/images/ks-qkcp/zh/icons/textfield.svg new file mode 100644 index 000000000..05514d69f --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/textfield.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/theme.svg b/static/images/ks-qkcp/zh/icons/theme.svg new file mode 100644 index 000000000..2edbe3573 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/theme.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/thunder.svg b/static/images/ks-qkcp/zh/icons/thunder.svg new file mode 100644 index 000000000..cc7333b16 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/thunder.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/ticket.svg b/static/images/ks-qkcp/zh/icons/ticket.svg new file mode 100644 index 000000000..b0f11d17d --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/ticket.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/timed-task.svg b/static/images/ks-qkcp/zh/icons/timed-task.svg new file mode 100644 index 000000000..013f921de --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/timed-task.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/topology.svg b/static/images/ks-qkcp/zh/icons/topology.svg new file mode 100644 index 000000000..d011d7866 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/topology.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/trash-dark.svg b/static/images/ks-qkcp/zh/icons/trash-dark.svg new file mode 100644 index 000000000..92d6c9969 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/trash-dark.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/trash-light.svg b/static/images/ks-qkcp/zh/icons/trash-light.svg new file mode 100644 index 000000000..7b0ecd480 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/trash-light.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/triangle-down.svg b/static/images/ks-qkcp/zh/icons/triangle-down.svg new file mode 100644 index 000000000..d1e039e09 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/triangle-down.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/triangle-left.svg b/static/images/ks-qkcp/zh/icons/triangle-left.svg new file mode 100644 index 000000000..7e059f042 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/triangle-left.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/triangle-right.svg b/static/images/ks-qkcp/zh/icons/triangle-right.svg new file mode 100644 index 000000000..9e8ce27ce --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/triangle-right.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/triangle-up.svg b/static/images/ks-qkcp/zh/icons/triangle-up.svg new file mode 100644 index 000000000..b5eca7c8e --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/triangle-up.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/ubuntu.svg b/static/images/ks-qkcp/zh/icons/ubuntu.svg new file mode 100644 index 000000000..24b113113 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/ubuntu.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/update.svg b/static/images/ks-qkcp/zh/icons/update.svg new file mode 100644 index 000000000..78692da52 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/update.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/upload-dark-white.svg b/static/images/ks-qkcp/zh/icons/upload-dark-white.svg new file mode 100644 index 000000000..13444c910 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/upload-dark-white.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/usb-redirection.svg b/static/images/ks-qkcp/zh/icons/usb-redirection.svg new file mode 100644 index 000000000..34c6eb5ff --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/usb-redirection.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/user-overview.svg b/static/images/ks-qkcp/zh/icons/user-overview.svg new file mode 100644 index 000000000..392a1df31 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/user-overview.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/user-profile.svg b/static/images/ks-qkcp/zh/icons/user-profile.svg new file mode 100644 index 000000000..36a735851 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/user-profile.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/v2v.svg b/static/images/ks-qkcp/zh/icons/v2v.svg new file mode 100644 index 000000000..599e65d2e --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/v2v.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/vmware.svg b/static/images/ks-qkcp/zh/icons/vmware.svg new file mode 100644 index 000000000..76f109b02 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/vmware.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/vnas.svg b/static/images/ks-qkcp/zh/icons/vnas.svg new file mode 100644 index 000000000..281d85bd1 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/vnas.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/vnc.svg b/static/images/ks-qkcp/zh/icons/vnc.svg new file mode 100644 index 000000000..352191252 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/vnc.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/vpn.svg b/static/images/ks-qkcp/zh/icons/vpn.svg new file mode 100644 index 000000000..c5123ccfb --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/vpn.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/vsan.svg b/static/images/ks-qkcp/zh/icons/vsan.svg new file mode 100644 index 000000000..856807c87 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/vsan.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/wallet.svg b/static/images/ks-qkcp/zh/icons/wallet.svg new file mode 100644 index 000000000..c81b87899 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/wallet.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/war.svg b/static/images/ks-qkcp/zh/icons/war.svg new file mode 100644 index 000000000..f482ca50b --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/war.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/windows.svg b/static/images/ks-qkcp/zh/icons/windows.svg new file mode 100644 index 000000000..3a3ab4457 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/windows.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/wrench.svg b/static/images/ks-qkcp/zh/icons/wrench.svg new file mode 100644 index 000000000..52fd191b1 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/wrench.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/xls.svg b/static/images/ks-qkcp/zh/icons/xls.svg new file mode 100644 index 000000000..e4b75724b --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/xls.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/icons/zone.svg b/static/images/ks-qkcp/zh/icons/zone.svg new file mode 100644 index 000000000..8ba705656 --- /dev/null +++ b/static/images/ks-qkcp/zh/icons/zone.svg @@ -0,0 +1 @@ + diff --git a/static/images/ks-qkcp/zh/installation-and-upgrade/resource-usage.png b/static/images/ks-qkcp/zh/installation-and-upgrade/resource-usage.png new file mode 100644 index 000000000..d064408ee Binary files /dev/null and b/static/images/ks-qkcp/zh/installation-and-upgrade/resource-usage.png differ diff --git a/static/images/ks-qkcp/zh/multi-cluster-management/introduction/kubesphere-federation.png b/static/images/ks-qkcp/zh/multi-cluster-management/introduction/kubesphere-federation.png new file mode 100644 index 000000000..56864d797 Binary files /dev/null and b/static/images/ks-qkcp/zh/multi-cluster-management/introduction/kubesphere-federation.png differ diff --git a/static/images/ks-qkcp/zh/multi-cluster-management/introduction/multi-cluster-overview.png b/static/images/ks-qkcp/zh/multi-cluster-management/introduction/multi-cluster-overview.png new file mode 100644 index 000000000..2d7d3dc84 Binary files /dev/null and b/static/images/ks-qkcp/zh/multi-cluster-management/introduction/multi-cluster-overview.png differ diff --git a/static/images/ks-qkcp/zh/pdf/cover_doc_image.svg b/static/images/ks-qkcp/zh/pdf/cover_doc_image.svg new file mode 100644 index 000000000..2fa4f5ef6 --- /dev/null +++ b/static/images/ks-qkcp/zh/pdf/cover_doc_image.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/static/images/ks-qkcp/zh/pdf/kubesphere-enterprise-logo.svg b/static/images/ks-qkcp/zh/pdf/kubesphere-enterprise-logo.svg new file mode 100644 index 000000000..060192959 --- /dev/null +++ b/static/images/ks-qkcp/zh/pdf/kubesphere-enterprise-logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/static/images/ks-qkcp/zh/pdf/kubesphere-logo.svg b/static/images/ks-qkcp/zh/pdf/kubesphere-logo.svg new file mode 100644 index 000000000..7a75d738e --- /dev/null +++ b/static/images/ks-qkcp/zh/pdf/kubesphere-logo.svg @@ -0,0 +1,24 @@ + + + + KubeSphere®.svg + Created with Sketch. + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/static/images/ks-qkcp/zh/pdf/qingcloud-logo-color.png b/static/images/ks-qkcp/zh/pdf/qingcloud-logo-color.png new file mode 100644 index 000000000..a97875983 Binary files /dev/null and b/static/images/ks-qkcp/zh/pdf/qingcloud-logo-color.png differ diff --git a/static/images/ks-qkcp/zh/pdf/qingcloud-logo-icon.png b/static/images/ks-qkcp/zh/pdf/qingcloud-logo-icon.png new file mode 100644 index 000000000..056c35c94 Binary files /dev/null and b/static/images/ks-qkcp/zh/pdf/qingcloud-logo-icon.png differ diff --git a/static/images/ks-qkcp/zh/pdf/watermark.png b/static/images/ks-qkcp/zh/pdf/watermark.png new file mode 100644 index 000000000..f90f93cf5 Binary files /dev/null and b/static/images/ks-qkcp/zh/pdf/watermark.png differ diff --git a/static/images/ks-qkcp/zh/platform/log-elasticsearch.png b/static/images/ks-qkcp/zh/platform/log-elasticsearch.png new file mode 100644 index 000000000..668452f03 Binary files /dev/null and b/static/images/ks-qkcp/zh/platform/log-elasticsearch.png differ diff --git a/static/images/ks-qkcp/zh/quickstart/wordpress-page.png b/static/images/ks-qkcp/zh/quickstart/wordpress-page.png new file mode 100644 index 000000000..f5ada1cc6 Binary files /dev/null and b/static/images/ks-qkcp/zh/quickstart/wordpress-page.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/access-kafka.png b/static/images/ks-qkcp/zh/radondb-management/access-kafka.png new file mode 100644 index 000000000..e0dcc62cc Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/access-kafka.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/all-access-success.png b/static/images/ks-qkcp/zh/radondb-management/all-access-success.png new file mode 100644 index 000000000..7ff567209 Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/all-access-success.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/certificate-details.png b/static/images/ks-qkcp/zh/radondb-management/certificate-details.png new file mode 100644 index 000000000..ee01bd77e Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/certificate-details.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/create-kafka-user.png b/static/images/ks-qkcp/zh/radondb-management/create-kafka-user.png new file mode 100644 index 000000000..8321a70e5 Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/create-kafka-user.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/create-topic.png b/static/images/ks-qkcp/zh/radondb-management/create-topic.png new file mode 100644 index 000000000..807219a72 Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/create-topic.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/dashboard-only-fail.png b/static/images/ks-qkcp/zh/radondb-management/dashboard-only-fail.png new file mode 100644 index 000000000..07251b878 Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/dashboard-only-fail.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/dashboard-only-success.png b/static/images/ks-qkcp/zh/radondb-management/dashboard-only-success.png new file mode 100644 index 000000000..4d7274bbd Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/dashboard-only-success.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/download-CA-user-certificate.png b/static/images/ks-qkcp/zh/radondb-management/download-CA-user-certificate.png new file mode 100644 index 000000000..39525c32e Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/download-CA-user-certificate.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/edit-external-service.png b/static/images/ks-qkcp/zh/radondb-management/edit-external-service.png new file mode 100644 index 000000000..0a8eb3cdb Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/edit-external-service.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/elastic-user.png b/static/images/ks-qkcp/zh/radondb-management/elastic-user.png new file mode 100644 index 000000000..dbce79b2a Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/elastic-user.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/kafka-input-success.png b/static/images/ks-qkcp/zh/radondb-management/kafka-input-success.png new file mode 100644 index 000000000..184adc982 Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/kafka-input-success.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/kafka-terminal.png b/static/images/ks-qkcp/zh/radondb-management/kafka-terminal.png new file mode 100644 index 000000000..691ba972f Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/kafka-terminal.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/kakfa-index.png b/static/images/ks-qkcp/zh/radondb-management/kakfa-index.png new file mode 100644 index 000000000..20f951548 Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/kakfa-index.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/kibana-login.png b/static/images/ks-qkcp/zh/radondb-management/kibana-login.png new file mode 100644 index 000000000..8a07e04ac Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/kibana-login.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/mongodb-user.png b/static/images/ks-qkcp/zh/radondb-management/mongodb-user.png new file mode 100644 index 000000000..41ff2c2ef Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/mongodb-user.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/multiuser-access.png b/static/images/ks-qkcp/zh/radondb-management/multiuser-access.png new file mode 100644 index 000000000..86cb30139 Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/multiuser-access.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/mysql-terminal.png b/static/images/ks-qkcp/zh/radondb-management/mysql-terminal.png new file mode 100644 index 000000000..3f95b000f Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/mysql-terminal.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/os-certificate.png b/static/images/ks-qkcp/zh/radondb-management/os-certificate.png new file mode 100644 index 000000000..9393632fa Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/os-certificate.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/os-create-cluster.png b/static/images/ks-qkcp/zh/radondb-management/os-create-cluster.png new file mode 100644 index 000000000..1083bfde8 Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/os-create-cluster.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/os-dashboards.png b/static/images/ks-qkcp/zh/radondb-management/os-dashboards.png new file mode 100644 index 000000000..2b55fd244 Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/os-dashboards.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/os-external.png b/static/images/ks-qkcp/zh/radondb-management/os-external.png new file mode 100644 index 000000000..ccf6269b9 Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/os-external.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/os-login.png b/static/images/ks-qkcp/zh/radondb-management/os-login.png new file mode 100644 index 000000000..281de0d4a Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/os-login.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/radondb_clickhouse_arch.png b/static/images/ks-qkcp/zh/radondb-management/radondb_clickhouse_arch.png new file mode 100644 index 000000000..54f57863d Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/radondb_clickhouse_arch.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/radondb_mysql_arch.png b/static/images/ks-qkcp/zh/radondb-management/radondb_mysql_arch.png new file mode 100644 index 000000000..2e5ce06f1 Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/radondb_mysql_arch.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/radondb_postgresql_arch.png b/static/images/ks-qkcp/zh/radondb-management/radondb_postgresql_arch.png new file mode 100644 index 000000000..0c99ce3a4 Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/radondb_postgresql_arch.png differ diff --git a/static/images/ks-qkcp/zh/radondb-management/verify-certificate.png b/static/images/ks-qkcp/zh/radondb-management/verify-certificate.png new file mode 100644 index 000000000..6d12c3a65 Binary files /dev/null and b/static/images/ks-qkcp/zh/radondb-management/verify-certificate.png differ diff --git a/static/images/ks-qkcp/zh/technical-white-papers/network-radar.png b/static/images/ks-qkcp/zh/technical-white-papers/network-radar.png new file mode 100644 index 000000000..4a03d379e Binary files /dev/null and b/static/images/ks-qkcp/zh/technical-white-papers/network-radar.png differ diff --git a/static/images/ks-qkcp/zh/technical-white-papers/scan.png b/static/images/ks-qkcp/zh/technical-white-papers/scan.png new file mode 100644 index 000000000..8b4532a67 Binary files /dev/null and b/static/images/ks-qkcp/zh/technical-white-papers/scan.png differ diff --git a/static/images/ks-qkcp/zh/v4.0/4.0-architecture.png b/static/images/ks-qkcp/zh/v4.0/4.0-architecture.png new file mode 100644 index 000000000..d32d0e0f6 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.0/4.0-architecture.png differ diff --git a/static/images/ks-qkcp/zh/v4.0/choose-version.png b/static/images/ks-qkcp/zh/v4.0/choose-version.png new file mode 100644 index 000000000..629c0b24a Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.0/choose-version.png differ diff --git a/static/images/ks-qkcp/zh/v4.0/install-complete.png b/static/images/ks-qkcp/zh/v4.0/install-complete.png new file mode 100644 index 000000000..74596741d Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.0/install-complete.png differ diff --git a/static/images/ks-qkcp/zh/v4.0/install-extensions.png b/static/images/ks-qkcp/zh/v4.0/install-extensions.png new file mode 100644 index 000000000..44490b5e9 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.0/install-extensions.png differ diff --git a/static/images/ks-qkcp/zh/v4.0/ks-architecture.png b/static/images/ks-qkcp/zh/v4.0/ks-architecture.png new file mode 100644 index 000000000..4aab3e48e Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.0/ks-architecture.png differ diff --git a/static/images/ks-qkcp/zh/v4.0/ks-tech-architecture.png b/static/images/ks-qkcp/zh/v4.0/ks-tech-architecture.png new file mode 100644 index 000000000..81f59a01f Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.0/ks-tech-architecture.png differ diff --git a/static/images/ks-qkcp/zh/v4.0/kubectl.png b/static/images/ks-qkcp/zh/v4.0/kubectl.png new file mode 100644 index 000000000..406e4d6ca Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.0/kubectl.png differ diff --git a/static/images/ks-qkcp/zh/v4.0/openshift-architecture.png b/static/images/ks-qkcp/zh/v4.0/openshift-architecture.png new file mode 100644 index 000000000..797a955d5 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.0/openshift-architecture.png differ diff --git a/static/images/ks-qkcp/zh/v4.0/rancher-architecture.png b/static/images/ks-qkcp/zh/v4.0/rancher-architecture.png new file mode 100644 index 000000000..04778b1a3 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.0/rancher-architecture.png differ diff --git a/static/images/ks-qkcp/zh/v4.0/rancher-tech-architecture.png b/static/images/ks-qkcp/zh/v4.0/rancher-tech-architecture.png new file mode 100644 index 000000000..4565b59eb Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.0/rancher-tech-architecture.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/backup.png b/static/images/ks-qkcp/zh/v4.1/backup.png new file mode 100644 index 000000000..44fc46ada Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/backup.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/ca-crt.png b/static/images/ks-qkcp/zh/v4.1/ca-crt.png new file mode 100644 index 000000000..06ca290ce Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/ca-crt.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/check-permission.png b/static/images/ks-qkcp/zh/v4.1/check-permission.png new file mode 100644 index 000000000..75daa2ee4 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/check-permission.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/disable-opensearch.png b/static/images/ks-qkcp/zh/v4.1/disable-opensearch.png new file mode 100644 index 000000000..637d0cbad Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/disable-opensearch.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/disable-two-factor-authentication.png b/static/images/ks-qkcp/zh/v4.1/disable-two-factor-authentication.png new file mode 100644 index 000000000..80ebe75d7 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/disable-two-factor-authentication.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/dmp.png b/static/images/ks-qkcp/zh/v4.1/dmp.png new file mode 100644 index 000000000..9805203ad Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/dmp.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/edit-endpoint.png b/static/images/ks-qkcp/zh/v4.1/edit-endpoint.png new file mode 100644 index 000000000..89cefbf4b Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/edit-endpoint.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/edit-permission.png b/static/images/ks-qkcp/zh/v4.1/edit-permission.png new file mode 100644 index 000000000..97e748cf7 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/edit-permission.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/enable-topic.png b/static/images/ks-qkcp/zh/v4.1/enable-topic.png new file mode 100644 index 000000000..901090c74 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/enable-topic.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/enable-two-factor-authentication.png b/static/images/ks-qkcp/zh/v4.1/enable-two-factor-authentication.png new file mode 100644 index 000000000..614cb4ef0 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/enable-two-factor-authentication.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/ip-address.png b/static/images/ks-qkcp/zh/v4.1/ip-address.png new file mode 100644 index 000000000..83048cba5 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/ip-address.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/kafka-user.png b/static/images/ks-qkcp/zh/v4.1/kafka-user.png new file mode 100644 index 000000000..4518257d6 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/kafka-user.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/kafka.png b/static/images/ks-qkcp/zh/v4.1/kafka.png new file mode 100644 index 000000000..afc682d7f Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/kafka.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/kubeedge-port.png b/static/images/ks-qkcp/zh/v4.1/kubeedge-port.png new file mode 100644 index 000000000..1cd06a5dc Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/kubeedge-port.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/log.png b/static/images/ks-qkcp/zh/v4.1/log.png new file mode 100644 index 000000000..b70cf98b0 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/log.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/parameter.png b/static/images/ks-qkcp/zh/v4.1/parameter.png new file mode 100644 index 000000000..08ad06b3c Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/parameter.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/storage1.png b/static/images/ks-qkcp/zh/v4.1/storage1.png new file mode 100644 index 000000000..866d4bee1 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/storage1.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/storage2.png b/static/images/ks-qkcp/zh/v4.1/storage2.png new file mode 100644 index 000000000..9473ecc8d Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/storage2.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/user-password.png b/static/images/ks-qkcp/zh/v4.1/user-password.png new file mode 100644 index 000000000..905820898 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/user-password.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/user-permission.png b/static/images/ks-qkcp/zh/v4.1/user-permission.png new file mode 100644 index 000000000..fa15adefe Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/user-permission.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/vector-solution.png b/static/images/ks-qkcp/zh/v4.1/vector-solution.png new file mode 100644 index 000000000..ae94f6364 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/vector-solution.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/verify-extension-installed.png b/static/images/ks-qkcp/zh/v4.1/verify-extension-installed.png new file mode 100644 index 000000000..cf839d233 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/verify-extension-installed.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/verify-extension-release.png b/static/images/ks-qkcp/zh/v4.1/verify-extension-release.png new file mode 100644 index 000000000..1b28243a1 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/verify-extension-release.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/verify-registry.png b/static/images/ks-qkcp/zh/v4.1/verify-registry.png new file mode 100644 index 000000000..24e862211 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/verify-registry.png differ diff --git a/static/images/ks-qkcp/zh/v4.1/whizard-telemetry-config.png b/static/images/ks-qkcp/zh/v4.1/whizard-telemetry-config.png new file mode 100644 index 000000000..336b368e0 Binary files /dev/null and b/static/images/ks-qkcp/zh/v4.1/whizard-telemetry-config.png differ