mirror of
https://github.com/kubesphere/website.git
synced 2025-12-25 15:32:54 +00:00
KubeSphere CI Bot
GitHub
commit
9874fb0533
|
|
@ -10,10 +10,10 @@ export default async (req, context) => {
|
|||
let hasContentAfterDocs = false;
|
||||
const newPath = path.replace(/(\/docs\/)(.*)$/, (match, p1, p2) => {
|
||||
if (p2.trim() === "") {
|
||||
return `${p1}v3.4/`;
|
||||
return `${p1}v4.1/`;
|
||||
} else {
|
||||
hasContentAfterDocs = true;
|
||||
return `${p1}v3.4/${p2}`;
|
||||
return `${p1}v4.1/${p2}`;
|
||||
}
|
||||
});
|
||||
|
||||
|
|
|
|||
|
|
@ -28,29 +28,12 @@ ignorefiles = [ ".*/_custom" ]
|
|||
toclevels = 2
|
||||
file_output_type = "html"
|
||||
relfilesuffix = "/"
|
||||
ks_product = " KubeSphere 企业版"
|
||||
ks_product_left = " KubeSphere 企业版"
|
||||
ks_product_right = "KubeSphere 企业版"
|
||||
ks_product_both = " KubeSphere 企业版"
|
||||
ks_product_full = "KubeSphere 企业版"
|
||||
ks_product_full_left = " KubeSphere 企业版"
|
||||
ks_product_full_right = "KubeSphere 企业版"
|
||||
ks_product_full_both = " KubeSphere 企业版"
|
||||
ks_product_abbr_full = "KubeSphere 企业版"
|
||||
ks_product_abbr_full_left = " KubeSphere 企业版"
|
||||
ks_product_abbr_full_right = "KubeSphere 企业版"
|
||||
ks_product_abbr_full_both = " KubeSphere 企业版"
|
||||
ks_product_low = "kubesphere-enterprise"
|
||||
ks_product_ver = "v3.4.0"
|
||||
clickhouse_product_ver = "v2.1.1"
|
||||
mysql_product_ver = "v2.3.0"
|
||||
kafka_product_ver = "v1.0.0"
|
||||
opensearch_product_ver = "v1.0.0"
|
||||
postgresql_product_ver = "v1.2.0"
|
||||
redis_cluster_product_ver = "v1.0.0"
|
||||
redis_sentinel_product_ver = "v1.0.0"
|
||||
eck_product_ver = "v2.2.0"
|
||||
mongodb_product_ver = "v2.1.2"
|
||||
ks_product = "KubeSphere"
|
||||
ks_product_left = " KubeSphere"
|
||||
ks_product_right = "KubeSphere "
|
||||
ks_product_both = " KubeSphere "
|
||||
ks_product_full = "KubeSphere"
|
||||
ks_product_ver = "v4.1"
|
||||
|
||||
[security]
|
||||
enableInlineShortcodes = false
|
||||
|
|
@ -63,6 +46,9 @@ ignorefiles = [ ".*/_custom" ]
|
|||
methods = ['(?i)GET|POST']
|
||||
urls = ['.*']
|
||||
|
||||
[security.gotemplates]
|
||||
allowActionJSTmpl = true
|
||||
|
||||
[Taxonomies]
|
||||
|
||||
[params]
|
||||
|
|
@ -173,49 +159,49 @@ hasChildren = true
|
|||
parent = "Documentation"
|
||||
name = "v3.4 <img src='/images/header/star.svg' alt='star'>"
|
||||
URL = "/docs/v3.4"
|
||||
weight = 1
|
||||
weight = 43
|
||||
|
||||
[[languages.en.menu.main]]
|
||||
parent = "Documentation"
|
||||
name = "v3.3"
|
||||
URL = "/docs/v3.3"
|
||||
weight = 2
|
||||
weight = 44
|
||||
|
||||
[[languages.en.menu.main]]
|
||||
parent = "Documentation"
|
||||
name = "v3.2"
|
||||
URL = "https://v3-2.docs.kubesphere.io/docs"
|
||||
weight = 3
|
||||
weight = 45
|
||||
|
||||
[[languages.en.menu.main]]
|
||||
parent = "Documentation"
|
||||
name = "v3.1"
|
||||
URL = "https://v3-1.docs.kubesphere.io/docs"
|
||||
weight = 4
|
||||
weight = 46
|
||||
|
||||
[[languages.en.menu.main]]
|
||||
parent = "Documentation"
|
||||
name = "v3.0"
|
||||
URL = "https://v3-0.docs.kubesphere.io/docs"
|
||||
weight = 5
|
||||
weight = 47
|
||||
|
||||
[[languages.en.menu.main]]
|
||||
parent = "Documentation"
|
||||
name = "v2.1"
|
||||
URL = "https://v2-1.docs.kubesphere.io/docs"
|
||||
weight = 6
|
||||
weight = 48
|
||||
|
||||
[[languages.en.menu.main]]
|
||||
parent = "Documentation"
|
||||
name = "v2.0"
|
||||
URL = "https://v2-0.docs.kubesphere.io/docs/"
|
||||
weight = 7
|
||||
weight = 49
|
||||
|
||||
[[languages.en.menu.main]]
|
||||
parent = "Documentation"
|
||||
name = "v1.0"
|
||||
URL = "https://v1-0.docs.kubesphere.io/docs/"
|
||||
weight = 8
|
||||
weight = 50
|
||||
|
||||
[[languages.en.menu.main]]
|
||||
weight = 5
|
||||
|
|
@ -338,51 +324,57 @@ hasChildren = true
|
|||
name = "文档中心"
|
||||
[[languages.zh.menu.main]]
|
||||
parent = "文档中心"
|
||||
name = "v3.4 <img src='/images/header/star.svg' alt='star'>"
|
||||
name = "v4.1 <img src='/images/header/star.svg' alt='star'>"
|
||||
URL = "/docs/v4.1"
|
||||
weight = 42
|
||||
|
||||
[[languages.zh.menu.main]]
|
||||
parent = "文档中心"
|
||||
name = "v3.4"
|
||||
URL = "/docs/v3.4"
|
||||
weight = 1
|
||||
weight = 43
|
||||
|
||||
[[languages.zh.menu.main]]
|
||||
parent = "文档中心"
|
||||
name = "v3.3"
|
||||
URL = "/docs/v3.3"
|
||||
weight = 2
|
||||
weight = 44
|
||||
|
||||
[[languages.zh.menu.main]]
|
||||
parent = "文档中心"
|
||||
name = "v3.2"
|
||||
URL = "https://v3-2.docs.kubesphere.io/zh/docs/"
|
||||
weight = 3
|
||||
weight = 45
|
||||
|
||||
[[languages.zh.menu.main]]
|
||||
parent = "文档中心"
|
||||
name = "v3.1"
|
||||
URL = "https://v3-1.docs.kubesphere.io/zh/docs/"
|
||||
weight = 4
|
||||
weight = 46
|
||||
|
||||
[[languages.zh.menu.main]]
|
||||
parent = "文档中心"
|
||||
name = "v3.0"
|
||||
URL = "https://v3-0.docs.kubesphere.io/zh/docs/"
|
||||
weight = 5
|
||||
weight = 47
|
||||
|
||||
[[languages.zh.menu.main]]
|
||||
parent = "文档中心"
|
||||
name = "v2.1"
|
||||
URL = "https://v2-1.docs.kubesphere.io/docs/zh-CN/"
|
||||
weight = 6
|
||||
weight = 48
|
||||
|
||||
[[languages.zh.menu.main]]
|
||||
parent = "文档中心"
|
||||
name = "v2.0"
|
||||
URL = "https://v2-0.docs.kubesphere.io/docs/zh-CN/"
|
||||
weight = 7
|
||||
weight = 49
|
||||
|
||||
[[languages.zh.menu.main]]
|
||||
parent = "文档中心"
|
||||
name = "v1.0"
|
||||
URL = "https://v1-0.docs.kubesphere.io/docs/zh-CN/"
|
||||
weight = 8
|
||||
weight = 50
|
||||
|
||||
[[languages.zh.menu.main]]
|
||||
weight = 5
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: f3341457c4584e59b799240a35ca496d
|
||||
您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:05-cluster-management/12-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:05-cluster-management/12-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。
|
||||
您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:05-cluster-management/12-cluster-settings/03-cluster-members/[集群成员]和xref:05-cluster-management/12-cluster-settings/04-cluster-roles/[集群角色]。
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: f3341457c4584e59b799240a35ca496d
|
||||
您需要加入一个集群或项目，并在集群或项目中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]和xref:09-project-management/06-project-settings/02-project-roles/_index.adoc[项目角色]。
|
||||
您需要加入一个集群或项目，并在集群或项目中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]和xref:09-project-management/06-project-settings/02-project-roles/[项目角色]。
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: f3341457c4584e59b799240a35ca496d
|
||||
您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。
|
||||
您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅“集群成员”和“集群角色”。
|
||||
|
|
|
|||
|
|
@ -3,5 +3,5 @@ ifeval::["{file_output_type}" == "html"]
|
|||
* {ks_product_right}平台需要启用网络策略扩展组件。
|
||||
endif::[]
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
* {ks_product_right}平台需要启用网络策略扩展组件。有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。
|
||||
* {ks_product_right}平台需要启用网络策略扩展组件。有关更多信息，请参阅《{ks_product_right}平台管理指南》的“扩展组件管理”章节。
|
||||
endif::[]
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
// :ks_include_id: 07a04c60e8c342db9bc6ec8108be9412
|
||||
ifeval::["{file_output_type}" == "html"]
|
||||
* {ks_product_right}平台需要启用容器组 IP 池扩展组件。
|
||||
有关更多信息，请参阅 xref:04-platform-management/01-extension-management/_index.adoc[启用可插拔组件]。
|
||||
有关更多信息，请参阅 xref:04-platform-management/01-extension-management/[启用可插拔组件]。
|
||||
endif::[]
|
||||
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。
|
||||
有关更多信息，请参阅《{ks_product_right}平台管理指南》的“扩展组件管理”章节。
|
||||
endif::[]
|
||||
|
|
@ -7,6 +7,6 @@ endif::[]
|
|||
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
|
||||
* {ks_product_right}平台需要启用告警系统扩展组件。关于更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。
|
||||
* {ks_product_right}平台需要启用告警系统扩展组件。关于更多信息，请参阅《{ks_product_right}平台管理指南》的“扩展组件管理”章节。
|
||||
|
||||
endif::[]
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
// :ks_include_id: 01792eb26cce4187b5a1f964404e6037
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
|
||||
有关如何在项目中启用**收集卷上的日志**，请参阅《{ks_product_full_right}项目管理指南》的“日志收集”章节。
|
||||
有关如何在项目中启用**收集卷上的日志**，请参阅《{ks_product_right}项目管理指南》的“日志收集”章节。
|
||||
|
||||
endif::[]
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
// :ks_include_id: 6963bdcc859e4b46817de17172bb750a
|
||||
// Bash
|
||||
include::../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
./kk add nodes -f config-sample.yaml -a kubekey-artifact.tar.gz
|
||||
|
||||
[,bash]
|
||||
----
|
||||
./kk add nodes -f config-sample.yaml
|
||||
----
|
||||
|
||||
// ./kk add nodes -f config-sample.yaml -a kubekey-artifact.tar.gz
|
||||
|
|
|
|||
|
|
@ -4,42 +4,37 @@
|
|||
+
|
||||
--
|
||||
// Bash
|
||||
include::../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
[,bash]
|
||||
----
|
||||
export KKZONE=cn
|
||||
|
||||
----
|
||||
--
|
||||
|
||||
|
||||
. 执行以下命令下载 KubeKey 最新版本：
|
||||
+
|
||||
--
|
||||
// Bash
|
||||
include::../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
[,bash]
|
||||
----
|
||||
curl -sfL https://get-kk.kubesphere.io | sh -
|
||||
|
||||
----
|
||||
|
||||
下载完成后当前目录下将生成 KubeKey 二进制文件 **kk**。
|
||||
|
||||
// Note
|
||||
include::../../../_ks_components/admonitions/note.adoc[]
|
||||
// include::../../../_ks_components/admonitions/note.adoc[]
|
||||
|
||||
如果用于执行本节操作的集群节点无法连接互联网，您可以从互联网连接正常的设备手动link:https://github.com/kubesphere/kubekey/releases[下载 KubeKey] 然后将其传输到用于执行本节操作的集群节点。
|
||||
// 如果用于执行本节操作的集群节点无法连接互联网，您可以从互联网连接正常的设备手动link:https://github.com/kubesphere/kubekey/releases[下载 KubeKey] 然后将其传输到用于执行本节操作的集群节点。
|
||||
|
||||
include::../../../_ks_components/admonitions/admonEnd.adoc[]
|
||||
// include::../../../_ks_components/admonitions/admonEnd.adoc[]
|
||||
--
|
||||
// end::download-kubekey[]
|
||||
|
||||
. 执行以下命令为 KubeKey 二进制文件 **kk** 添加执行权限：
|
||||
+
|
||||
--
|
||||
// Bash
|
||||
include::../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
[,bash]
|
||||
----
|
||||
sudo chmod +x kk
|
||||
|
||||
----
|
||||
--
|
||||
|
|
|
|||
|
|
@ -1,20 +0,0 @@
|
|||
// :ks_include_id: bc97a1c3d087413bba734c07a3edb221
|
||||
. 登录所有集群节点，执行以下命令编辑 **/etc/hosts** 文件：
|
||||
+
|
||||
--
|
||||
// Bash
|
||||
include::../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
vi /etc/hosts
|
||||
|
||||
----
|
||||
|
||||
在 **/etc/hosts** 文件中添加以下信息，从而为集群节点配置私有镜像服务的域名解析规则（将 <registry IP address> 替换成私有镜像服务的实际 IP 地址），然后保存文件：
|
||||
|
||||
// Bash
|
||||
include::../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
<registry IP address> dockerhub.kubekey.local
|
||||
|
||||
----
|
||||
--
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
// :ks_include_id: 161aaad98ab04d7fa4240eec51d232f7
|
||||
. 以具有pass:a,q[{ks_permission}]权限的用户登录{ks_product_left} Web 控制台并进入您的多集群项目。
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
// :ks_include_id: a7b11e38d6794c2692390f9d0afbb7df
|
||||
您需要加入一个多集群项目并在项目中具有pass:a,q[{ks_permission}]权限。
|
||||
|
|
@ -1,3 +1,3 @@
|
|||
// :ks_include_id: 7f602e6e82414c39b2434c3a6ef39aa0
|
||||
|分类
|
||||
|应用模板所属的分类。您可以将应用模板分配到一个分类中以便于管理。有关更多信息，请参阅xref:04-platform-management/05-app-store-management/02-app-categories/_index.adoc[应用分类]。
|
||||
|应用模板所属的分类。您可以将应用模板分配到一个分类中以便于管理。有关更多信息，请参阅xref:04-platform-management/05-app-store-management/02-app-categories/[应用分类]。
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 533e874085874479aae0d8bb598443f2
|
||||
您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅xref:04-platform-management/04-access-control/02-users/_index.adoc[用户]和xref:04-platform-management/04-access-control/03-platform-roles/_index.adoc[平台角色]。
|
||||
您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅xref:04-platform-management/04-access-control/02-users/[用户]和xref:04-platform-management/04-access-control/03-platform-roles/[平台角色]。
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: dea142b7ab3e4c6292a968da83aa19c0
|
||||
* 您需要在主集群和成员集群中都具有 **platform-admin** 角色。有关更多信息，请参阅xref:04-platform-management/04-access-control/02-users/_index.adoc[用户]和xref:04-platform-management/04-access-control/03-platform-roles/_index.adoc[平台角色]。
|
||||
* 您需要在主集群和成员集群中都具有 **platform-admin** 角色。有关更多信息，请参阅xref:04-platform-management/04-access-control/02-users/[用户]和xref:04-platform-management/04-access-control/03-platform-roles/[平台角色]。
|
||||
|
|
|
|||
|
|
@ -1,2 +0,0 @@
|
|||
// :ks_include_id: 95e415bcbafa45ed8545cb7700801b09
|
||||
您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:04-platform-management/04-access-control/02-users/_index.adoc[用户]和xref:04-platform-management/04-access-control/03-platform-roles/_index.adoc[平台角色]。
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 95e415bcbafa45ed8545cb7700801b09
|
||||
您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:05-users-and-roles/01-users/_index.adoc[用户]和xref:05-users-and-roles/02-platform-roles/_index.adoc[平台角色]。
|
||||
您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅“用户”和“平台角色”。
|
||||
|
|
|
|||
|
|
@ -7,6 +7,6 @@ endif::[]
|
|||
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
|
||||
* {ks_product_right}平台需要启用应用治理扩展组件。有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。
|
||||
* {ks_product_right}平台需要启用应用治理扩展组件。有关更多信息，请参阅《{ks_product_right}平台管理指南》的“扩展组件管理”章节。
|
||||
|
||||
endif::[]
|
||||
|
|
|
|||
|
|
@ -3,5 +3,5 @@ ifeval::["{file_output_type}" == "html"]
|
|||
* {ks_product_right}平台需要启用 Spring Cloud 扩展组件。
|
||||
endif::[]
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
* {ks_product_right}平台需要启用 Spring Cloud 扩展组件。有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。
|
||||
* {ks_product_right}平台需要启用 Spring Cloud 扩展组件。有关更多信息，请参阅《{ks_product_right}平台管理指南》的“扩展组件管理”章节。
|
||||
endif::[]
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 6579f3ef4c70439ca10c8e8de94ce9fb
|
||||
您需要加入一个项目并在项目中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-project-management/10-project-settings/04-project-members/_index.adoc[项目成员]和xref:07-project-management/10-project-settings/03-project-roles/02-view-a-project-role-list.adoc[项目角色]。
|
||||
您需要加入一个项目并在项目中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-project-management/10-project-settings/04-project-members/[项目成员]和xref:07-project-management/10-project-settings/03-project-roles/02-view-a-project-role-list.adoc[项目角色]。
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 6579f3ef4c70439ca10c8e8de94ce9fb
|
||||
您需要加入一个项目并在项目中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:09-project-management/06-project-settings/03-project-members/_index.adoc[项目成员]和xref:09-project-management/06-project-settings/02-project-roles/_index.adoc[项目角色]。
|
||||
您需要加入一个项目并在项目中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅“项目成员”和“项目角色”。
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 6113bcafa9264e92892a1889dbfe7330
|
||||
有关镜像构建器的更多信息，请参阅xref:07-project-management/08-image-builder/_index.adoc[镜像构建器]。
|
||||
有关镜像构建器的更多信息，请参阅xref:07-project-management/08-image-builder/[镜像构建器]。
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 716996e4cfe04beaa6a39a03ae610b86
|
||||
有关如何在项目中启用**收集卷上的日志**，请参阅link:/Users/keke/works/pitrix/repo/ks-qkcp-docs/ks-qkcp/docs-zh/@ks-qkcp/docs-zh/08-multi-cluster-project-management/06-project-settings/04-log-collection/_index.adoc[日志收集]。
|
||||
有关如何在项目中启用**收集卷上的日志**，请参阅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/[日志收集]。
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 7318136ea443449a9e862e964a41299f
|
||||
有关如何在项目中启用**收集卷上的日志**，请参阅xref:07-project-management/10-project-settings/06-log-collection/_index.adoc[日志收集]。
|
||||
有关如何在项目中启用**收集卷上的日志**，请参阅xref:07-project-management/10-project-settings/06-log-collection/[日志收集]。
|
||||
|
|
|
|||
|
|
@ -3,5 +3,5 @@ ifeval::["{file_output_type}" == "html"]
|
|||
* {ks_product_right}平台需要启用数据库管理平台扩展组件。
|
||||
endif::[]
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
* {ks_product_right}平台需要启用数据库管理平台扩展组件。有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。
|
||||
* {ks_product_right}平台需要启用数据库管理平台扩展组件。有关更多信息，请参阅《{ks_product_right}平台管理指南》的“扩展组件管理”章节。
|
||||
endif::[]
|
||||
|
|
|
|||
|
|
@ -7,6 +7,6 @@ endif::[]
|
|||
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
|
||||
* {ks_product_right}平台需要启用应用管理扩展组件。有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。
|
||||
* {ks_product_right}平台需要启用应用管理扩展组件。有关更多信息，请参阅《{ks_product_right}平台管理指南》的“扩展组件管理”章节。
|
||||
|
||||
endif::[]
|
||||
|
|
|
|||
|
|
@ -7,6 +7,6 @@ endif::[]
|
|||
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
|
||||
* {ks_product_right}平台需要启用 DevOps 扩展组件。有关更多信息，请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。
|
||||
* {ks_product_right}平台需要启用 DevOps 扩展组件。有关更多信息，请参阅《{ks_product_right}平台管理指南》的“扩展组件管理”章节。
|
||||
|
||||
endif::[]
|
||||
|
|
|
|||
|
|
@ -11,8 +11,8 @@ endif::[]
|
|||
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
|
||||
* {ks_product_right}平台需要启用日志、事件和审计扩展组件。有关更多信息，请参阅《{ks_product_full_both}平台管理指南》的“扩展组件管理”章节。
|
||||
* {ks_product_right}平台需要启用日志、事件和审计扩展组件。有关更多信息，请参阅《{ks_product_both}平台管理指南》的“扩展组件管理”章节。
|
||||
|
||||
* {ks_product_right}集群需要添加 Elasticsearch 日志接收器。有关更多信息，请参阅《{ks_product_full_right}集群管理指南》的“添加日志接收器”章节。
|
||||
* {ks_product_right}集群需要添加 Elasticsearch 日志接收器。有关更多信息，请参阅《{ks_product_right}集群管理指南》的“添加日志接收器”章节。
|
||||
|
||||
endif::[]
|
||||
|
|
|
|||
|
|
@ -1,2 +0,0 @@
|
|||
// :ks_include_id: 05d7ebe027f04cc589e8baa04343e651
|
||||
您需要加入一个企业空间并在企业空间中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:06-workspace-management/06-workspace-settings/03-workspace-members/_index.adoc[企业空间成员]、xref:06-workspace-management/06-workspace-settings/04-workspace-roles/_index.adoc[企业空间角色]和xref:06-workspace-management/06-workspace-settings/05-departments/_index.adoc[部门]。
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
// :ks_include_id: 05d7ebe027f04cc589e8baa04343e651
|
||||
您需要加入一个企业空间并在企业空间中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:08-workspace-management/05-workspace-settings/03-workspace-members/_index.adoc[企业空间成员]和xref:08-workspace-management/05-workspace-settings/04-workspace-roles/_index.adoc[企业空间角色]。
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 05d7ebe027f04cc589e8baa04343e651
|
||||
您需要加入一个企业空间并在企业空间中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:08-workspace-management/06-workspace-settings/03-workspace-members/_index.adoc[企业空间成员]和xref:08-workspace-management/06-workspace-settings/04-workspace-roles/_index.adoc[企业空间角色]。
|
||||
您需要加入一个企业空间并在企业空间中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅“企业空间成员”和“企业空间角色”。
|
||||
|
|
|
|||
|
|
@ -1,10 +1,11 @@
|
|||
---
|
||||
title: "KubeSphere LuBan"
|
||||
linkTitle: "KubeSphere LuBan"
|
||||
description: "介绍 KubeSphere LuBan 的背景和优势。"
|
||||
weight: 01
|
||||
---
|
||||
|
||||
{ks_product_right}（KubeSphere Enterprise），是基于 Kubernetes 内核的分布式多租户商用云原生操作系统。在开源能力的基础上，在多云集群管理、微服务治理、应用管理等多个核心业务场景进行功能延伸。商用扩展中心实现高度模块化，满足不同场景业务需求。以强大的企业级云原生底座，完善的专家级解决方案和服务支持，赋能企业数字化转型和规模化运营。
|
||||
{ks_product_right}，是基于 Kubernetes 内核的分布式多租户商用云原生操作系统。在开源能力的基础上，在多云集群管理、微服务治理、应用管理等多个核心业务场景进行功能延伸。商用扩展中心实现高度模块化，满足不同场景业务需求。以强大的企业级云原生底座，完善的专家级解决方案和服务支持，赋能企业数字化转型和规模化运营。
|
||||
|
||||
自{ks_product_left} v4.0 起，引入扩展机制，推出了全新的 KubeSphere 架构：**KubeSphere LuBan**，它构建在 link:https://kubernetes.io/zh-cn/docs/concepts/extend-kubernetes/[Kubernetes] 之上，支持高度可配置和可扩展。KubeSphere LuBan，是一个分布式的云原生可扩展开放架构，为扩展组件提供一个可热插拔的微内核。自此，KubeSphere 所有功能组件及第三方组件都会基于 KubeSphere LuBan，以扩展组件的方式无缝融入到 KubeSphere 控制台中，并独立维护版本，真正实现即插即用的应用级云原生操作系统。
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
title: "KubeSphere LuBan 架构"
|
||||
linkTitle: "KubeSphere LuBan 架构"
|
||||
description: "介绍 KubeSphere LuBan 架构及扩展组件。"
|
||||
weight: 02
|
||||
---
|
||||
|
||||
|
|
@ -32,11 +33,11 @@ KubeSphere 扩展组件是一个可以对 KubeSphere 功能进行扩展并借助
|
|||
. 覆盖 KubeSphere 已有的页面路由，实现您独有的业务逻辑。
|
||||
. 对 KubeSphere 的 API 进行扩展。
|
||||
|
||||
如果您想更全面地了解扩展 API，请参阅link:https://dev-guide.kubesphere.io/extension-dev-guide/zh/feature-customization/[功能定制]。
|
||||
如果您想更全面地了解扩展 API，请参阅link:https://dev-guide.kubesphere.io/extension-dev-guide/zh/feature-customization/[扩展能力]。
|
||||
|
||||
== 如何构建扩展组件？
|
||||
|
||||
请参阅link:https://dev-guide.kubesphere.io/extension-dev-guide/zh/development-procedure/[开发流程]章节来熟悉如何构建扩展组件。
|
||||
请参阅link:https://dev-guide.kubesphere.io/extension-dev-guide/zh/best-practice/develop-example/[开发案例]章节来熟悉如何构建扩展组件。
|
||||
|
||||
如果您在扩展组件的开发过程中有疑问，请尝试在 link:https://github.com/kubesphere/kubesphere/issues/new/choose[GitHub Issue] 获得帮助。
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
title: "应用场景"
|
||||
linkTitle: "应用场景"
|
||||
description: "介绍 KubeSphere 的应用场景。"
|
||||
weight: 03
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -9,34 +9,3 @@ icon: "/images/docs/common/docs.svg"
|
|||
---
|
||||
|
||||
本节介绍{ks_product_both}的产品优势，架构以及应用场景。
|
||||
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
|
||||
== 产品版本
|
||||
|
||||
本文档适用于{ks_product_left} v4.1.0 版本。
|
||||
|
||||
== 读者对象
|
||||
|
||||
本文档主要适用于以下读者：
|
||||
|
||||
* {ks_product_right}用户
|
||||
|
||||
* 交付工程师
|
||||
|
||||
* 运维工程师
|
||||
|
||||
* 售后工程师
|
||||
|
||||
|
||||
== 修订记录
|
||||
|
||||
[%header,cols="1a,1a,3a"]
|
||||
|===
|
||||
|文档版本 |发布日期 |修改说明
|
||||
|
||||
|01
|
||||
|{pdf_releaseDate}
|
||||
|第一次正式发布。
|
||||
|===
|
||||
endif::[]
|
||||
|
|
|
|||
|
|
@ -1,650 +0,0 @@
|
|||
---
|
||||
title: "安装 KubeSphere 企业版"
|
||||
linkTitle: "安装 KubeSphere 企业版"
|
||||
keywords: "Kubernetes, KubeSphere, 快速入门, 安装, KubeSphere Core"
|
||||
description: "介绍如何安装 KubeSphere。"
|
||||
weight: 01
|
||||
---
|
||||
|
||||
// 以下内容与“安装 Kubernetes 和 KubeSphere 企业版”的内容完全一样，不同点：层级提升一层导致 include 链接有变化；修改 link 链接为 pdf 文档名称。
|
||||
|
||||
本节介绍如何安装 Kubernetes 和{ks_product_left}。
|
||||
|
||||
安装过程中将用到开源工具 KubeKey。有关 KubeKey 的更多信息，请访问 link:https://github.com/kubesphere/kubekey[GitHub KubeKey 仓库]。
|
||||
|
||||
|
||||
== 前提条件
|
||||
|
||||
* 您需要联系{ks_product_both}的服务支持团队获取{ks_product_left} v4.1.0 安装包。
|
||||
|
||||
// 如实施现场条件允许在线拉取公开仓库，具备在线安装条件，可联系 KubeSphere 产品团队获取在线安装文件及相关信息。
|
||||
|
||||
* 您需要准备至少 1 台 Linux 服务器作为集群节点。在生产环境中，为确保集群具备高可用性，建议准备至少 5 台 Linux 服务器，其中 3 台作为控制平面节点，另外 2 台作为工作节点。如果您在多台 Linux 服务器上安装{ks_product_left}，请确保所有服务器属于同一子网。
|
||||
|
||||
* 集群节点的操作系统和版本须为 Ubuntu 16.04、Ubuntu 18.04、Ubuntu 20.04、Ubuntu 22.04、Debian 9、Debian 10、CentOS 7、CentOS Stream、RHEL 7、RHEL 8、SLES 15 或 openSUSE Leap 15。多台服务器的操作系统可以不同。关于其它操作系统和版本支持，请联系{ks_product_both}技术支持。
|
||||
|
||||
* 在生产环境中，为确保集群具有足够的计算和存储资源，建议每台集群节点配置至少 8 个 CPU 核心、16 GB 内存和 200 GB 磁盘空间。除此之外，建议在每台集群节点的 **/var/lib/docker**（对于 Docker）或 **/var/lib/containerd**（对于 containerd） 目录额外挂载至少 200 GB 磁盘空间用于存储容器运行时数据。
|
||||
|
||||
* 除集群节点外，您还需要准备一台 Linux 服务器用于创建私有镜像服务，该服务器必须与{ks_product_both}集群节点网络连通，并且在 **/mnt/registry** 目录挂载至少 100 GB 磁盘空间。
|
||||
|
||||
* 在生产环境中，建议提前为{ks_product_both}集群配置高可用性以避免单个控制平面节点出现故障时集群服务中断。有关更多信息，请参阅《{ks_product_right}安装指南》的“配置高可用性”章节。
|
||||
+
|
||||
--
|
||||
// Note
|
||||
include::../../../_ks_components/admonitions/note.adoc[]
|
||||
|
||||
如果您规划了多个控制平面节点，请务必提前为集群配置高可用性。
|
||||
|
||||
include::../../../_ks_components/admonitions/admonEnd.adoc[]
|
||||
--
|
||||
|
||||
* 默认情况下，{ks_product_right}使用集群节点的本地磁盘空间作为持久化存储。在生产环境中，建议提前配置外部存储系统作为持久化存储。有关更多信息，请参阅《{ks_product_right}安装指南》的“配置外部持久化存储”章节。
|
||||
|
||||
* 如果集群节点未安装容器运行时，安装工具 KubeKey 将在安装过程中自动为每个集群节点安装 Docker 作为容器运行时。您也可以提前手动安装 containerd、CRI-O 或 iSula 作为容器运行时。
|
||||
+
|
||||
--
|
||||
// Note
|
||||
include::../../../_ks_components/admonitions/note.adoc[]
|
||||
|
||||
CRI-O 和 iSula 与{ks_product_both}的兼容性尚未经过充分测试，可能存在未知问题。
|
||||
|
||||
include::../../../_ks_components/admonitions/admonEnd.adoc[]
|
||||
--
|
||||
|
||||
* 请确保所有集群节点上 **/etc/resolv.conf** 文件中配置的 DNS 服务器地址可用。否则，{ks_product_right}集群可能会出现域名解析问题。
|
||||
|
||||
* 请确保在所有集群节点上都可以使用 **sudo**、**curl** 和 **openssl** 命令。
|
||||
|
||||
* 请确保所有集群节点时间同步。
|
||||
|
||||
|
||||
== 配置防火墙规则
|
||||
|
||||
{ks_product_right}需要特定端口和协议用于服务之间的通信。如果您的基础设施环境已启用防火墙，您需要在防火墙设置中放行所需的端口和协议。如果您的基础设施环境未启用防火墙，您可以跳过此步骤。
|
||||
|
||||
下表列出需要在防火墙中放行的端口和协议。
|
||||
|
||||
[%header,cols="1a,1a,1a,1a,2a"]
|
||||
|===
|
||||
|服务 |协议 |起始端口 |结束端口 |备注
|
||||
|
||||
|ssh
|
||||
|TCP
|
||||
|22
|
||||
|
|
||||
|
|
||||
|
||||
|etcd
|
||||
|TCP
|
||||
|2379
|
||||
|2380
|
||||
|
|
||||
|
||||
|apiserver
|
||||
|TCP
|
||||
|6443
|
||||
|
|
||||
|
|
||||
|
||||
|calico
|
||||
|TCP
|
||||
|9099
|
||||
|9100
|
||||
|
|
||||
|
||||
|bgp
|
||||
|TCP
|
||||
|179
|
||||
|
|
||||
|
|
||||
|
||||
|nodeport
|
||||
|TCP
|
||||
|30000
|
||||
|32767
|
||||
|
|
||||
|
||||
|master
|
||||
|TCP
|
||||
|10250
|
||||
|10258
|
||||
|
|
||||
|
||||
|dns
|
||||
|TCP
|
||||
|53
|
||||
|
|
||||
|
|
||||
|
||||
|dns
|
||||
|UDP
|
||||
|53
|
||||
|
|
||||
|
|
||||
|
||||
|metrics-server
|
||||
|TCP
|
||||
|8443
|
||||
|
|
||||
|
|
||||
|
||||
|local-registry
|
||||
|TCP
|
||||
|5000
|
||||
|
|
||||
|离线环境需要
|
||||
|
||||
|local-apt
|
||||
|TCP
|
||||
|5080
|
||||
|
|
||||
|离线环境需要
|
||||
|
||||
|rpcbind
|
||||
|TCP
|
||||
|111
|
||||
|
|
||||
|使用 NFS 作为持久化存储时需要
|
||||
|
||||
|ipip
|
||||
|IPENCAP/IPIP
|
||||
|
|
||||
|
|
||||
|使用 Calico 时需要
|
||||
|===
|
||||
|
||||
== 安装依赖项
|
||||
|
||||
您需要为所有集群节点安装 socat、conntrack、ebtables 和 ipset。如果上述依赖项在各集群节点上已存在，您可以跳过此步骤。
|
||||
|
||||
在 Ubuntu 操作系统上，执行以下命令为服务器安装依赖项：
|
||||
|
||||
// Bash
|
||||
include::../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
sudo apt install socat conntrack ebtables ipset -y
|
||||
|
||||
----
|
||||
|
||||
如果集群节点使用其他操作系统，请将 **apt** 替换为操作系统对应的软件包管理工具。
|
||||
|
||||
== 查看安装包内容
|
||||
|
||||
了解{ks_product_left} v4.1.0 的安装包内容，以便进行后续步骤。
|
||||
|
||||
安装包包含以下文件：
|
||||
|
||||
[,bash]
|
||||
----
|
||||
kse-all-v4.1.0-offline-linux-amd64/
|
||||
├── charts
|
||||
│ ├── ks-core # KubeSphere 企业版核心组件
|
||||
│ ├── kse-extensions-publish # 用于发布 KubeSphere 企业版扩展组件
|
||||
│ ├── csi-qingcloud # 用于对接青云云平台存储
|
||||
│ ├── csi-neonsan # 用于对接 NeonSan 存储
|
||||
│ └── nfs-client-provisioner # 用于对接 NFS 存储
|
||||
├── tools
|
||||
│ ├── pre-check.sh # 用于 KubeSphere 企业版升级前的集群环境检查
|
||||
│ ├── backup.sh # 用于 KubeSphere 企业版升级前备份系统企业空间中的关键资源
|
||||
│ └── upgrade.sh # KubeSphere 企业版升级脚本，提供快速升级能力
|
||||
│ ├── oras # OCI 工具，便于镜像同步等操作
|
||||
│ └── ks-core-values.yaml # 升级配置示例文件，用于配置各组件的升级参数
|
||||
├── kse-extensions # 其中包含所有扩展组件的 installplan，可用于快速安装 KubeSphere 企业版扩展组件
|
||||
├── config-sample.yaml # 安装配置文件的模版
|
||||
├── create_project_harbor.sh # 用于快速创建 harbor 项目
|
||||
├── kk # 集群部署工具
|
||||
├── kubekey-artifact.tar.gz # KubeSphere 企业版制品，其中包含集群部署所需的二进制文件及镜像
|
||||
└── manifest-v410-amd64.yaml # KubeSphere 企业版制品清单，其中包含各组件的版本以及镜像列表
|
||||
----
|
||||
|
||||
|
||||
|
||||
== 配置安装配置文件
|
||||
|
||||
**config-sample.yaml** 是{ks_product_both}的安装配置文件，请先配置该文件，以便进行后续步骤。
|
||||
|
||||
include::../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[]
|
||||
+
|
||||
|
||||
. 执行以下命令编辑安装配置文件 **config-sample.yaml**：
|
||||
+
|
||||
--
|
||||
// Bash
|
||||
include::../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
vi config-sample.yaml
|
||||
|
||||
----
|
||||
|
||||
以下为部分示例配置文件，如需了解完整示例，请参阅link:https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md[此文件]。
|
||||
|
||||
// YAML
|
||||
include::../../../_ks_components/code/yaml.adoc[]
|
||||
|
||||
apiVersion: kubekey.kubesphere.io/v1alpha2
|
||||
kind: Cluster
|
||||
metadata:
|
||||
name: sample
|
||||
spec:
|
||||
hosts:
|
||||
- {name: controlplane1, address: 192.168.0.2, internalAddress: 192.168.0.2, port: 23, user: ubuntu, password: Testing123, arch: arm64} # arm64 节点注意添加参数 arch: arm64
|
||||
- {name: controlplane2, address: 192.168.0.3, internalAddress: 192.168.0.3, user: ubuntu, privateKeyPath: "~/.ssh/id_rsa"}
|
||||
- {name: worker1, address: 192.168.0.4, internalAddress: 192.168.0.4, user: ubuntu, password: Testing123}
|
||||
- {name: worker2, address: 192.168.0.5, internalAddress: 192.168.0.5, user: ubuntu, password: Testing123}
|
||||
- {name: registry, address: 192.168.0.6, internalAddress: 192.168.0.6, user: ubuntu, password: Testing123}
|
||||
roleGroups:
|
||||
etcd:
|
||||
- controlplane1
|
||||
- controlplane2
|
||||
control-plane:
|
||||
- controlplane1
|
||||
- controlplane2
|
||||
worker:
|
||||
- worker1
|
||||
- worker2
|
||||
# 如需使用 kk 自动部署镜像仓库，请设置 registry（建议镜像仓库与集群节点分离部署，减少相互影响）
|
||||
registry:
|
||||
- registry
|
||||
controlPlaneEndpoint:
|
||||
internalLoadbalancer: haproxy # 如需部署⾼可⽤集群，且⽆负载均衡器可⽤，可开启该参数，做集群内部负载均衡
|
||||
domain: lb.kubesphere.local
|
||||
address: ""
|
||||
port: 6443
|
||||
kubernetes:
|
||||
version: v1.23.15
|
||||
clusterName: cluster.local
|
||||
network:
|
||||
plugin: calico
|
||||
kubePodsCIDR: 10.233.64.0/18
|
||||
kubeServiceCIDR: 10.233.0.0/18
|
||||
## multus support. https://github.com/k8snetworkplumbingwg/multus-cni
|
||||
enableMultusCNI: false
|
||||
registry:
|
||||
# 如需使用 kk 部署 harbor，可将该参数设置为 harbor，不设置该参数且需使用 kk 部署容器镜像仓库，将默认部署 docker registry。
|
||||
# harbor 不支持 arm64，arm64 环境部署时，可不配置该参数。
|
||||
type: harbor
|
||||
# 如使用 kk 部署的 harbor 或其他需要登录的仓库，需设置对应仓库的 auths，如使用 kk 部署默认的 docker registry 仓库，则无需配置 auths 参数。
|
||||
# 注意：如使用 kk 部署 harbor，auths 参数请于创建 harbor 项目之后设置。
|
||||
auths:
|
||||
"dockerhub.kubekey.local":
|
||||
username: admin # harbor 默认用户名
|
||||
password: Harbor12345 # harbor 默认密码
|
||||
plainHTTP: false # 如果仓库使用 http，请将该参数设置为true
|
||||
privateRegistry: "dockerhub.kubekey.local/kse" # 设置集群部署时使用的私有仓库地址
|
||||
registryMirrors: []
|
||||
insecureRegistries: []
|
||||
addons: []
|
||||
|
||||
----
|
||||
--
|
||||
|
||||
. 在 **config-sample.yaml** 配置文件的 **spec:hosts** 参数下设置各服务器的信息。
|
||||
+
|
||||
--
|
||||
include::../../_custom/installationAndUpgrade/installationAndUpgrade-para-hosts.adoc[]
|
||||
|
||||
--
|
||||
|
||||
. 在 **config-sample.yaml** 配置文件的 **spec:roleGroups** 参数下设置服务器的角色：
|
||||
+
|
||||
--
|
||||
include::../../_custom/installationAndUpgrade/installationAndUpgrade-para-roleGroups.adoc[]
|
||||
--
|
||||
|
||||
. 如果您规划了多个控制平面节点，在 **config-sample.yaml** 配置文件的 **spec:controlPlaneEndpoint** 参数下设置高可用性信息。
|
||||
+
|
||||
--
|
||||
include::../../_custom/installationAndUpgrade/installationAndUpgrade-para-controlPlaneEndpoint.adoc[]
|
||||
--
|
||||
|
||||
. 如果您需要使用外部持久化存储，在 **config-sample.yaml** 配置文件的 **spec:addons** 参数下设置外部持久化存储信息。
|
||||
+
|
||||
====
|
||||
* 如果使用云上存储设备，在 **spec:addons** 下设置以下参数（将 <configuration file path> 替换为存储插件配置文件的实际路径）：
|
||||
+
|
||||
--
|
||||
// Bash
|
||||
include::../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
- name: csi-qingcloud
|
||||
namespace: kube-system
|
||||
sources:
|
||||
chart:
|
||||
name: csi-qingcloud
|
||||
path: charts/csi-qingcloud
|
||||
valuesFile: <configuration file path>
|
||||
----
|
||||
--
|
||||
|
||||
* 如果使用 NeonSAN 存储设备，在 **spec:addons** 下设置以下参数（将 <configuration file path> 替换为存储插件配置文件的实际路径）：
|
||||
+
|
||||
--
|
||||
// Bash
|
||||
include::../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
- name: csi-neonsan
|
||||
namespace: kube-system
|
||||
sources:
|
||||
chart:
|
||||
name: csi-neonsan
|
||||
path: charts/csi-neonsan
|
||||
valuesFile: <configuration file path>
|
||||
|
||||
----
|
||||
--
|
||||
|
||||
* 如果使用 NFS 存储系统，在 **spec:addons** 下设置以下参数（将 <configuration file path> 替换为存储插件配置文件的实际路径）：
|
||||
+
|
||||
--
|
||||
// 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: <configuration file path>
|
||||
|
||||
----
|
||||
--
|
||||
====
|
||||
|
||||
== 创建私有镜像仓库
|
||||
|
||||
[.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** 参数下设置用于创建私有镜像服务的服务器名称（将 <registry name> 替换为 **spec:hosts** 参数下设置的服务器实际名称）。
|
||||
+
|
||||
[,yaml]
|
||||
----
|
||||
spec:
|
||||
roleGroups:
|
||||
registry:
|
||||
- <registry name>
|
||||
----
|
||||
|
||||
. 将 **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%]
|
||||
--
|
||||
|
|
@ -0,0 +1,110 @@
|
|||
---
|
||||
title: "在 Linux 上以 All-in-One 模式安装 KubeSphere"
|
||||
linkTitle: "在 Linux 上以 All-in-One 模式安装 KubeSphere"
|
||||
keywords: 'KubeSphere, Kubernetes, All-in-One, 安装'
|
||||
description: '了解如何在 Linux 上最小化安装 KubeSphere。'
|
||||
weight: 01
|
||||
---
|
||||
|
||||
本节介绍如何在单个节点上快速部署 Kubernetes 和{ks_product_left}。此安装方法仅适用于测试，若要在生产环境中安装{ks_product_left}，请参阅link:../../03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere]。
|
||||
|
||||
|
||||
== 前提条件
|
||||
|
||||
* 准备一台 Linux 主机，并确保其满足最低硬件要求：CPU > 2 核，内存 > 4 GB， 磁盘空间 > 40 GB。
|
||||
|
||||
* 您需要提前link:https://helm.sh/zh/docs/intro/install/[安装 Helm]。
|
||||
|
||||
|
||||
== 操作步骤
|
||||
|
||||
. （可选）如果您没有可用的 Kubernetes 集群，执行以下命令快速创建一个 Kubernetes 集群。
|
||||
|
||||
.. 如果您访问 GitHub/Googleapis 受限，请登录 Linux 主机，执行以下命令设置下载区域。
|
||||
+
|
||||
[,bash]
|
||||
----
|
||||
export KKZONE=cn
|
||||
----
|
||||
|
||||
.. 执行以下命令安装⼯具 KubeKey。
|
||||
+
|
||||
--
|
||||
下载完成后当前目录下将生成 KubeKey 二进制文件 **kk**。
|
||||
|
||||
[,bash]
|
||||
----
|
||||
curl -sfL https://get-kk.kubesphere.io | sh -
|
||||
----
|
||||
--
|
||||
|
||||
.. 执行以下命令安装依赖项。
|
||||
+
|
||||
[,bash]
|
||||
----
|
||||
apt install socat conntrack -y
|
||||
----
|
||||
|
||||
.. 执行以下命令快速创建一个 Kubernetes 集群。
|
||||
+
|
||||
[,bash]
|
||||
----
|
||||
./kk create cluster --with-local-storage --with-kubernetes v1.31.0 --container-manager containerd -y
|
||||
----
|
||||
|
||||
. 如果您已经拥有可用的 Kubernetes 集群，执行以下命令通过 `helm` 安装{ks_product_both}的核心组件 KubeSphere Core。
|
||||
+
|
||||
[,bash]
|
||||
----
|
||||
helm upgrade --install -n kubesphere-system --create-namespace ks-core https://charts.kubesphere.io/main/ks-core-1.1.0.tgz --debug --wait
|
||||
----
|
||||
|
||||
. 安装完成后，输出信息会显示{ks_product_left} Web 控制台的 IP 地址和端口号，默认的 NodePort 是 30880。
|
||||
+
|
||||
--
|
||||
[,yaml]
|
||||
----
|
||||
NOTES:
|
||||
Thank you for choosing KubeSphere Helm Chart.
|
||||
|
||||
Please be patient and wait for several seconds for the KubeSphere deployment to complete.
|
||||
|
||||
1. Wait for Deployment Completion
|
||||
|
||||
Confirm that all KubeSphere components are running by executing the following command:
|
||||
|
||||
kubectl get pods -n kubesphere-system
|
||||
|
||||
2. Access the KubeSphere Console
|
||||
|
||||
Once the deployment is complete, you can access the KubeSphere console using the following URL:
|
||||
|
||||
http://192.168.6.10:30880
|
||||
|
||||
3. Login to KubeSphere Console
|
||||
|
||||
Use the following credentials to log in:
|
||||
|
||||
Account: admin
|
||||
Password: P@88w0rd
|
||||
|
||||
NOTE: It is highly recommended to change the default password immediately after the first login.
|
||||
|
||||
For additional information and details, please visit https://kubesphere.io.
|
||||
----
|
||||
|
||||
执行以下命令检查 Pod 状态。
|
||||
|
||||
[,bash]
|
||||
----
|
||||
kubectl get pods -n kubesphere-system
|
||||
----
|
||||
|
||||
当 Pod 状态都为 **Running** 时，使用默认的账户和密码 (admin/P@88w0rd) 通过 <NodeIP>:30880 访问{ks_product_left} Web 控制台。
|
||||
|
||||
include::../../../_ks_components/admonitions/note.adoc[]
|
||||
|
||||
取决于您的网络环境，您可能需要配置流量转发规则并在防火墙中放行 30880 端口。
|
||||
|
||||
include::../../../_ks_components/admonitions/admonEnd.adoc[]
|
||||
--
|
||||
|
|
@ -1,66 +0,0 @@
|
|||
---
|
||||
title: "安装示例组件"
|
||||
linkTitle: "安装示例组件"
|
||||
keywords: "Kubernetes, KubeSphere, 快速入门, 安装组件, 示例, DevOps"
|
||||
description: "以 DevOps 安装为例，演示如何在 KubeSphere Web 控制台安装组件。"
|
||||
weight: 02
|
||||
---
|
||||
|
||||
KubeSphere 扩展组件，是运行在 KubeSphere Core 之上，用来扩展并增强 KubeSphere 产品能力，以进一步满足企业各类型的业务需求。
|
||||
|
||||
// ifeval::["{file_output_type}" == "html"]
|
||||
|
||||
// 本节以安装 DevOps 为例，演示如何在{ks_product_left} Web 控制台安装扩展组件。DevOps 安装完成后，即可在企业空间中创建 DevOps 项目。有关组件使用的更多信息，请参阅link:../../11-use-extensions/[扩展组件使用]章节。
|
||||
|
||||
// == 前提条件
|
||||
|
||||
// * 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../05-users-and-roles/01-users/[用户]和link:../../05-users-and-roles/02-platform-roles/[平台角色]。
|
||||
|
||||
// * 您需要注册一个 KubeSphere 云账号。
|
||||
|
||||
// == 订阅步骤
|
||||
|
||||
// . 点击{ks_product_left} Web 控制台左上角的**扩展市场**，进入扩展市场页面。
|
||||
// . 搜索查找 DevOps，点击**订阅**。
|
||||
// . 如果您未绑定 https://kubesphere.cloud/login/[KubeSphere 云账号]，前往**扩展中心**绑定您的 KubeSphere 云账户，然后进入订阅流程。
|
||||
// . 订阅完成后，进入组件安装流程。
|
||||
// endif::[]
|
||||
|
||||
|
||||
// ifeval::["{file_output_type}" == "pdf"]
|
||||
|
||||
本节以安装 DevOps 为例，演示如何在{ks_product_left} Web 控制台安装扩展组件。DevOps 安装完成后，即可在企业空间中创建 DevOps 项目。有关组件使用的更多信息，请参阅《{ks_product_right}扩展组件使用指南》。
|
||||
|
||||
== 前提条件
|
||||
|
||||
* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅《{ks_product_right}用户和角色管理指南》。
|
||||
|
||||
// endif::[]
|
||||
|
||||
== 安装步骤
|
||||
|
||||
. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。
|
||||
. 点击**扩展中心**，查看扩展组件列表。
|
||||
. 点击 DevOps 右侧的**安装**按钮，进入组件安装页面。
|
||||
. 在组件安装对话框的**版本选择**页签，选择 DevOps 的版本号，并安装好所有必装组件（若有），点击**下一步**。
|
||||
+
|
||||
include::../../../_ks_components/admonitions/note.adoc[]
|
||||
|
||||
安装检测时，会识别扩展组件是否有依赖组件。依赖组件分为必装组件和选装组件。
|
||||
|
||||
若必装组件的状态为**未就绪**，您需要先行安装正确版本的必装组件，以确保扩展组件的正常使用。而选装组件不会影响扩展组件的安装。
|
||||
|
||||
include::../../../_ks_components/admonitions/admonEnd.adoc[]
|
||||
|
||||
|
||||
. 在**扩展组件安装**页签，修改 DevOps 的配置后（可选），点击**开始安装**即开始安装 DevOps。
|
||||
+
|
||||
image:/images/ks-qkcp/zh/v4.0/install-extensions.png[,100%]
|
||||
|
||||
. 在**集群选择**页签，根据名称，标识，标签选择集群，可选择多个集群。
|
||||
|
||||
. 在**差异化配置**页签，分别编辑选中集群的 YAML 配置，也可不修改，使用初始默认配置。点击**确定**，开始配置集群 Agent。
|
||||
|
||||
安装完成后，默认启用该组件。您可以在扩展中心配置、升级、禁用、卸载扩展组件。
|
||||
|
||||
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: "控制用户权限"
|
||||
linkTitle: "控制用户权限"
|
||||
linkTitle: "创建企业空间、项目、用户和平台角色"
|
||||
keywords: "Kubernetes, KubeSphere, 快速入门, 用户, 权限"
|
||||
description: "介绍如何创建用户，并使用企业空间、项目和角色控制用户的访问权限。"
|
||||
weight: 03
|
||||
|
|
|
|||
|
|
@ -2,42 +2,12 @@
|
|||
title: "快速入门"
|
||||
linkTitle: "快速入门"
|
||||
keywords: "Kubernetes, KubeSphere, 快速入门"
|
||||
description: "介绍如何安装 KubeSphere和扩展组件，以及如何进行访问控制。"
|
||||
description: "介绍如何安装 KubeSphere，以及如何进行访问控制。"
|
||||
layout: "second"
|
||||
weight: 02
|
||||
icon: "/images/docs/common/docs.svg"
|
||||
---
|
||||
|
||||
本节简要介绍如何安装{ks_product_both}和扩展组件，以及如何控制用户权限，帮助您快速了解使用{ks_product_left}。
|
||||
本节简要介绍如何安装{ks_product_left}，以及如何控制用户权限，帮助您快速了解使用{ks_product_left}。
|
||||
|
||||
有关{ks_product_both}安装和使用的更多信息，请参阅文档的其他章节。
|
||||
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
== 产品版本
|
||||
|
||||
本文档适用于{ks_product_left} v4.1.0 版本。
|
||||
|
||||
== 读者对象
|
||||
|
||||
本文档主要适用于以下读者：
|
||||
|
||||
* {ks_product_right}用户
|
||||
|
||||
* 交付工程师
|
||||
|
||||
* 运维工程师
|
||||
|
||||
* 售后工程师
|
||||
|
||||
|
||||
== 修订记录
|
||||
|
||||
[%header,cols="1a,1a,3a"]
|
||||
|===
|
||||
|文档版本 |发布日期 |修改说明
|
||||
|
||||
|01
|
||||
|{pdf_releaseDate}
|
||||
|第一次正式发布。
|
||||
|===
|
||||
endif::[]
|
||||
|
|
|
|||
|
|
@ -198,219 +198,145 @@ weight: 01
|
|||
|N/A
|
||||
|===
|
||||
|
||||
== 组件支持矩阵
|
||||
// == 组件支持矩阵
|
||||
|
||||
{ks_product_right} v4.1.0 默认支持 Kubernetes v1.21~1.28。本节详细介绍{ks_product_both}各组件支持的 Kubernetes 版本。为避免使用过程中出现兼容性问题，请使用支持的 Kubernetes 版本。
|
||||
// {ks_product_right} v4.1 默认支持 Kubernetes v1.21~1.28。本节详细介绍{ks_product_both}各组件支持的 Kubernetes 版本。为避免使用过程中出现兼容性问题，请使用支持的 Kubernetes 版本。
|
||||
|
||||
[%header,cols="2a,3a,5a"]
|
||||
|===
|
||||
|组件 |组件版本 |支持的 Kubernetes 版本
|
||||
// [%header,cols="2a,2a,3a,2a"]
|
||||
// |===
|
||||
// |组件 |组件版本 |支持的 Kubernetes 版本 |支持的架构
|
||||
|
||||
|ks-core
|
||||
|4.1.x
|
||||
|1.21~1.28
|
||||
// |ks-core
|
||||
// |4.1.x
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
|DevOps
|
||||
|4.1.0
|
||||
|1.21~1.28
|
||||
// |DevOps
|
||||
// |1.1.0
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
|Storage-utils
|
||||
|1.0.x
|
||||
|1.21~1.28
|
||||
// |Storage-utils
|
||||
// |1.0.x
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
|Vector
|
||||
|1.0.0
|
||||
|1.21~1.28
|
||||
// |Vector
|
||||
// |1.0.x
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
|OpenSearch
|
||||
|2.11.1
|
||||
|1.21~1.28
|
||||
// |OpenSearch
|
||||
// |2.11.1
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
|Monitoring
|
||||
|1.0.0
|
||||
|1.21~1.28
|
||||
// |Monitoring
|
||||
// |1.0.x
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
|Logging
|
||||
|1.0.0
|
||||
|1.21~1.28
|
||||
// |Logging
|
||||
// |1.0.x
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
|Auditing
|
||||
|1.0.0
|
||||
|1.21~1.28
|
||||
// |Auditing
|
||||
// |1.0.x
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
|Events
|
||||
|1.0.0
|
||||
|1.21~1.28
|
||||
// |Events
|
||||
// |1.0.x
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
|Alerting
|
||||
|1.0.0
|
||||
|1.21~1.28
|
||||
// |Alerting
|
||||
// |1.0.x
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
|WhizardTelemetry 平台服务
|
||||
|1.0.0
|
||||
|1.21~1.28
|
||||
// |WhizardTelemetry 平台服务
|
||||
// |1.0.x
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
|WhizardTelemetry 事件告警
|
||||
|1.0.0
|
||||
|1.21~1.28
|
||||
// |WhizardTelemetry 事件告警
|
||||
// |1.0.x
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
|Notification
|
||||
|2.5.1
|
||||
|1.21~1.28
|
||||
// |Notification
|
||||
// |2.5.x
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
|MetricServer
|
||||
|0.7.0
|
||||
|1.21~1.28
|
||||
// |MetricServer
|
||||
// |0.7.0
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
|Tower
|
||||
|1.0.x
|
||||
|1.21~1.28
|
||||
// |Tower
|
||||
// |1.0.x
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
|OpenPitrix
|
||||
|2.0.0
|
||||
|1.21~1.28
|
||||
// |OpenPitrix
|
||||
// |2.0.0
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
|KubeFed
|
||||
|1.0.x
|
||||
|1.21~1.28
|
||||
// |KubeFed
|
||||
// |1.0.x
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
|Gateway
|
||||
|1.0.x
|
||||
|1.22~1.25
|
||||
// |Gateway
|
||||
// |1.0.x
|
||||
// |1.22~1.25
|
||||
// |amd64、arm64
|
||||
|
||||
|ServiceMesh
|
||||
|1.0.x
|
||||
|1.22~1.25
|
||||
// |ServiceMesh
|
||||
// |1.0.x
|
||||
// |1.22~1.25
|
||||
// |amd64、arm64
|
||||
|
||||
|KubeEdge
|
||||
|1.31.1
|
||||
|1.21-1.23
|
||||
// |KubeEdge
|
||||
// |1.13.1
|
||||
// |1.21-1.23
|
||||
// |amd64、arm64
|
||||
|
||||
|RadonDB DMP
|
||||
|2.1.0
|
||||
|
|
||||
* DMP 管理平台: 1.21~1.28
|
||||
* MySQL: 1.21~1.28
|
||||
* PostgreSQL: 1.21~1.28
|
||||
* Redis Cluster: 1.21~1.28
|
||||
* Redis Sentinel: 1.21~1.28
|
||||
* MongoDB: 1.21~1.28
|
||||
* OpenSearch: 1.21~1.28
|
||||
* Kafka: 1.21~1.28
|
||||
* RabbitMQ: 1.21~1.28
|
||||
// |RadonDB DMP
|
||||
// |2.1.3
|
||||
// |
|
||||
// * DMP 管理平台: 1.21~1.28
|
||||
// * MySQL: 1.21~1.28
|
||||
// * PostgreSQL: 1.21~1.28
|
||||
// * Redis Cluster: 1.21~1.28
|
||||
// * Redis Sentinel: 1.21~1.28
|
||||
// * MongoDB: 1.21~1.28
|
||||
// * OpenSearch: 1.21~1.28
|
||||
// * Kafka: 1.21~1.28
|
||||
// * RabbitMQ: 1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
|SpringCloud
|
||||
|1.0.x
|
||||
|1.21~1.28
|
||||
// |SpringCloud
|
||||
// |1.0.x
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
|Gatekeeper
|
||||
|1.0.x
|
||||
|1.21~1.28
|
||||
// |Gatekeeper
|
||||
// |1.0.x
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
|Network
|
||||
|1.0.0
|
||||
|1.21~1.28
|
||||
|===
|
||||
// |Network
|
||||
// |1.0.x
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
|
||||
== 组件架构支持矩阵
|
||||
|
||||
[%header,cols="2a,3a,5a"]
|
||||
|===
|
||||
|组件 |组件版本 |支持的架构
|
||||
|
||||
|ks-core
|
||||
|4.1.x
|
||||
|amd64、arm64
|
||||
|
||||
|DevOps
|
||||
|4.1.0
|
||||
|amd64、arm64
|
||||
|
||||
|Storage-utils
|
||||
|1.0.x
|
||||
|amd64、arm64
|
||||
|
||||
|Vector
|
||||
|1.0.0
|
||||
|amd64、arm64
|
||||
|
||||
|OpenSearch
|
||||
|2.11.1
|
||||
|amd64、arm64
|
||||
|
||||
|Monitoring
|
||||
|1.0.0
|
||||
|amd64、arm64
|
||||
|
||||
|Logging
|
||||
|1.0.0
|
||||
|amd64、arm64
|
||||
|
||||
|Auditing
|
||||
|1.0.0
|
||||
|amd64、arm64
|
||||
|
||||
|Events
|
||||
|1.0.0
|
||||
|amd64、arm64
|
||||
|
||||
|Alerting
|
||||
|1.0.0
|
||||
|amd64、arm64
|
||||
|
||||
|WhizardTelemetry 平台服务
|
||||
|1.0.0
|
||||
|amd64、arm64
|
||||
|
||||
|WhizardTelemetry 事件告警
|
||||
|1.0.0
|
||||
|amd64、arm64
|
||||
|
||||
|Notification
|
||||
|2.5.1
|
||||
|amd64、arm64
|
||||
|
||||
|MetricServer
|
||||
|0.7.0
|
||||
|amd64、arm64
|
||||
|
||||
|Tower
|
||||
|1.0.x
|
||||
|amd64、arm64
|
||||
|
||||
|OpenPitrix
|
||||
|2.0.0
|
||||
|amd64、arm64
|
||||
|
||||
|KubeFed
|
||||
|1.0.x
|
||||
|amd64、arm64
|
||||
|
||||
|Gateway
|
||||
|1.0.x
|
||||
|amd64、arm64
|
||||
|
||||
|ServiceMesh
|
||||
|1.0.x
|
||||
|amd64、arm64
|
||||
|
||||
|KubeEdge
|
||||
|1.31.1
|
||||
|amd64、arm64
|
||||
|
||||
|RadonDB DMP
|
||||
|2.1.0
|
||||
|amd64
|
||||
|
||||
|SpringCloud
|
||||
|1.0.x
|
||||
|amd64、arm64
|
||||
|
||||
|Gatekeeper
|
||||
|1.0.x
|
||||
|amd64、arm64
|
||||
|
||||
|Network
|
||||
|1.0.0
|
||||
|amd64、arm64
|
||||
|===
|
||||
// |Ingress-utils
|
||||
// |1.0.x
|
||||
// |1.21~1.28
|
||||
// |amd64、arm64
|
||||
// |===
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ spec:
|
|||
|
||||
----
|
||||
|
||||
KubeKey 将自动在工作节点上安装 HAProxy 并完成高可用配置，您无需进行其他操作。有关更多信息请参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere 企业版]。
|
||||
KubeKey 将自动在工作节点上安装 HAProxy 并完成高可用配置，您无需进行其他操作。有关更多信息请参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere]。
|
||||
|
||||
== 使用专用负载均衡器
|
||||
如需使用云环境提供的专用负载均衡器实现高可用性，您需要在云环境中进行以下操作：
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ NeonSAN 是青云的一款企业级分布式块存储系统，NeonSAN CSI 是 Ne
|
|||
|
||||
== 前提条件
|
||||
|
||||
- 您已经成功部署 NeonSAN v2.2.0 及以上版本，且容器集群的每个节点都已安装 QBD 与 NeonSAN 连通。具体操作请咨询 KubeSphere 企业版技术支持人员。
|
||||
- 您已经成功部署 NeonSAN v2.2.0 及以上版本，且容器集群的每个节点都已安装 QBD 与 NeonSAN 连通。具体操作请咨询 KubeSphere 技术支持人员。
|
||||
- 您已经安装 Kubernetes v1.16 及其以上版本。
|
||||
- 您已经在容器集群的 master 节点安装了 Helm。本节以 Helm 3 为例。
|
||||
|
||||
|
|
@ -328,5 +328,5 @@ $ docker images
|
|||
. 参考link:#_在线安装_neonsan_csi[在线安装]中步骤 8 - 12 执行安装后检查。
|
||||
+
|
||||
--
|
||||
NeonSAN CSI 安装成功后，您可以在 KubeSphere 企业版控制台上的**存储**区域查看。
|
||||
NeonSAN CSI 安装成功后，您可以在 KubeSphere 控制台上的**存储**区域查看。
|
||||
--
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
title: "安装 Kubernetes 和 KubeSphere"
|
||||
linkTitle: "安装 Kubernetes 和 KubeSphere"
|
||||
keywords: "Kubernetes, KubeSphere, 安装, 安装 KubeSphere, 安装 Kubernetes"
|
||||
description: "介绍如何安装 Kubernetes 和 KubeSphere。"
|
||||
keywords: "Kubernetes, {ks_product}, 安装, 安装{ks_product_left}, 安装 Kubernetes"
|
||||
description: "介绍如何在生产环境中安装 Kubernetes 和{ks_product_left}。"
|
||||
weight: 02
|
||||
---
|
||||
|
||||
|
|
@ -14,17 +14,17 @@ weight: 02
|
|||
|
||||
== 前提条件
|
||||
|
||||
* 您需要联系{ks_product_both}的服务支持团队获取{ks_product_left} v4.1.0 安装包。
|
||||
|
||||
// 如实施现场条件允许在线拉取公开仓库，具备在线安装条件，可联系 KubeSphere 产品团队获取在线安装文件及相关信息。
|
||||
|
||||
* 您需要准备至少 1 台 Linux 服务器作为集群节点。在生产环境中，为确保集群具备高可用性，建议准备至少 5 台 Linux 服务器，其中 3 台作为控制平面节点，另外 2 台作为工作节点。如果您在多台 Linux 服务器上安装{ks_product_left}，请确保所有服务器属于同一子网。
|
||||
|
||||
* 集群节点的操作系统和版本须为 Ubuntu 16.04、Ubuntu 18.04、Ubuntu 20.04、Ubuntu 22.04、Debian 9、Debian 10、CentOS 7、CentOS Stream、RHEL 7、RHEL 8、SLES 15 或 openSUSE Leap 15。多台服务器的操作系统可以不同。关于其它操作系统和版本支持，请联系{ks_product_both}技术支持。
|
||||
|
||||
* 在生产环境中，为确保集群具有足够的计算和存储资源，建议每台集群节点配置至少 8 个 CPU 核心、16 GB 内存和 200 GB 磁盘空间。除此之外，建议在每台集群节点的 **/var/lib/docker**（对于 Docker）或 **/var/lib/containerd**（对于 containerd） 目录额外挂载至少 200 GB 磁盘空间用于存储容器运行时数据。
|
||||
|
||||
* 除集群节点外，您还需要准备一台 Linux 服务器用于创建私有镜像服务，该服务器必须与{ks_product_both}集群节点网络连通，并且在 **/mnt/registry** 目录挂载至少 100 GB 磁盘空间。
|
||||
// :relfileprefix: ../../../
|
||||
|
||||
// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-prer-offlineInstallation.adoc[]
|
||||
|
||||
// :relfileprefix: ./
|
||||
|
||||
* 在生产环境中，建议提前为{ks_product_both}集群配置高可用性以避免单个控制平面节点出现故障时集群服务中断。有关更多信息，请参阅link:../../../03-installation-and-upgrade/01-preparations/03-configure-high-availability/[配置高可用性]。
|
||||
+
|
||||
|
|
@ -167,45 +167,33 @@ sudo apt install socat conntrack ebtables ipset -y
|
|||
|
||||
如果集群节点使用其他操作系统，请将 **apt** 替换为操作系统对应的软件包管理工具。
|
||||
|
||||
== 查看安装包内容
|
||||
== 创建 Kubernetes 集群
|
||||
|
||||
了解{ks_product_left} v4.1.0 的安装包内容，以便进行后续步骤。
|
||||
// ifeval::["{file_output_type}" == "pdf"]
|
||||
// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[]
|
||||
// endif::[]
|
||||
|
||||
安装包包含以下文件：
|
||||
// ifeval::["{file_output_type}" == "html"]
|
||||
include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[]
|
||||
// endif::[]
|
||||
|
||||
|
||||
. 执行以下命令创建安装配置文件 **config-sample.yaml**：
|
||||
+
|
||||
--
|
||||
// Bash
|
||||
include::../../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
./kk create config --with-kubernetes <Kubernetes version>
|
||||
|
||||
[,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 企业版制品清单，其中包含各组件的版本以及镜像列表
|
||||
----
|
||||
|
||||
将 <Kubernetes version> 替换为实际需要的版本，例如 **v1.27.4**。{ks_product_right}默认支持 Kubernetes v1.21~1.28。
|
||||
|
||||
|
||||
== 配置安装配置文件
|
||||
|
||||
**config-sample.yaml** 是{ks_product_both}的安装配置文件，请先配置该文件，以便进行后续步骤。
|
||||
命令执行完毕后将生成安装配置文件 **config-sample.yaml**。
|
||||
|
||||
include::../../../_custom/installationAndUpgrade/installationAndUpgrade-note-doNotDeleteConfig_v4.adoc[]
|
||||
|
||||
include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[]
|
||||
+
|
||||
--
|
||||
|
||||
. 执行以下命令编辑安装配置文件 **config-sample.yaml**：
|
||||
+
|
||||
|
|
@ -214,7 +202,6 @@ include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-dec
|
|||
include::../../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
vi config-sample.yaml
|
||||
|
||||
----
|
||||
|
||||
以下为部分示例配置文件，如需了解完整示例，请参阅link:https://github.com/kubesphere/kubekey/blob/master/docs/config-example.md[此文件]。
|
||||
|
|
@ -270,7 +257,7 @@ spec:
|
|||
"dockerhub.kubekey.local":
|
||||
username: admin # harbor 默认用户名
|
||||
password: Harbor12345 # harbor 默认密码
|
||||
plainHTTP: false # 如果仓库使用 http，请将该参数设置为true
|
||||
plainHTTP: false # 如果仓库使用 http，请将该参数设置为 true
|
||||
privateRegistry: "dockerhub.kubekey.local/kse" # 设置集群部署时使用的私有仓库地址
|
||||
registryMirrors: []
|
||||
insecureRegistries: []
|
||||
|
|
@ -305,14 +292,14 @@ include::../../../_custom/installationAndUpgrade/installationAndUpgrade-para-con
|
|||
+
|
||||
--
|
||||
// Bash
|
||||
include::../../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
[,bash]
|
||||
----
|
||||
- name: csi-qingcloud
|
||||
namespace: kube-system
|
||||
sources:
|
||||
chart:
|
||||
name: csi-qingcloud
|
||||
path: charts/csi-qingcloud
|
||||
repo: https://charts.kubesphere.io/test
|
||||
valuesFile: <configuration file path>
|
||||
----
|
||||
--
|
||||
|
|
@ -321,16 +308,15 @@ include::../../../../_ks_components/code/bash.adoc[]
|
|||
+
|
||||
--
|
||||
// Bash
|
||||
include::../../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
[,bash]
|
||||
----
|
||||
- name: csi-neonsan
|
||||
namespace: kube-system
|
||||
sources:
|
||||
chart:
|
||||
name: csi-neonsan
|
||||
path: charts/csi-neonsan
|
||||
repo: https://charts.kubesphere.io/test
|
||||
valuesFile: <configuration file path>
|
||||
|
||||
----
|
||||
--
|
||||
|
||||
|
|
@ -338,178 +324,56 @@ include::../../../../_ks_components/code/bash.adoc[]
|
|||
+
|
||||
--
|
||||
// Bash
|
||||
include::../../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
[,bash]
|
||||
----
|
||||
- name: nfs-client
|
||||
namespace: kube-system
|
||||
sources:
|
||||
chart:
|
||||
name: nfs-client-provisioner
|
||||
repo: charts/nfs-client-provisioner
|
||||
repo: https://charts.kubesphere.io/main
|
||||
valuesFile: <configuration file path>
|
||||
|
||||
----
|
||||
--
|
||||
====
|
||||
|
||||
== 创建私有镜像仓库
|
||||
|
||||
[.admon.attention,cols="a"]
|
||||
|===
|
||||
|注意
|
||||
|
||||
|
|
||||
如果您已有可用的镜像仓库，可跳过此步骤。但需要把私有镜像服务的默认地址 **dockerhub.kubekey.local/kse** 替换为您的实际镜像仓库地址。
|
||||
|===
|
||||
|
||||
. 在配置文件 **config-sample.yaml** 的 **spec:hosts** 参数下设置用于创建私有镜像服务的服务器的信息。
|
||||
. 执行以下命令创建 Kubernetes 集群：
|
||||
+
|
||||
--
|
||||
[,yaml]
|
||||
----
|
||||
spec:
|
||||
hosts:
|
||||
- {name: registry, address: 192.168.0.6, internalAddress: 192.168.0.6, user: ubuntu, password: Testing123}
|
||||
----
|
||||
|
||||
include::../../../_custom/installationAndUpgrade/installationAndUpgrade-para-hosts.adoc[]
|
||||
--
|
||||
|
||||
. 在 **spec:roleGroups:registry** 参数下设置用于创建私有镜像服务的服务器名称（将 <registry name> 替换为 **spec:hosts** 参数下设置的服务器实际名称）。
|
||||
+
|
||||
[,yaml]
|
||||
----
|
||||
spec:
|
||||
roleGroups:
|
||||
registry:
|
||||
- <registry name>
|
||||
----
|
||||
|
||||
. 将 **spec:registry:privateRegistry** 参数设置为私有镜像服务的默认地址 **dockerhub.kubekey.local/kse**，然后保存文件。
|
||||
+
|
||||
[,yaml]
|
||||
----
|
||||
spec:
|
||||
registry:
|
||||
registryMirrors: []
|
||||
insecureRegistries: []
|
||||
privateRegistry: dockerhub.kubekey.local/kse
|
||||
----
|
||||
|
||||
|
||||
. 执行以下命令初始化私有镜像服务：
|
||||
+
|
||||
====
|
||||
[,bash]
|
||||
----
|
||||
./kk init registry -f config-sample.yaml -a kubekey-artifact.tar.gz
|
||||
./kk create cluster -f config-sample.yaml
|
||||
----
|
||||
|
||||
如果显示如下信息，则表明镜像仓库创建成功。
|
||||
|
||||
image:/images/ks-qkcp/zh/v4.1/verify-registry.png[verify-registry, 100%]
|
||||
|
||||
include::../../../_custom/installationAndUpgrade/installationAndUpgrade-note-initializeRegistry.adoc[]
|
||||
|
||||
====
|
||||
|
||||
. 若 **spec:registry:type** 参数设置为 **harbor**，执行以下命令创建 Harbor 项目。
|
||||
+
|
||||
--
|
||||
// Bash
|
||||
include::../../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
bash create_project_harbor.sh
|
||||
|
||||
----
|
||||
|
||||
创建 harbor 项目后，在 **config-sample.yaml** 中配置 **spec:registry:auths** 参数。
|
||||
|
||||
[.admon.note,cols="a"]
|
||||
|===
|
||||
|说明
|
||||
|
||||
|
|
||||
harbor 安装文件在 /opt/harbor 目录下，可在该目录下对 harbor 进行运维。
|
||||
|
||||
|===
|
||||
--
|
||||
|
||||
+
|
||||
|
||||
include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-editHosts_v4.adoc[]
|
||||
|
||||
== 安装 Kubernetes
|
||||
|
||||
// Note
|
||||
include::../../../../_ks_components/admonitions/note.adoc[]
|
||||
|
||||
* 如果您已有可用的 Kubernetes 集群，可跳过此步骤。
|
||||
|
||||
* 安装包中集成了 CentOS 7、Ubuntu 18.04、Ubuntu 20.04、Ubuntu 22.04 依赖包，如使用这些操作系统需要使用 kk 自动安装系统依赖，可在安装命令后添加 --with-packages ; 如使用这些操作系统之外的操作系统或由于依赖问题导致失败，需手动安装相关依赖（conntrack）。
|
||||
|
||||
* 如需使用 openebs localpv，可在如下命令后添加参数 --with-local-storage，如需对接其他存储，可在配置文件 addons 中添加配置相关存储插件，或 Kubernetes 集群部署完成后自行安装。
|
||||
|
||||
* 如使用 kk 部署的 harbor，请确保安装 Kubernetes 之前，已创建 harbor 项目，且配置文件 config-sample.yaml 中已配置 spec:registry:auths 参数。
|
||||
如需使用 openebs localpv，可在命令后添加参数 --with-local-storage。如需对接其他存储，可在配置文件 addons 中添加配置相关存储插件，或 Kubernetes 集群部署完成后自行安装。
|
||||
|
||||
include::../../../../_ks_components/admonitions/admonEnd.adoc[]
|
||||
|
||||
执行以下命令创建 Kubernetes 集群：
|
||||
|
||||
include::../../../_custom/installationAndUpgrade/installationAndUpgrade-startInstallationOffline.adoc[]
|
||||
|
||||
如果显示如下信息，则表明 Kubernetes 集群创建成功。
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
Pipeline[CreateclusterPipeline] execute successfully
|
||||
Installation is complete.
|
||||
----
|
||||
|
||||
|
||||
== 导入镜像到私有镜像仓库
|
||||
|
||||
执行以下命令将镜像导入到指定的私有镜像仓库中。
|
||||
|
||||
[,bash]
|
||||
----
|
||||
./kk artifact images push -f config-sample.yaml -a kubekey-artifact.tar.gz
|
||||
----
|
||||
|
||||
如果显示如下信息，则表明导入成功。
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
Pipeline[ArtifactImagesPushPipeline] execute successfully
|
||||
----
|
||||
--
|
||||
|
||||
== 安装{ks_product_left}
|
||||
|
||||
=== 步骤 1：部署 ks-core
|
||||
KubeSphere Core (ks-core) 是{ks_product_both}的核心组件，为扩展组件提供基础的运行环境。KubeSphere Core 安装完成后，即可访问{ks_product_left} Web 控制台。
|
||||
|
||||
. 在集群节点，执行以下命令安装 KubeSphere Core。
|
||||
+
|
||||
====
|
||||
[,bash]
|
||||
----
|
||||
helm upgrade --install -n kubesphere-system --create-namespace ks-core charts/ks-core \
|
||||
--debug \
|
||||
--wait \
|
||||
--set cloud.enabled=false \
|
||||
--set upgrade.enabled=false \
|
||||
--set global.imageRegistry=dockerhub.kubekey.local/kse \
|
||||
--set extension.imageRegistry=dockerhub.kubekey.local/kse
|
||||
helm upgrade --install -n kubesphere-system --create-namespace ks-core https://charts.kubesphere.io/main/ks-core-1.1.0.tgz --debug --wait
|
||||
----
|
||||
|
||||
[.admon.attention,cols="a"]
|
||||
|===
|
||||
|注意
|
||||
|
||||
|
|
||||
将 **global.imageRegistry** 和 **extension.imageRegistry** 的默认地址 **dockerhub.kubekey.local/kse** 替换为您的实际镜像仓库地址。
|
||||
|===
|
||||
|
||||
取决于您的硬件和网络环境，您可能需要配置流量转发规则并在防火墙中放行 30880 端口。如果显示如下信息，则表明 ks-core 安装成功：
|
||||
如果显示如下信息，则表明 ks-core 安装成功：
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
|
|
@ -550,101 +414,9 @@ For additional information and details, please visit https://kubesphere.io.
|
|||
|说明
|
||||
|
||||
|
|
||||
此时，{ks_product_right} Web 控制台仅提供{ks_product_both}的核心功能，若要使用扩展组件，还需继续执行以下 2 个步骤以便安装扩展组件。
|
||||
取决于您的网络环境，您可能需要配置流量转发规则并在防火墙中放行 30880 端口。
|
||||
|===
|
||||
|
||||
=== 步骤 2：发布扩展组件
|
||||
// 此时，{ks_product_right} Web 控制台仅提供{ks_product_both}的核心功能。
|
||||
|
||||
执行以下命令，将{ks_product_both}提供的所有扩展组件导入到 Web 控制台的扩展中心。
|
||||
|
||||
[,bash]
|
||||
----
|
||||
helm template -n kubesphere-system charts/kse-extensions-publish --set museum.enabled=true,global.imageRegistry=dockerhub.kubekey.local/kse | kubectl apply -f -
|
||||
----
|
||||
|
||||
如果显示如下信息，则表明扩展组件发布成功。
|
||||
|
||||
image:/images/ks-qkcp/zh/v4.1/verify-extension-release.png[verify-extension-release, 100%]
|
||||
|
||||
=== 步骤 3：部署扩展组件
|
||||
|
||||
发布扩展组件后，登录{ks_product_left} Web 控制台，可在扩展中心查看并安装扩展组件。或者，按照以下步骤快速部署扩展组件。
|
||||
|
||||
. 若要安装可观测相关扩展组件，需要先部署 vector（WhizardTelemetry 数据流水线）和 whizard-monitoring（WhizardTelemetry 监控）扩展组件。否则，可跳过此步骤。
|
||||
+
|
||||
--
|
||||
[,bash]
|
||||
----
|
||||
# 安装 vector 和 whizard-monitoring
|
||||
kubectl apply -f kse-extensions/vector-installplan.yaml
|
||||
kubectl apply -f kse-extensions/whizard-monitoring-installplan.yaml
|
||||
|
||||
# 检查 vector 和 whizard-monitoring 的安装状态，等待状态变为 Installed
|
||||
kubectl get installplan vector -w
|
||||
kubectl get installplan whizard-monitoring -w
|
||||
----
|
||||
--
|
||||
|
||||
|
||||
. 执行以下命令，安装指定扩展组件或所有扩展组件。
|
||||
+
|
||||
--
|
||||
[,bash]
|
||||
----
|
||||
# 安装指定扩展组件，请将 {EXTENSION-NAME} 替换为实际名称
|
||||
kubectl apply -f kse-extensions/{EXTENSION-NAME}-installplan.yaml
|
||||
|
||||
# 安装所有扩展组件
|
||||
kubectl apply -f kse-extensions
|
||||
----
|
||||
|
||||
[.admon.note,cols="a"]
|
||||
|===
|
||||
|说明
|
||||
|
||||
|
|
||||
* 在{ks_product_both}安装包的 kse-extensions 目录下获取各个扩展组件的 `{EXTENSION-NAME}`，也可参考下图获取。
|
||||
* 点击link:../../../03-installation-and-upgrade/03-upgrade-kubesphere/05-appendix-ks-core#_升级组件清单[此处]查看组件清单，了解更多信息。
|
||||
|===
|
||||
|
||||
[.admon.attention,cols="a"]
|
||||
|===
|
||||
|注意
|
||||
|
||||
|
|
||||
对于已修改扩展组件配置的扩展组件，请勿重新执行 `kubectl apply -f kse-extensions/{EXTENSION-NAME}-installplan.yaml`，避免扩展组件配置被覆盖。
|
||||
|===
|
||||
--
|
||||
|
||||
. 执行以下命令，等待扩展组件状态变更为 **Installed**，则表明部署成功。
|
||||
+
|
||||
--
|
||||
[,bash]
|
||||
----
|
||||
kubectl get installplan -w
|
||||
----
|
||||
|
||||
image:/images/ks-qkcp/zh/v4.1/verify-extension-installed.png[ verify-extension-installed,100%]
|
||||
--
|
||||
|
||||
// . 如需安装 Spring Cloud 扩展组件，可提前安装。否则，可跳过此步骤。
|
||||
// +
|
||||
// --
|
||||
// [.admon.attention,cols="a"]
|
||||
// |===
|
||||
// |注意
|
||||
|
||||
// |
|
||||
// Spring Cloud 启动较慢，且包含聚合 API，因此 Spring Cloud 完全启动前会导致需要连接 kube-apiserver 的 Pod 异常，建议提前安装。
|
||||
|
||||
// |===
|
||||
|
||||
// [,bash]
|
||||
// ----
|
||||
// # 安装 springcloud
|
||||
// kubectl apply -f kse-extensions/springcloud-installplan.yaml
|
||||
|
||||
// # 检查 springcloud 运行状态，确保 spring-cloud-controller-manager 和 springcloud-agent-nacos 为 running 状态
|
||||
// kubectl get pod -n extension-springcloud
|
||||
// ----
|
||||
// --
|
||||
// * 若要使用扩展组件，还需link:../../../06-extension-user-guide/02-subscribe-and-install-components[订阅并安装扩展组件]。
|
||||
|
|
|
|||
|
|
@ -0,0 +1,274 @@
|
|||
---
|
||||
title: "附录：KubeSphere Core 高级配置"
|
||||
linkTitle: "附录：KubeSphere Core 高级配置"
|
||||
keywords: "Kubernetes, KubeSphere, KubeSphere Core, 配置"
|
||||
description: "了解 KubeSphere Core 的高级配置。"
|
||||
weight: 05
|
||||
---
|
||||
|
||||
|
||||
== KubeSphere Helm Chart 选项
|
||||
|
||||
=== 常用选项
|
||||
|
||||
[%header,cols="1,1,3a"]
|
||||
|===
|
||||
|选项 |默认值 |描述
|
||||
|adminPassword |"" |string - 为第一个管理员用户设置引导密码。登录后，管理员需要重置密码。如不设置，会使用内置默认密码 **P@88w0rd**。
|
||||
|hostname |"example.com" |string - KubeSphere Server 完全限定的域名。
|
||||
|ingress.enabled |false |bool - 如果值为 true, 创建 KubeSphere Ingress 网关。
|
||||
|ingress.tls.enabled |true |bool - 如果值为 true, 则为 KubeSphere Ingress 网关启用 HTTPS。
|
||||
|ingress.tls.source |"generation" |string - Ingress 证书的来源，可选项："generation, importation, letsEncrypt"。
|
||||
|letsEncrypt.email |"" |string - 邮箱地址，证书过期时会收到邮件提醒。
|
||||
|letsEncrypt.environment |"production" |string - 可选项："staging, production"。测试环境和生产环境证书在速率限制上存在区别，详情见：link:https://letsencrypt.org/docs/[Let’s Encrypt 官方文档]。
|
||||
|
||||
|===
|
||||
|
||||
=== 高级选项
|
||||
|
||||
[%header,cols="1,1,3a"]
|
||||
|===
|
||||
|选项 |默认值 |描述
|
||||
|internalTLS | false | bool - 如果值为 true, 启用内部 TLS。console 和 apiserver 均会启用 HTTPS 服务。
|
||||
|ingress.ingressClassName | "" | string - 使用网关的可选 Ingress 类，可选项："nginx，traefik"。
|
||||
|ingress.secretName | "kubesphere-tls-certs" | string - Ingress 网关所使用的包含 TLS 证书的 Secrets。
|
||||
|extension.ingress.ingressClassName |"" |用于扩展组件访问的外部 ingress 的 ingressClassName。
|
||||
|extension.ingress.domainSuffix |"" |用于创建扩展组件访问入口的域名后缀；根据外部 ingress 地址，它可以是 LB 主机名地址（比如 xx.com）、{node_ip}.nip.io 或内部 DNS 地址（比如 kse.local）。
|
||||
|extension.ingress.httpPort |80 |扩展组件的 ingress 的 http 端口。
|
||||
|extension.ingress.httpsPort |443 |扩展组件的 ingress 的 https 端口。
|
||||
|certmanager.duration | 2160h | string - cert-manager 生成证书的过期时间。
|
||||
|certmanager.renewBefore | 360h | string - cert-manager 刷新证书到证书过期之间的时间间隔。
|
||||
|global.imageRegistry | registry.cn-beijing.aliyuncs.com | string - 设置全局的 KubeSphere 镜像仓库地址。
|
||||
|global.tag | "v4.1.2" | string - 设置全局的 KubeSphere 镜像仓库标签。
|
||||
|apiserver.image.registry | "" | string - 设置 ks-apiserver 镜像仓库地址。
|
||||
|apiserver.image.repository | "kse/ks-apiserver" | string - 设置 ks-apiserver 镜像名称。
|
||||
|apiserver.image.tag | "" | string - 设置 ks-apiserver 镜像标签。
|
||||
|apiserver.nodePort | "" | uint16 - 设置 ks-apiserver 服务 service 的 NodePort 端口。
|
||||
|console.image.registry | "" | string - 设置 ks-console 镜像仓库地址。
|
||||
|console.image.repository | "kse/ks-console" | string - 设置 ks-console 镜像名称。
|
||||
|console.image.tag | "" | string - 设置 ks-console 镜像标签。
|
||||
|console.nodePort | 30880 | uint16 - 设置 ks-console 服务 service 的 NodePort 端口。
|
||||
|controller.image.registry | "" | string - 设置 ks-controller-manager 镜像仓库地址。
|
||||
|controller.image.repository | "kse/ks-controller-manager" | string - 设置 ks-controller-manager 镜像名称。
|
||||
|controller.image.tag | "" | string - 设置 ks-controller-manager 镜像标签。
|
||||
|composedApp.appSelector | "" | string - 指定 annotation 或 label，以便对匹配的自制应用进行处理并更新状态。
|
||||
|
||||
若 appSelector 值为空，则处理所有自制应用。若在命令或配置字典中添加以下内容，可指定只处理 KubeSphere 创建、管理的自制应用。
|
||||
|
||||
* 安装 ks-core 时，在安装命令中添加：
|
||||
+
|
||||
--set composedApp.appSelector="kubesphere.io/creator"
|
||||
|
||||
* 升级 ks-core 时，在升级命令中添加：
|
||||
+
|
||||
--set composedApp.appSelector="kubesphere.io/creator"
|
||||
|
||||
* 安装升级完成后，在集群的 kubesphere-config 配置字典中设置为：
|
||||
+
|
||||
[,yaml]
|
||||
----
|
||||
composedApp:
|
||||
appSelector: "kubesphere.io/creator"
|
||||
----
|
||||
|===
|
||||
|
||||
== TLS 配置
|
||||
|
||||
. 选择 SSL 配置
|
||||
+
|
||||
--
|
||||
KubeSphere 安全配置分为**网关 SSL 配置**以及**内部服务 SSL 配置**两个部分。其中**网关 SSL 配置**默认支持以下三种模式来启用 SSL/TLS，以保证访问的安全性。
|
||||
--
|
||||
|
||||
.. 网关 SSL 配置
|
||||
+
|
||||
--
|
||||
[%header,cols="1,2,1"]
|
||||
|===
|
||||
|配置
|
||||
|Helm Chart 选项
|
||||
|是否需要 cert-manager
|
||||
|
||||
|KubeSphere 生成的 TLS证书 |ingress.tls.source=generation |否
|
||||
|Let’s Encrypt |ingress.tls.source=letsEncrypt |是
|
||||
|导入已有的证书 |ingress.tls.source=importation |否
|
||||
|
||||
|===
|
||||
|
||||
* KubeSphere 生成的 TLS 证书：支持 cert-manager 和 helm 两种方式。
|
||||
|
||||
** 如果 Kubernetes 集群中已安装 cert-manager，则首选使用 cert-manager 生成证书。KubeSphere 使用 cert-manager 签发并维护证书。KubeSphere 会生成自己的 CA 证书，并用该 CA 签署证书，然后由 cert-manager 管理该证书。
|
||||
|
||||
** 如果未安装 cert-manager，则使用 helm 生成证书。在使用 helm 安装的过程中，KubeSphere 会根据设置的 `hostname` 生成 CA 和 TLS 证书。在此选项下，证书不支持自动过期轮转。
|
||||
|
||||
* Let's Encrypt
|
||||
+
|
||||
使用 Let's Encrypt 选项必须使用 cert-manager。但是，在这种情况下，cert-manager 与 Let's Encrypt 的特殊颁发者相结合，该颁发者执行获取 Let's Encrypt 颁发证书所需的所有操作，包括请求和验证。此配置使用 HTTP 验证（HTTP-01），因此负载均衡器必须具有可以从互联网访问的公共 DNS 记录。
|
||||
|
||||
* 导入已有的证书
|
||||
+
|
||||
使用已有的CA 颁发的公有或私有证书。KubeSphere 将使用该证书来保护 WebSocket 和 HTTPS 流量。在这种情况下，您必须上传名称分别为 tls.crt 和 tls.key 的 PEM 格式的证书以及相关的密钥。如果您使用私有 CA，则还必须上传该 CA 证书。这是由于您的节点可能不信任此私有 CA。
|
||||
--
|
||||
|
||||
.. 内部服务 SSL 配置
|
||||
+
|
||||
--
|
||||
启用内部 SSL 配置之后，KubeSphere 中 Console UI 和 Apiserver 均会启用 HTTPS，内置支持 cert-manager 和 helm 生成证书。在 Kubernetes 集群已安装 cert-manager 的情况下优先使用 cert-manager 生成/管理证书，证书的 DNS 默认使用 Console UI 和 Apiserver 在 Kubernetes 集群内部的 Service DNS。
|
||||
|
||||
[%header,cols="1,1,1"]
|
||||
|===
|
||||
|配置 |Helm Chart 选项 |是否需要 cert-manager
|
||||
|启用内部SSL |internalTLS=true |否
|
||||
|
||||
|===
|
||||
--
|
||||
|
||||
. 安装 cert-manager
|
||||
+
|
||||
--
|
||||
若使用自己的证书文件（ingress.tls.source=importation），您可以跳过此步骤。
|
||||
|
||||
仅在使用 KubeSphere 生成的证书（ingress.tls.source=generation）或 Let's Encrypt 颁发的证书（ingress.tls.source=letsEncrypt）时，才需要安装 cert-manager。
|
||||
|
||||
[,bash]
|
||||
----
|
||||
# 添加 Jetstack Helm 仓库
|
||||
helm repo add jetstack https://charts.jetstack.io
|
||||
|
||||
# 更新本地 Helm Chart 仓库缓存
|
||||
helm repo update
|
||||
|
||||
# 安装 cert-manager Helm Chart
|
||||
helm install cert-manager jetstack/cert-manager -n cert-manager --create-namespace --set prometheus.enabled=false
|
||||
# 或
|
||||
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/<VERSION>/cert-manager.yaml
|
||||
|
||||
----
|
||||
安装完 cert-manager 后，检查 cert-manager 命名空间中正在运行的 Pod 来验证它是否已正确部署：
|
||||
|
||||
[,bash]
|
||||
----
|
||||
kubectl get pods --namespace cert-manager
|
||||
----
|
||||
--
|
||||
|
||||
. 根据您选择的证书选项，通过 Helm 为 KubeSphere 开启 SSL 配置
|
||||
|
||||
.. 启用网关 SSL 配置
|
||||
+
|
||||
--
|
||||
* KubeSphere 生成的证书
|
||||
+
|
||||
[,bash]
|
||||
----
|
||||
helm upgrade --install -n kubesphere-system --create-namespace ks-core $chart --version $version \
|
||||
--set ingress.enabled=true \
|
||||
--set hostname=kubesphere.my.org
|
||||
----
|
||||
|
||||
* Let's Encrypt
|
||||
+
|
||||
此选项使用 cert-manager 来自动请求和续订 Let's Encrypt 证书。Let's Encrypt 是免费的，而且是受信的 CA，因此可以提供有效的证书。
|
||||
+
|
||||
[,bash]
|
||||
----
|
||||
helm upgrade --install -n kubesphere-system --create-namespace ks-core $chart --version $version \
|
||||
--set hostname=kubesphere.my.org \
|
||||
--set ingress.enabled=true \
|
||||
--set ingress.tls.source=letsEncrypt \
|
||||
--set letsEncrypt.email=me@example.org
|
||||
----
|
||||
|
||||
* 导入外部证书
|
||||
+
|
||||
[,bash]
|
||||
----
|
||||
# 导入外部证书
|
||||
kubectl create secret tls tls-ks-core-ingress --cert=tls.crt --key=tls.key -n kubesphere-system
|
||||
|
||||
# 安装 KubeSphere
|
||||
helm upgrade --install -n kubesphere-system --create-namespace ks-core
|
||||
$chart --version $version \
|
||||
--set ingress.enabled=true \
|
||||
--set hostname=kubesphere.my.org \
|
||||
--set ingress.tls.source=importation
|
||||
----
|
||||
--
|
||||
|
||||
.. 启用内部服务 SSL 配置
|
||||
+
|
||||
[,bash]
|
||||
----
|
||||
helm upgrade --install -n kubesphere-system --create-namespace ks-core
|
||||
$chart --version $version \
|
||||
--set internalTLS=true
|
||||
----
|
||||
|
||||
== 配置 ratelimit 限流器
|
||||
|
||||
启用限流器之后，限流器会对所有用户的请求独立限流，主要支持以下两种方式：
|
||||
|
||||
* 对 KubeSphere 中的每个用户设置限流速率，暂不支持独立设置每个用户的限流速率；
|
||||
|
||||
* 对 KubeSphere 中的每个 ServiceAccount 独立设置限流速率。
|
||||
|
||||
[discrete]
|
||||
=== 启用限流器
|
||||
|
||||
启用限流器就是对 KubeSphere 中的每个用户设置限流速率。
|
||||
|
||||
. 修改 kubesphere-system 配置文件。
|
||||
+
|
||||
--
|
||||
[,bash]
|
||||
----
|
||||
kubectl -n kubesphere-system edit cm kubesphere-system
|
||||
----
|
||||
|
||||
新增以下内容：
|
||||
[,yaml]
|
||||
----
|
||||
rateLimit:
|
||||
enable: true # 启用限流器
|
||||
driver: memory # 内存模式
|
||||
QPS: 40.0 # 令牌恢复速率
|
||||
burst: 80 # 令牌桶容量
|
||||
----
|
||||
--
|
||||
|
||||
. 重启 ks-apiserver。
|
||||
+
|
||||
[,bash]
|
||||
----
|
||||
kubectl -n kubesphere-system rollout restart deploy ks-apiserver
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== 设置 ServiceAccount 限流器
|
||||
|
||||
设置前，您需要按照上一步启用限流器。然后执行以下命令对 ServiceAccount 设置限流速率。
|
||||
|
||||
[,bash]
|
||||
----
|
||||
kubectl -n <Namespace> patch serviceaccounts.kubesphere.io <ServiceAccount> --type merge -p '{"metadata": {"annotations": {"kubesphere.io/ratelimiter-qps": "20.0", "kubesphere.io/ratelimiter-burst": "40"}}}'
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== 参数说明
|
||||
|
||||
[%header,cols="1,1,3a"]
|
||||
|===
|
||||
|选项 |默认值 |描述
|
||||
|rateLimit.enable |false |bool - 启用限流器。
|
||||
|rateLimit.driver |memory |string - 限流器存储类型，可选项："memory"。
|
||||
|rateLimit.QPS |5.0 |float32 - 限流器令牌桶算法中每秒恢复的令牌数。
|
||||
|rateLimit.burst |10 |int - 限流器令牌桶算法中令牌桶的最大容量。
|
||||
|===
|
||||
|
||||
[.admon.note,cols="a"]
|
||||
|===
|
||||
|说明
|
||||
|
||||
|令牌的恢复速率 QPS 建议设置为桶容量 burst 的一半。
|
||||
|===
|
||||
|
||||
|
|
@ -1,492 +0,0 @@
|
|||
---
|
||||
title: "升级 KubeSphere 企业版"
|
||||
linkTitle: "升级 KubeSphere 企业版"
|
||||
keywords: "Kubernetes, KubeSphere, 安装, 升级 KubeSphere"
|
||||
description: "介绍如何升级 KubeSphere。"
|
||||
weight: 03
|
||||
---
|
||||
|
||||
本节介绍如何在保持当前的 Kubernetes 版本不变的情况下从{ks_product_both} v3.5.0 升级到{ks_product_both} v4.1.0。
|
||||
|
||||
|
||||
== 前提条件
|
||||
|
||||
* 您需要联系{ks_product_both}的服务支持团队获取{ks_product_left} v4.1.0 安装包，以及 license。
|
||||
|
||||
// 如实施现场条件允许在线拉取公开仓库，具备在线安装条件，可联系 KubeSphere 产品团队获取在线安装文件及相关信息。
|
||||
|
||||
* 请确保当前{ks_product_both}版本为 v3.5.0。如果您的{ks_product_both}版本低于 v3.5.0，请先将{ks_product_both}版本升级到 v3.5.0。
|
||||
|
||||
* 请确保当前 Kubernetes 版本为 v1.21.x、v1.22.x、v1.23.x, v1.24.x, v1.25.x, v1.26.x, v1.27.x 或 v1.28.x。
|
||||
|
||||
// :relfileprefix: ../../../
|
||||
|
||||
// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-prer-offlineInstallation.adoc[]
|
||||
|
||||
// :relfileprefix: ./
|
||||
|
||||
* {empty}
|
||||
include::../../../_custom/installationAndUpgrade/installationAndUpgrade-prer-backUpData.adoc[]
|
||||
|
||||
== 准备工作
|
||||
|
||||
. 将{ks_product_both} v4.1.0 安装包传输到所有集群的节点上。
|
||||
+
|
||||
[.admon.note,cols="a"]
|
||||
|===
|
||||
|说明
|
||||
|
||||
|
|
||||
若想了解安装包中各个文件的作用，请参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/#_查看安装包内容[查看安装包内容]。
|
||||
|===
|
||||
|
||||
. 使用 **backup.sh** 备份系统企业空间（system-workspace）下所有项目中的关键资源，以及备份所有自定义角色及权限相关资源。
|
||||
+
|
||||
--
|
||||
执行以下命令开始备份。相关资源将备份至 **backup-$timestamp** 目录下。
|
||||
|
||||
[,bash]
|
||||
----
|
||||
bash backup.sh
|
||||
----
|
||||
|
||||
备份完成后，如下图所示。
|
||||
|
||||
image:/images/ks-qkcp/zh/v4.1/backup.png[ backup, 100%]
|
||||
--
|
||||
|
||||
. 联系{ks_product_both}的服务支持团队，根据当前集群的 cc.yaml 中的配置和 KubeSphere 组件的 patch 情况（如 cc.yaml 外的配置），确定升级时各组件使用的参数，然后创建 **ks-core-values.yaml** 文件。可参阅安装包中的 ks-core-values.yaml 示例文件。
|
||||
+
|
||||
--
|
||||
[.admon.attention,cols="a"]
|
||||
|===
|
||||
|注意
|
||||
|
||||
|
|
||||
* 在 ks-core-values.yaml 文件中，可将集群中没有启用的组件设置为 enabled: false。core 和 iam 组件必须配置为 enabled: true，不可禁用。
|
||||
|
||||
* 部分扩展组件在特定情况下（比如依赖外部服务的访问地址等），升级时不能使用**默认配置**，需手动配置一些字段。请参阅**组件升级配置文档**确认您的组件是否存在此问题，并在 ks-core-values.yaml 文件中做出相应修改。
|
||||
请在{ks_product_both} v4.1.0 用户文档中的**升级配置文档**文件夹下查阅“默认配置”和“组件升级配置文档”。
|
||||
|
||||
|===
|
||||
--
|
||||
|
||||
. 将安装包中的 **charts** 文件夹、以及创建的 **ks-core-values.yaml** 文件复制到 **upgrade.sh** 所在的 tools 目录。
|
||||
|
||||
. 执行安装包中的脚本 **pre-check.sh**，检查是否满足升级条件，需确保所有检查项通过。如果检查未通过，后续升级很有可能失败。
|
||||
|
||||
|
||||
== 单集群升级
|
||||
|
||||
. 在 host 集群节点上，切换到安装包的 tools 目录（该目录需包含 **charts** 文件夹、**ks-core-values.yaml** 和 **upgrade.sh**）。
|
||||
|
||||
. 执行以下命令开始升级{ks_product_left}。
|
||||
+
|
||||
--
|
||||
[,bash]
|
||||
----
|
||||
bash upgrade.sh host
|
||||
----
|
||||
--
|
||||
|
||||
. 参考以下步骤，检查 host 集群是否升级成功。
|
||||
|
||||
.. 执行以下命令，upgrade job 应该是成功完成的状态，如下所示。
|
||||
+
|
||||
[,bash]
|
||||
----
|
||||
root@xxx:~# kubectl -n kubesphere-system get job | grep upgrade
|
||||
ks-core-post-upgrade 1/1 16s 28m
|
||||
ks-core-pre-upgrade 1/1 58s 31m
|
||||
prepare-upgrade 1/1 26s 32m
|
||||
----
|
||||
|
||||
.. 执行以下命令，如果显示如下信息，则表明 ks-core Helm Chart 已成功部署。
|
||||
+
|
||||
[,bash]
|
||||
----
|
||||
root@xxx:~# helm list -n kubesphere-system
|
||||
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
|
||||
ks-core kubesphere-system 6 2024-04-09 14:54:09.349488995 +0800 CST deployed ks-core-1.0.0 v4.1.0
|
||||
----
|
||||
|
||||
.. 执行以下命令，pod（ks-apiserver, ks-console, ks-controller-manager）应该为 running 状态，如下所示。
|
||||
+
|
||||
[,bash]
|
||||
----
|
||||
root@xxx:~# kubectl -n kubesphere-system get pod
|
||||
NAME READY STATUS RESTARTS AGE
|
||||
ks-apiserver-594bb884db-phrlv 1/1 Running 0 28m
|
||||
ks-console-7cd55dd9f9-f2jl9 1/1 Running 0 28m
|
||||
ks-controller-manager-785fc676dc-9d9j2 1/1 Running 0 28m
|
||||
----
|
||||
|
||||
.. 执行以下命令，如果所有扩展组件的状态为 Installed，表明扩展组件都已成功安装。
|
||||
+
|
||||
[,bash]
|
||||
----
|
||||
root@xxx:~# kubectl get installplan
|
||||
NAME STATE
|
||||
storage-utils Installed
|
||||
devops Installed
|
||||
network Installed
|
||||
...
|
||||
----
|
||||
|
||||
.. 登录{ks_product_left} Web 控制台后，点击右上角用户名 > 关于，显示的平台版本应为 v4.1.0。
|
||||
|
||||
. 使用原有的 Web 控制台的 IP 地址、管理员用户名和管理员密码，并使用网页浏览器登录 v4.1.0 的{ks_product_left} Web 控制台。
|
||||
|
||||
. 根据激活提示点击**激活**，导入{ks_product_left}的 license。
|
||||
|
||||
. 检查 host 集群各项功能和数据是否正常。
|
||||
|
||||
|
||||
== 多集群升级
|
||||
|
||||
. 按照以上link:#_单集群升级[单集群升级]步骤完成 host 集群的升级。
|
||||
|
||||
. 在 member 集群节点上，切换到安装包的 tools 目录（该目录需包含 **charts** 文件夹、**ks-core-values.yaml** 和 **upgrade.sh**）。
|
||||
|
||||
. 执行以下命令开始升级{ks_product_left}。
|
||||
+
|
||||
[,bash]
|
||||
----
|
||||
bash upgrade.sh member
|
||||
----
|
||||
|
||||
. 参考以下步骤，检查 member 集群是否升级成功。
|
||||
|
||||
.. 执行以下命令，upgrade job 应该是成功完成的状态，如下所示。
|
||||
+
|
||||
[,bash]
|
||||
----
|
||||
root@xxx:~# kubectl -n kubesphere-system get job | grep upgrade
|
||||
ks-core-post-upgrade 1/1 16s 28m
|
||||
ks-core-pre-upgrade 1/1 58s 31m
|
||||
prepare-upgrade 1/1 26s 32m
|
||||
----
|
||||
|
||||
.. 执行以下命令，如果显示如下信息，则表明 ks-core Helm Chart 已成功部署。
|
||||
+
|
||||
[,bash]
|
||||
----
|
||||
root@xxx:~# helm list -n kubesphere-system
|
||||
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
|
||||
ks-core kubesphere-system 6 2024-04-09 14:54:09.349488995 +0800 CST deployed ks-core-1.0.0 v4.1.0
|
||||
----
|
||||
|
||||
.. 执行以下命令，ks-agent pod 应该为 running 状态，如下所示。
|
||||
+
|
||||
[,bash]
|
||||
----
|
||||
root@xxx:~# kubectl -n kubesphere-system get pod
|
||||
NAME READY STATUS RESTARTS AGE
|
||||
ks-agent-5dc5b57977-4x6mf 2/2 Running 0 59m
|
||||
----
|
||||
|
||||
. member 集群升级成功后，在 host 集群上执行以下命令，修改 member 集群的状态，以便使扩展组件 agent 调度到 member 集群上。
|
||||
+
|
||||
--
|
||||
[,bash]
|
||||
----
|
||||
kubectl get clusters.cluster.kubesphere.io {member-x} -o json | jq 'del(.status.conditions[] | select(.type=="Schedulable"))' | kubectl apply -f -
|
||||
----
|
||||
|
||||
[.admon.note,cols="a"]
|
||||
|===
|
||||
|说明
|
||||
|
||||
| 执行 `kubectl get cluster`，替换 `{member-x}`。
|
||||
|
||||
|===
|
||||
|
||||
如果节点没有 jq 命令，可通过编辑集群资源的方式实现，编辑 member 集群的 status.conditions 中 type 为 Schedulable 的 condition，将其 status 设置为 True。
|
||||
|
||||
[,bash]
|
||||
----
|
||||
kubectl edit clusters.cluster.kubesphere.io {member-x}
|
||||
----
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
status:
|
||||
conditions:
|
||||
- lastTransitionTime: "2024-04-11T09:12:22Z"
|
||||
lastUpdateTime: "2024-04-11T09:12:22Z"
|
||||
message: Cluster has been initialized
|
||||
reason: Initialized
|
||||
status: "True"
|
||||
type: Initialized
|
||||
- lastTransitionTime: "2024-04-12T07:59:14Z"
|
||||
lastUpdateTime: "2024-04-12T07:59:14Z"
|
||||
message: Cluster has joined federation control plane successfully
|
||||
status: "True"
|
||||
type: Federated
|
||||
- lastTransitionTime: "2024-04-12T08:02:56Z"
|
||||
lastUpdateTime: "2024-04-12T08:02:56Z"
|
||||
message: KS Core is available now
|
||||
reason: KSCoreReady
|
||||
status: "True"
|
||||
type: KSCoreReady
|
||||
- lastTransitionTime: "2024-04-12T08:02:56Z"
|
||||
lastUpdateTime: "2024-04-12T08:02:56Z"
|
||||
message: Not schedulable now
|
||||
reason: Upgrading
|
||||
status: "False" # 修改此处即可
|
||||
type: Schedulable
|
||||
- lastTransitionTime: "2024-04-12T08:24:27Z"
|
||||
lastUpdateTime: "2024-04-12T08:24:27Z"
|
||||
message: Agent has connected to proxy successfully.
|
||||
status: "True"
|
||||
type: AgentAvailable
|
||||
- lastTransitionTime: "2024-04-12T08:57:40Z"
|
||||
lastUpdateTime: "2024-04-12T08:57:40Z"
|
||||
message: Cluster is available now
|
||||
reason: Ready
|
||||
status: "True"
|
||||
type: Ready
|
||||
----
|
||||
--
|
||||
|
||||
. 登录 host 集群的{ks_product_left} Web 控制台，进入**集群管理**页面，检查此 member 集群的各项功能和数据是否正常。
|
||||
|
||||
. 对下一个 member 集群继续执行以上步骤，直至完成所有集群的升级。
|
||||
|
||||
== 升级后配置
|
||||
|
||||
部分扩展组件，如 `KubeSphere 网关`、`WhizardTelemetry 监控`、`WhizardTelemetry 告警管理`、`WhizardTelemetry 通知管理`、`RadonDB DMP` 在升级后需进行额外配置，请参阅{ks_product_both} v4.1.0 用户文档中的**升级配置文档**文件夹下的**组件升级配置文档**进行配置。
|
||||
|
||||
[.admon.attention,cols="a"]
|
||||
|===
|
||||
|注意
|
||||
|
||||
|
|
||||
请务必参阅**组件升级配置文档**对升级后的 `KubeSphere 网关` 扩展组件进行配置，否则无法使用网关相关功能。
|
||||
|===
|
||||
|
||||
== 常见问题
|
||||
|
||||
=== 无法操作未升级的 member 集群
|
||||
|
||||
问题描述：host 集群升级到 v4.1.0 以后，无法在{ks_product_left} Web 控制台中查看和操作未升级的 member 集群。
|
||||
|
||||
原因：v4.1.0 与 v3.5.0 有许多 API 不兼容导致。
|
||||
|
||||
解决办法：
|
||||
|
||||
* 尽快升级 member 集群。
|
||||
* 可在 member 集群升级前，通过 member 集群的 Web 控制台直接访问 member 集群。
|
||||
|
||||
=== member 集群的 Web 控制台无法登录
|
||||
|
||||
问题描述：在升级 member 集群前，通过 member 集群的 Web 控制台无法登录任何用户，提示"incorrect username or password"。
|
||||
|
||||
原因：{ks_product_right} v3.x 默认禁止直接访问 member 集群的 Web 控制台。
|
||||
|
||||
解决办法：
|
||||
|
||||
. 执行以下命令，增加如下配置。
|
||||
+
|
||||
--
|
||||
[,bash]
|
||||
----
|
||||
kubectl -n kubesphere-system edit cm kubesphere-config
|
||||
----
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
authentication:
|
||||
oauthOptions:
|
||||
accessTokenMaxAge: 0
|
||||
clients:
|
||||
- name: kubesphere
|
||||
secret: kubesphere
|
||||
redirectURIs:
|
||||
- '*'
|
||||
----
|
||||
--
|
||||
|
||||
. 执行以下命令重启 ks-apiserver，即可登录 member 集群的 Web 控制台。
|
||||
+
|
||||
[,bash]
|
||||
----
|
||||
kubectl -n kubesphere-system rollout restart deployment ks-apiserver
|
||||
----
|
||||
|
||||
=== 升级脚本异常退出
|
||||
|
||||
问题描述：升级过程中，升级脚本异常退出，升级失败。
|
||||
|
||||
解决办法：执行以下命令，查看升级 Job 日志，排查升级失败原因。
|
||||
|
||||
[,bash]
|
||||
----
|
||||
kubectl -n kubesphere-system get job/prepare-upgrade
|
||||
|
||||
kubectl -n kubesphere-system get pod |grep prepare-upgrade
|
||||
|
||||
# 查看升级Job日志
|
||||
kubectl -n kubesphere-system logs prepare-upgrade-gvc6p
|
||||
----
|
||||
|
||||
[,bash]
|
||||
----
|
||||
kubectl -n kubesphere-system get job/ks-core-pre-upgrade
|
||||
|
||||
kubectl -n kubesphere-system get pod |grep ks-core-pre-upgrade
|
||||
|
||||
# 查看升级Job日志
|
||||
kubectl -n kubesphere-system logs ks-core-pre-upgrade-4n7tp
|
||||
----
|
||||
|
||||
[,bash]
|
||||
----
|
||||
kubectl -n kubesphere-system get job/ks-core-post-upgrade
|
||||
|
||||
kubectl -n kubesphere-system get pod |grep ks-core-post-upgrade
|
||||
|
||||
# 查看升级Job日志
|
||||
kubectl -n kubesphere-system logs ks-core-post-upgrade-4nzhk
|
||||
----
|
||||
|
||||
=== 自定义角色的权限项为空
|
||||
|
||||
问题描述：升级后，自定义角色的权限项为空，被赋予自定义角色的用户无法正常使用。
|
||||
|
||||
解决办法：
|
||||
|
||||
升级脚本 backup.sh 已帮助备份好自定义角色和自定义角色绑定，但由于权限变化，在升级时无法自动转换其权限，所以在升级后需要用户自行补充角色的权限。
|
||||
|
||||
. 使用升级脚本备份后，在 `backup-$timestamp/kse35-backup-iam-xxx.yaml` 路径下查看已经备份的自定义角色。
|
||||
|
||||
. 找到 `metadata.annotations[iam.kubesphere.io/aggregation-roles]`，用取到的值对比以下表格的 **3.x** 列中的名称，然后在{ks_product_left} Web 控制台找到对应的**描述**列中的权限名称。
|
||||
+
|
||||
--
|
||||
[.admon.note,cols="a"]
|
||||
|===
|
||||
|说明
|
||||
|
||||
|
|
||||
平台自定义角色请查阅以下**平台**表格，企业空间自定义角色请查阅以下**企业空间**表格，项目自定义角色请查阅以下**项目**表格，确认对应关系。
|
||||
|===
|
||||
--
|
||||
|
||||
**示例：**
|
||||
|
||||
已经备份好的平台自定义角色 `test` 的信息如下
|
||||
|
||||
```yaml
|
||||
apiVersion: iam.kubesphere.io/v1alpha2
|
||||
kind: GlobalRole
|
||||
metadata:
|
||||
annotations:
|
||||
iam.kubesphere.io/aggregation-roles: '["role-template-view-roles","role-template-view-users","role-template-view-basic","role-template-manage-clusters","role-template-view-clusters"]'
|
||||
kubesphere.io/alias-name: test-name
|
||||
kubesphere.io/creator: admin
|
||||
creationTimestamp: "2024-04-11T11:59:08Z"
|
||||
generation: 3
|
||||
name: test #自定义角色的名称
|
||||
resourceVersion: "529194"
|
||||
uid: a3ad5e39-2959-4e14-aa8f-e0c0ad8e6889
|
||||
rules:
|
||||
...
|
||||
...
|
||||
```
|
||||
|
||||
. 取到 `metadata.annotations[iam.kubesphere.io/aggregation-roles]` 的值，如下：
|
||||
+
|
||||
```yaml
|
||||
'["role-template-view-roles","role-template-view-users","role-template-view-basic","role-template-manage-clusters","role-template-view-clusters"]'
|
||||
```
|
||||
|
||||
. 对比以下**平台**表格，`metadata.annotations[iam.kubesphere.io/aggregation-roles]` 的各个值在表格的 **3.x** 列，对应的权限项在表格的**描述**列，故应该勾选**角色查看**、**用户查看**、**基础查看**、**集群管理**、**集群查看**。但因基础查看在 **4.1** 列被标记为 `none`，所以无法勾选**基础查看**。
|
||||
|
||||
. 在{ks_product_left} Web 控制台的**平台角色**页面编辑 `test` 角色的权限。
|
||||
+
|
||||
--
|
||||
image:/images/ks-qkcp/zh/v4.1/edit-permission.png[ edit-permission, 100%]
|
||||
|
||||
勾选**角色查看**、**用户查看**、**集群管理**、**集群查看**。
|
||||
|
||||
image:/images/ks-qkcp/zh/v4.1/check-permission.png[ check-permission, 100%]
|
||||
--
|
||||
|
||||
[.admon.attention,cols="a"]
|
||||
|===
|
||||
|注意
|
||||
|
||||
|
|
||||
一些权限项在 v4.1.0 中已经移除，标记为 `none`。有些没有移除，但出于安全考虑无法再将此权限授权给自定义角色，标记为 `can not use`。标记为 `none` 或 `can not use` 的权限项，在编辑自定义角色的权限时，不能被勾选。
|
||||
|===
|
||||
|
||||
|
||||
**平台**
|
||||
[%header,cols="1a,2a,2a"]
|
||||
|===
|
||||
| 描述 | 3.x | 4.1
|
||||
|
||||
|企业空间创建|role-template-create-workspaces| global-create-workspaces
|
||||
|应用模版管理|role-template-manage-app-templates | `none`
|
||||
|集群管理|role-template-manage-clusters | global-manage-clusters
|
||||
|平台设置管理| role-template-manage-platform-settings | `can not use`
|
||||
|角色管理| role-template-manage-roles | `can not use`
|
||||
|用户管理|role-template-manage-users | `can not use`
|
||||
|企业空间管理|role-template-manage-workspaces | global-manage-workspaces
|
||||
|应用查看| role-template-view-app-templates | `none`
|
||||
|基础查看|role-template-view-basic | `none`
|
||||
|集群查看|role-template-view-clusters | global-view-clusters
|
||||
|角色查看|role-template-view-roles | global-view-roles
|
||||
|用户查看| role-template-view-users | global-view-users
|
||||
|企业空间查看|role-template-view-workspaces | global-view-workspaces
|
||||
|===
|
||||
|
||||
**企业空间**
|
||||
[%header,cols="1a,2a,2a"]
|
||||
|===
|
||||
| 描述 | 3.x | 4.1
|
||||
|
||||
|DevOps 项目创建|role-template-create-devops | workspace-create-devops
|
||||
|项目创建|role-template-create-projects | workspace-create-projects
|
||||
|应用仓库管理|role-template-manage-app-repos | workspace-manage-app-repos
|
||||
|应用模板管理|role-template-manage-app-templates | workspace-manage-app-templates
|
||||
|DevOps 项目管理|role-template-manage-devops | workspace-manage-devops
|
||||
|部门管理 |role-template-manage-groups | `none`
|
||||
|成员管理|role-template-manage-members | `can not use`
|
||||
|项目管理|role-template-manage-projects | workspace-manage-projects
|
||||
|角色管理|role-template-manage-roles | `can not use`
|
||||
|企业空间设置管理|role-template-manage-workspace-settings | `can not use`
|
||||
|应用仓库查看|role-template-view-app-repos | workspace-view-app-repos
|
||||
|应用模版查看|role-template-view-app-templates | workspace-view-app-templates
|
||||
|基础查看|role-template-view-basic | `none`
|
||||
|DevOps 项目查看|role-template-view-devops | workspace-view-devops
|
||||
|部门查看|role-template-view-groups | `none`
|
||||
|成员查看|role-template-view-members | workspace-view-members
|
||||
|角色查看|role-template-view-roles | workspace-view-roles
|
||||
|企业空间设置查看|role-template-view-workspace-settings | `can not use`
|
||||
|===
|
||||
|
||||
**项目**
|
||||
|
||||
[%header,cols="1a,2a,2a"]
|
||||
|===
|
||||
| 描述 | 3.x | 4.1
|
||||
|
||||
|应用负载管理|role-template-manage-app-workloads | namespace-manage-app-workloads
|
||||
|配置字典管理|role-template-manage-configmaps | namespace-manage-configmaps
|
||||
|成员管理|role-template-manage-members | `can not use`
|
||||
|项目设置管理|role-template-manage-project-settings | namespace-manage-project-settings
|
||||
|角色管理|role-template-manage-roles | `can not use`
|
||||
|保密字典管理|role-template-manage-secrets | namespace-manage-secrets
|
||||
|服务账户管理|role-template-manage-serviceaccount | namespace-manage-serviceaccount
|
||||
|持久卷声明管理|role-template-manage-volumes | namespace-manage-persistentvolumeclaims
|
||||
|应用负载查看|role-template-view-app-workloads | namespace-manage-app-workloads
|
||||
|基础查看|role-template-view-basic|`none`
|
||||
|配置字典查看|role-template-view-configmaps | namespace-view-configmaps
|
||||
|成员查看|role-template-view-members | namespace-view-members
|
||||
|角色查看|role-template-view-roles | namespace-view-roles
|
||||
|保密字典查看|role-template-view-secrets | namespace-view-secrets
|
||||
|服务账户查看|role-template-view-serviceaccount | namespace-view-serviceaccount
|
||||
|持久卷声明查看|role-template-view-volumes | namespace-view-persistentvolumeclaims
|
||||
|===
|
||||
|
||||
|
|
@ -1,95 +0,0 @@
|
|||
---
|
||||
title: "附录 1：ks-core Helm Chart 升级参数"
|
||||
linkTitle: "附录 1：ks-core Helm Chart 升级参数"
|
||||
weight: 05
|
||||
---
|
||||
|
||||
== 升级 Job 配置
|
||||
|
||||
[%header,cols="2a,1a,2a"]
|
||||
|===
|
||||
| 选项 | 默认值 | 描述
|
||||
|
||||
| upgrade.enabled | true | bool - 是否启用升级组件
|
||||
| upgrade.image.registry | "" | string - 设置升级 Job 的镜像仓库地址
|
||||
| upgrade.image.repository | kse/ks-upgrade | string - 设置升级 Job 的镜像名称
|
||||
| upgrade.image.tag | "" | string - 设置升级 Job 的镜像标签
|
||||
| upgrade.image.pullPolicy | Always | string - 设置升级 Job 的镜像拉取策略
|
||||
| upgrade.persistenceVolume.name | ks-upgrade | string - 设置升级 Job 的存储卷
|
||||
| upgrade.persistenceVolume.storageClassName | "" | string - 设置升级 Job 的存储卷类
|
||||
| upgrade.persistenceVolume.accessMode | ReadWriteOnce | string - 设置升级 Job 的存储卷访问模式
|
||||
| upgrade.persistenceVolume.size | 5Gi | string - 设置升级 Job 的存储卷容量
|
||||
| upgrade.resources.limit.cpu | 1 | string - 设置升级 Job 的 CPU 资源配额上限
|
||||
| upgrade.resources.limit.memory | 1024Mi | string - 设置升级 Job 的 Memory 资源配额上限
|
||||
| upgrade.resources.requests.cpu | 20m | string - 设置升级 Job 的 CPU 资源申请配额
|
||||
| upgrade.resources.requests.memory | 100Mi | string - 设置升级 Job 的 Memory 资源申请配额
|
||||
|===
|
||||
|
||||
== 升级应用配置
|
||||
|
||||
[%header,cols="2a,1a,2a"]
|
||||
|===
|
||||
| 选项 | 默认值 | 描述
|
||||
|
||||
| upgrade.config.storage.local.path | /tmp/ks-upgrade | string - 设置升级 Job 使用本地目录存储备份数据
|
||||
| upgrade.config.storage.s3.endpoint | "" | string - 设置升级 Job 使用支持 S3 协议的对象存储服务备份数据，存储服务地址
|
||||
| upgrade.config.storage.s3.region | "" | string - 设置 S3 服务数据存储区域
|
||||
| upgrade.config.storage.s3.disableSSL | false | bool - 设置禁用 SSL 安全协议
|
||||
| upgrade.config.storage.s3.forcePathStyle | false | bool - 设置 S3 客户端对桶使用路径式寻址
|
||||
| upgrade.config.storage.s3.accessKeyID | "" | string - 设置 S3 服务账号的访问键，不使用凭证文件时是必需的
|
||||
| upgrade.config.storage.s3.secretAccessKey | "" | string - 设置 S3 服务账号的访问密钥，不使用凭证文件时是必需的
|
||||
| upgrade.config.storage.s3.sessionToken | "" | string - 设置 S3 服务的访问凭证文件
|
||||
| upgrade.config.storage.s3.bucket | "" | string - 设置 S3 服务的存储桶
|
||||
| upgrade.config.download.globalRegistryUrl | oci://hub.kubesphere.com.cn/kse-extensions | string - 设置扩展组件的仓库地址
|
||||
| upgrade.config.download.file | - | 系统预留配置
|
||||
| upgrade.config.download.http.timeout | 20 | int64 - 设置拉取扩展组件的超时时间
|
||||
| upgrade.config.download.http.caBundle | "" | string - 设置扩展组件仓库的自签名证书的 base64 字符串，多个自签名证书合并字符串 base64
|
||||
| upgrade.config.download.http.insecureSkipVerify | true | bool - 设置跳过扩展组件仓库 TLS 认证
|
||||
| upgrade.config.download.oci | - | 系统预留配置
|
||||
| upgrade.config.skipValidator | false | bool - 设置跳过升级 Job 版本校验，当前校验 KubeSphere 版本
|
||||
|===
|
||||
|
||||
== 升级组件配置
|
||||
|
||||
[%header,cols="2a,1a,2a"]
|
||||
|===
|
||||
| 选项 | 默认值 | 描述
|
||||
|
||||
|upgrade.config.jobs.$ID.enabled |false |bool - 设置启用升级组件 $ID
|
||||
|upgrade.config.jobs.$ID.priority |0 |int - 设置组件升级顺序的优先级
|
||||
|upgrade.config.jobs.$ID.extensionRef.name |"" |string - 设置扩展组件名称
|
||||
|upgrade.config.jobs.$ID.extensionRef.version |"" |string - 设置扩展组件版本
|
||||
|
||||
|===
|
||||
|
||||
== 升级组件清单
|
||||
|
||||
[%header,cols="1a,2a"]
|
||||
|===
|
||||
| ID | 名称/描述
|
||||
|
||||
| core | ks-core 核心组件
|
||||
| iam | 多租户管理
|
||||
| network | KubeSphere 网络，用于 IPPool 管理和 NetworkPolicy 管理
|
||||
| devops | DevOps 系统
|
||||
| storage-utils | KubeSphere 存储
|
||||
| tower | KubeSphere 多集群代理连接
|
||||
| kubefed | 联邦集群应用管理
|
||||
| whizard-monitoring | WhizardTelemetry 监控
|
||||
| whizard-notification | WhizardTelemetry 通知管理
|
||||
| whizard-alerting | WhizardTelemetry 告警管理
|
||||
| whizard-events | WhizardTelemetry 事件管理
|
||||
| whizard-auditing | WhizardTelemetry 审计管理
|
||||
| whizard-logging | WhizardTelemetry 日志管理
|
||||
| whizard-telemetry-ruler | WhizardTelemetry 事件告警
|
||||
| whizard-telemetry | WhizardTelemetry 平台服务
|
||||
| vector | WhizardTelemetry 数据流水线
|
||||
| metrics-server | Metrics Server，集群核心监控数据的聚合器
|
||||
| opensearch | 用于日志存储
|
||||
| kubeedge | KubeEdge 边缘计算框架
|
||||
| springcloud | Spring Cloud，管理微服务、微服务配置和微服务网关
|
||||
| servicemesh | KubeSphere 服务网格
|
||||
| application | KubeSphere 应用商店管理
|
||||
| dmp | RadonDB DMP，云原生数据库管理平台
|
||||
| gateway | KubeSphere 网关
|
||||
|===
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
---
|
||||
title: "升级 KubeSphere"
|
||||
linkTitle: "升级 KubeSphere"
|
||||
keywords: "Kubernetes, KubeSphere, 升级"
|
||||
description: "介绍如何升级 KubeSphere。"
|
||||
layout: "second"
|
||||
weight: 03
|
||||
---
|
||||
|
||||
|
||||
|
||||
本节介绍如何升级{ks_product_left}。
|
||||
|
|
@ -1,12 +1,12 @@
|
|||
---
|
||||
title: "仅卸载 KubeSphere"
|
||||
linkTitle: "仅卸载 KubeSphere"
|
||||
keywords: "Kubernetes, KubeSphere, 仅卸载 KubeSphere"
|
||||
description: "介绍如何卸载 KubeSphere。"
|
||||
keywords: "Kubernetes, {ks_product}, 仅卸载{ks_product_left}"
|
||||
description: "介绍如何卸载{ks_product_left}。"
|
||||
weight: 01
|
||||
---
|
||||
|
||||
本节介绍如何卸载{ks_product_left}。当前集群中运行的 Kubernetes 将不会被卸载。
|
||||
本节介绍如何卸载 KubeSphere Core，即卸载{ks_product_left}。当前集群中运⾏的 Kubernetes 将不会被卸载。
|
||||
|
||||
// Warning
|
||||
include::../../../../_ks_components/admonitions/warning.adoc[]
|
||||
|
|
@ -22,103 +22,11 @@ include::../../../../_ks_components/admonitions/admonEnd.adoc[]
|
|||
|
||||
include::../../../_custom/installationAndUpgrade/installationAndUpgrade-prer-backUpData.adoc[]
|
||||
|
||||
== 卸载扩展组件
|
||||
== 操作步骤
|
||||
|
||||
. 登录任意集群节点，执行以下命令查看集群中所有的扩展组件。
|
||||
+
|
||||
[,bash]
|
||||
----
|
||||
kubectl get installplan
|
||||
----
|
||||
|
||||
. 卸载指定扩展组件或所有扩展组件。
|
||||
|
||||
|
||||
* 卸载指定扩展组件。
|
||||
+
|
||||
--
|
||||
[,bash]
|
||||
----
|
||||
kubectl delete installplan {InstallPlan Name}
|
||||
----
|
||||
[.admon.note,cols="a"]
|
||||
|===
|
||||
|说明
|
||||
|
||||
|
|
||||
可根据第一步的命令获取扩展组件的 `InstallPlan Name`。
|
||||
|===
|
||||
|
||||
如果显示如下信息，表明该扩展组件卸载成功。
|
||||
执行以下命令卸载{ks_product_left}。
|
||||
|
||||
[,bash]
|
||||
----
|
||||
installplan.kubesphere.io "{InstallPlan Name}" deleted
|
||||
helm -n kubesphere-system uninstall ks-core
|
||||
----
|
||||
--
|
||||
|
||||
* 卸载全部扩展组件。
|
||||
+
|
||||
--
|
||||
[,bash]
|
||||
----
|
||||
kubectl delete installplan --all
|
||||
----
|
||||
|
||||
输出信息应如下所示：
|
||||
|
||||
[,bash]
|
||||
----
|
||||
installplan.kubesphere.io "devops" deleted
|
||||
installplan.kubesphere.io "dmp" deleted
|
||||
installplan.kubesphere.io "gatekeeper" deleted
|
||||
installplan.kubesphere.io "gateway" deleted
|
||||
installplan.kubesphere.io "kubeedge" deleted
|
||||
installplan.kubesphere.io "kubefed" deleted
|
||||
installplan.kubesphere.io "metrics-server" deleted
|
||||
installplan.kubesphere.io "network" deleted
|
||||
installplan.kubesphere.io "openpitrix" deleted
|
||||
installplan.kubesphere.io "opensearch" deleted
|
||||
installplan.kubesphere.io "springcloud" deleted
|
||||
installplan.kubesphere.io "storage-utils" deleted
|
||||
installplan.kubesphere.io "tower" deleted
|
||||
installplan.kubesphere.io "vector" deleted
|
||||
installplan.kubesphere.io "whizard-alerting" deleted
|
||||
installplan.kubesphere.io "whizard-auditing" deleted
|
||||
installplan.kubesphere.io "whizard-events" deleted
|
||||
installplan.kubesphere.io "whizard-logging" deleted
|
||||
installplan.kubesphere.io "whizard-monitoring" deleted
|
||||
installplan.kubesphere.io "whizard-notification" deleted
|
||||
installplan.kubesphere.io "whizard-telemetry" deleted
|
||||
installplan.kubesphere.io "whizard-telemetry-ruler" deleted
|
||||
----
|
||||
|
||||
再次执行以下命令，如果显示 No resources found，表明所有扩展组件都已卸载。
|
||||
|
||||
[,bash]
|
||||
----
|
||||
kubectl get installplan
|
||||
----
|
||||
--
|
||||
|
||||
|
||||
== 卸载 ks-core
|
||||
|
||||
卸载 ks-core 之前，请确保集群中的扩展组件都已被卸载，即执行 `kubectl get installplan` 命令后显示 No resources found。
|
||||
|
||||
. 执行以下命令卸载 ks-core。
|
||||
+
|
||||
[,bash]
|
||||
----
|
||||
helm del -n kubesphere-system ks-core
|
||||
----
|
||||
|
||||
. 执行以下命令，如果返回结果为空（如下所示），表明{ks_product_both}卸载成功。
|
||||
+
|
||||
--
|
||||
[,bash]
|
||||
----
|
||||
root@xxx:~# helm list -n kubesphere-system
|
||||
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
|
||||
----
|
||||
--
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
title: "卸载 Kubernetes 和 KubeSphere"
|
||||
linkTitle: "卸载 Kubernetes 和 KubeSphere"
|
||||
keywords: "Kubernetes, KubeSphere, 卸载 Kubernetes 和 KubeSphere"
|
||||
description: "介绍如何卸载 Kubernetes 和 KubeSphere。"
|
||||
keywords: "Kubernetes, {ks_product}, 卸载 Kubernetes 和{ks_product_left}"
|
||||
description: "介绍如何卸载 Kubernetes 和{ks_product_left}。"
|
||||
weight: 02
|
||||
---
|
||||
|
||||
|
|
@ -26,14 +26,14 @@ include::../../../../_ks_components/admonitions/admonEnd.adoc[]
|
|||
|
||||
== 前提条件
|
||||
|
||||
* 您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅link:../../../03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere[安装 Kubernetes 和 KubeSphere 企业版]。
|
||||
* 您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅link:../../../03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere[安装 Kubernetes 和 KubeSphere]。
|
||||
+
|
||||
[.admon.note,cols="a"]
|
||||
|===
|
||||
|说明
|
||||
|
||||
|
|
||||
如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere 企业版] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，卸载过程可能会出现错误。
|
||||
如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，卸载过程可能会出现错误。
|
||||
|===
|
||||
|
||||
* {empty}
|
||||
|
|
@ -42,12 +42,12 @@ include::../../../_custom/installationAndUpgrade/installationAndUpgrade-prer-bac
|
|||
|
||||
== 操作步骤
|
||||
|
||||
// ifeval::["{file_output_type}" == "html"]
|
||||
// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[]
|
||||
// ifeval::["{file_output_type}" == "pdf"]
|
||||
// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[]
|
||||
// endif::[]
|
||||
|
||||
// ifeval::["{file_output_type}" == "pdf"]
|
||||
include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[]
|
||||
// ifeval::["{file_output_type}" == "html"]
|
||||
include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[]
|
||||
// endif::[]
|
||||
|
||||
+
|
||||
|
|
@ -59,18 +59,16 @@ include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-tra
|
|||
+
|
||||
--
|
||||
// Bash
|
||||
include::../../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
[,bash]
|
||||
----
|
||||
./kk delete cluster -f config-sample.yaml
|
||||
|
||||
----
|
||||
|
||||
如果显示如下信息，则表明卸载成功：
|
||||
|
||||
// Bash
|
||||
include::../../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
[,bash]
|
||||
----
|
||||
Pipeline[DeleteClusterPipeline] execute successful
|
||||
|
||||
----
|
||||
--
|
||||
|
|
|
|||
|
|
@ -21,22 +21,17 @@ include::../../../../_ks_components/admonitions/admonEnd.adoc[]
|
|||
|
||||
== 前提条件
|
||||
|
||||
* 您需要联系{ks_product_both}的服务支持团队获取{ks_product_left} v4.1.0 安装包。
|
||||
|
||||
// 如实施现场条件允许在线拉取公开仓库，具备在线安装条件，可联系 KubeSphere 产品团队获取在线安装文件及相关信息。
|
||||
|
||||
* 新增节点的操作系统和版本须为 Ubuntu 16.04、Ubuntu 18.04、Ubuntu 20.04、Ubuntu 22.04、Debian 9、Debian 10、CentOS 7、CentOS Stream、RHEL 7、RHEL 8、SLES 15 或 openSUSE Leap 15。多个集群节点的操作系统可以不同。关于其它操作系统和版本支持，请联系{ks_product_both}技术支持。
|
||||
|
||||
* 为确保集群具有足够的计算和存储资源，建议新增节点配置至少 8 个 CPU 核心，16 GB 内存和 200 GB 磁盘空间。除此之外，建议在每台集群节点的 **/var/lib/docker**（对于 Docker）或 **/var/lib/containerd**（对于 containerd） 目录额外挂载至少 200 GB 磁盘空间用于存储容器运行时数据。
|
||||
|
||||
* 如果添加控制平面节点，您需要提前为集群配置高可用性。如果您使用负载均衡器，请确保负载均衡器监听所有控制平面节点的 6443 端口。有关更多信息，请参阅link:../../../03-installation-and-upgrade/01-preparations/03-configure-high-availability/[配置高可用性]。
|
||||
|
||||
* 如果您的集群节点无法连接互联网，您还需要准备一台 Linux 服务器用于创建私有镜像服务，该服务器必须与{ks_product_both}集群节点网络连通并且在 **/mnt/registry** 目录挂载至少 100 GB 磁盘空间。
|
||||
|
||||
// * 如果您的集群节点无法连接互联网，您还需要准备一台 Linux 服务器用于创建私有镜像服务，该服务器必须与{ks_product_both}集群节点网络连通并且在 **/mnt/registry** 目录挂载至少 100 GB 磁盘空间。
|
||||
|
||||
:relfileprefix: ../../../
|
||||
|
||||
* 您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅xref:03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc[安装 Kubernetes 和 KubeSphere 企业版]。
|
||||
* 您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅xref:03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc[安装 Kubernetes 和 KubeSphere]。
|
||||
|
||||
:relfileprefix: ./
|
||||
|
||||
|
|
@ -46,20 +41,14 @@ include::../../../../_ks_components/admonitions/warning.adoc[]
|
|||
|
||||
* 添加节点过程中不支持在 **config-sample.yaml** 配置文件中修改原有的集群配置。
|
||||
|
||||
* 如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere 企业版] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，添加节点后集群可能会出现错误。
|
||||
* 如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，添加节点后集群可能会出现错误。
|
||||
include::../../../../_ks_components/admonitions/admonEnd.adoc[]
|
||||
--
|
||||
|
||||
|
||||
== 操作步骤
|
||||
|
||||
// ifeval::["{file_output_type}" == "html"]
|
||||
// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[]
|
||||
// endif::[]
|
||||
|
||||
// ifeval::["{file_output_type}" == "pdf"]
|
||||
include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[]
|
||||
// endif::[]
|
||||
include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[]
|
||||
|
||||
+
|
||||
include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-transferConfig.adoc[]
|
||||
|
|
@ -132,10 +121,9 @@ include::../../../_custom/installationAndUpgrade/installationAndUpgrade-code-add
|
|||
+
|
||||
--
|
||||
// Bash
|
||||
include::../../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
[,bash]
|
||||
----
|
||||
kubectl get node
|
||||
|
||||
----
|
||||
|
||||
如果显示新增节点的信息，则表明节点添加成功。
|
||||
|
|
|
|||
|
|
@ -30,13 +30,9 @@ include::../../../../_ks_components/admonitions/admonEnd.adoc[]
|
|||
|
||||
== 前提条件
|
||||
|
||||
* 您需要联系{ks_product_both}的服务支持团队获取{ks_product_left} v4.1.0 安装包。
|
||||
|
||||
// 如实施现场条件允许在线拉取公开仓库，具备在线安装条件，可联系 KubeSphere 产品团队获取在线安装文件及相关信息。
|
||||
|
||||
:relfileprefix: ../../../
|
||||
|
||||
* 您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅xref:03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc[安装 Kubernetes 和 KubeSphere 企业版]。
|
||||
您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅xref:03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc[安装 Kubernetes 和 KubeSphere]。
|
||||
|
||||
:relfileprefix: ./
|
||||
|
||||
|
|
@ -44,7 +40,7 @@ include::../../../../_ks_components/admonitions/admonEnd.adoc[]
|
|||
// Warning
|
||||
include::../../../../_ks_components/admonitions/warning.adoc[]
|
||||
|
||||
如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere 企业版] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，删除节点后集群可能会出现错误。
|
||||
如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，删除节点后集群可能会出现错误。
|
||||
|
||||
include::../../../../_ks_components/admonitions/admonEnd.adoc[]
|
||||
--
|
||||
|
|
@ -52,22 +48,21 @@ include::../../../../_ks_components/admonitions/admonEnd.adoc[]
|
|||
|
||||
== 操作步骤
|
||||
|
||||
// ifeval::["{file_output_type}" == "html"]
|
||||
// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[]
|
||||
// ifeval::["{file_output_type}" == "pdf"]
|
||||
// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[]
|
||||
// endif::[]
|
||||
|
||||
// ifeval::["{file_output_type}" == "pdf"]
|
||||
include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-decompressInstallationPackage_new.adoc[]
|
||||
// ifeval::["{file_output_type}" == "html"]
|
||||
include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-downloadKubekey.adoc[]
|
||||
// endif::[]
|
||||
|
||||
. 执行以下命令查看需要删除的节点的名称：
|
||||
+
|
||||
--
|
||||
// Bash
|
||||
include::../../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
[,bash]
|
||||
----
|
||||
kubectl get node
|
||||
|
||||
----
|
||||
--
|
||||
|
||||
|
|
@ -75,10 +70,9 @@ kubectl get node
|
|||
+
|
||||
--
|
||||
// Bash
|
||||
include::../../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
[,bash]
|
||||
----
|
||||
kubectl drain <node name>
|
||||
|
||||
----
|
||||
--
|
||||
|
||||
|
|
@ -92,10 +86,9 @@ include::../../../_custom/installationAndUpgrade/installationAndUpgrade-oper-tra
|
|||
+
|
||||
--
|
||||
// Bash
|
||||
include::../../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
[,bash]
|
||||
----
|
||||
./kk delete node <node name> -f config-sample.yaml
|
||||
|
||||
----
|
||||
--
|
||||
|
||||
|
|
@ -103,10 +96,9 @@ include::../../../../_ks_components/code/bash.adoc[]
|
|||
+
|
||||
--
|
||||
// Bash
|
||||
include::../../../../_ks_components/code/bash.adoc[]
|
||||
|
||||
[,bash]
|
||||
----
|
||||
kubectl get node
|
||||
|
||||
----
|
||||
|
||||
如果没有显示已删除节点的信息，则表明节点删除成功。
|
||||
|
|
|
|||
|
|
@ -8,36 +8,14 @@ weight: 03
|
|||
icon: "/images/docs/common/docs.svg"
|
||||
---
|
||||
|
||||
// 导出说明：此文档用于离线交付 pdf 版本，不可与 03-install-and-uninstall 同时存在。
|
||||
// 基于 v4.1.1 安装指南修改
|
||||
|
||||
本节介绍如何安装、升级和卸载{ks_product_left}，以及如何添加和删除{ks_product_both}集群节点。
|
||||
本节介绍如何安装和卸载{ks_product_left}，以及如何添加和删除{ks_product_both}集群节点。
|
||||
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
== 产品版本
|
||||
|
||||
本文档适用于{ks_product_left} v4.1.0 版本。
|
||||
|
||||
== 读者对象
|
||||
|
||||
本文档主要适用于以下读者：
|
||||
|
||||
* {ks_product_right}用户
|
||||
|
||||
* 交付工程师
|
||||
|
||||
* 运维工程师
|
||||
|
||||
* 售后工程师
|
||||
|
||||
|
||||
== 修订记录
|
||||
|
||||
[%header,cols="1a,1a,3a"]
|
||||
[.admon.note,cols="a"]
|
||||
|===
|
||||
|文档版本 |发布日期 |修改说明
|
||||
|说明
|
||||
|
||||
|01
|
||||
|{pdf_releaseDate}
|
||||
|第一次正式发布。
|
||||
|
|
||||
暂不支持从{ks_product_left} v3.x 升级到 v4.1。
|
||||
|===
|
||||
endif::[]
|
||||
|
|
|
|||
|
|
@ -4,9 +4,9 @@ linkTitle: "平台介绍"
|
|||
weight: 01
|
||||
---
|
||||
|
||||
{ks_product_right}采用细粒度权限控制机制。根据用户角色不同，{ks_product_right} Web 控制台也有所不同。
|
||||
{ks_product_right}采用细粒度权限控制机制。根据用户角色不同，{ks_product} Web 控制台也有所不同。
|
||||
|
||||
本节以具有 platform-admin 角色的用户视角，介绍{ks_product_both} Web 控制台的模块及功能。
|
||||
本节以具有 platform-admin 角色的用户视角，介绍{ks_product_left} Web 控制台的模块及功能。
|
||||
|
||||
|
||||
[%header,cols="1a,4a"]
|
||||
|
|
@ -14,19 +14,19 @@ weight: 01
|
|||
|模块 |功能
|
||||
|
||||
|扩展市场
|
||||
|扩展组件的商店，支持订阅、安装、卸载、配置、升级扩展组件等。
|
||||
|扩展组件的商店，支持安装、卸载、配置、升级扩展组件等。
|
||||
|
||||
|应用商店
|
||||
|应用商店提供了基于 Helm Chart 的应用模板，支持搜索、安装应用到某一项目。
|
||||
|
||||
.5+|工作台
|
||||
|集群管理：从基础设施视角管理资源，支持添加成员集群、编辑集群信息、更新 kubeconfig、移除成员集群等操作。
|
||||
|集群管理：从基础设施视角管理资源，支持添加成员集群、管理集群资源、更新 kubeconfig、移除成员集群等操作。
|
||||
|
||||
|企业空间管理：提供跨集群共享资源的能力，支持创建企业空间、编辑企业空间信息、删除企业空间等操作。
|
||||
|企业空间管理：提供跨集群共享资源的能力，支持创建企业空间、管理企业空间和项目资源、删除企业空间等操作。
|
||||
|
||||
|用户和角色管理：创建用户/平台角色、编辑用户/平台角色信息、启用和禁用用户、修改用户角色、编辑平台角色信息&权限，删除用户/平台角色。
|
||||
|
||||
|扩展中心：管理已订阅的扩展组件，如安装、卸载、配置、禁用、升级扩展组件等。
|
||||
|扩展中心：管理扩展组件，如安装、卸载、配置、禁用、升级扩展组件等。
|
||||
|
||||
|快捷访问：支持对集群、企业空间、项目等资源的快速访问。
|
||||
|
||||
|
|
@ -34,7 +34,7 @@ weight: 01
|
|||
|平台级、多集群和多租户级扩展组件的全局访问入口，支持快捷访问已安装的扩展组件。
|
||||
|
||||
|平台设置
|
||||
|查看并自定义平台信息，管理许可证。
|
||||
|查看平台信息。
|
||||
|===
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,62 +1,19 @@
|
|||
---
|
||||
title: "查看和定制平台信息"
|
||||
linkTitle: "查看和定制平台信息"
|
||||
keywords: "Kubernetes, KubeSphere, 平台设置, 平台信息, 查看和定制平台信息"
|
||||
description: "介绍如何查看和定制平台信息。"
|
||||
title: "查看平台信息"
|
||||
linkTitle: "查看平台信息"
|
||||
keywords: "Kubernetes, KubeSphere, 平台设置, 平台信息, 查看平台信息"
|
||||
description: "介绍如何查看平台信息。"
|
||||
weight: 01
|
||||
---
|
||||
|
||||
|
||||
:ks_navigation: **平台信息**
|
||||
:ks_permission: **平台设置管理**
|
||||
本节介绍如何查看{ks_product_left} Web 控制台的信息。
|
||||
|
||||
|
||||
本节介绍如何查看和定制{ks_product_left} Web 控制台的信息。
|
||||
|
||||
== 前提条件
|
||||
|
||||
:relfileprefix: ../../../
|
||||
|
||||
include::../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[]
|
||||
|
||||
:relfileprefix: ./
|
||||
|
||||
== 操作步骤
|
||||
|
||||
include::../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[]
|
||||
. 登录{ks_product_left} Web 控制台。
|
||||
|
||||
. 在页面右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。
|
||||
|
||||
+
|
||||
|
||||
include::../../../../_ks_components/oper-navigate.adoc[]
|
||||
+
|
||||
--
|
||||
**平台信息**页面显示平台的访问地址、标题、描述、标识、浏览器图标和登录页面背景图片。
|
||||
--
|
||||
|
||||
. 在页面右上角点击**自定义平台信息**。
|
||||
|
||||
. 在**自定义平台信息**对话框设置平台的信息，然后点击**确定**。
|
||||
+
|
||||
--
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|
||||
|平台标题
|
||||
|平台的名称。平台标题可包含任意字符，最长 63 个字符。
|
||||
|
||||
|平台描述
|
||||
|描述可包含任意字符，最长 256 个字符。
|
||||
|
||||
|平台标识
|
||||
|Web 控制台界面上方显示的标识。图片格式可以为 SVG、PNG 或 JPG，图片文件大小不能超过 2 MB，推荐的图片分辨率为 200 x 40 像素。
|
||||
|
||||
|浏览器图标
|
||||
|浏览器页签的图标。图片格式可以为 ICO、SVG、PNG 或 JPG，图片文件大小不能超过 2 MB，推荐图片分辨率为 40 x 40 像素，推荐长宽比为 1:1。
|
||||
|
||||
|登录页面背景图片
|
||||
|平台登录页面的背景图片。图片格式可以为 SVG、PNG 或 JPG，图片文件大小不能超过 2 MB，推荐的图片分辨率为 1920 x 1080 像素。
|
||||
|===
|
||||
--
|
||||
**平台信息**页面显示平台的访问地址、标识、标题和描述。
|
||||
|
|
|
|||
|
|
@ -1,118 +0,0 @@
|
|||
---
|
||||
title: "查看许可证信息"
|
||||
linkTitle: "查看许可证信息"
|
||||
keywords: "Kubernetes, KubeSphere, 平台设置, 许可证, 查看许可证信息"
|
||||
description: "介绍如何查看许可证信息。"
|
||||
weight: 01
|
||||
---
|
||||
|
||||
:ks_navigation: **许可证**
|
||||
:ks_permission: **平台设置管理**
|
||||
|
||||
|
||||
本节介绍如何查看许可证信息。
|
||||
|
||||
|
||||
== 前提条件
|
||||
|
||||
|
||||
:relfileprefix: ../../../../
|
||||
|
||||
include::../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[]
|
||||
|
||||
:relfileprefix: ./
|
||||
|
||||
|
||||
== 操作步骤
|
||||
|
||||
include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[]
|
||||
|
||||
. 在页面右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。
|
||||
|
||||
+
|
||||
|
||||
include::../../../../../_ks_components/oper-navigate.adoc[]
|
||||
+
|
||||
. 在**许可证信息**页签，查看{ks_product_both}和已安装扩展组件的许可证。
|
||||
+
|
||||
====
|
||||
* {ks_product_both}许可
|
||||
+
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|
||||
|授权组织
|
||||
|被授权使用{ks_product_both}的组织。
|
||||
|
||||
|授权状态
|
||||
|
|
||||
* **未授权**：未获得{ks_product_both}的许可证。
|
||||
* **授权已过期**：{ks_product_left}的许可证已过期。
|
||||
* **授权数量不足**：当前集群规模超出被许可使用{ks_product_both}的集群规模。
|
||||
* **已授权**：{ks_product_left}授权正常。
|
||||
|
||||
|维保状态
|
||||
|
|
||||
* **无维保**：不享受维保服务。
|
||||
* **维保过期**：维保服务已过期。
|
||||
* **维保中**：在维保服务期内。
|
||||
|
||||
|集群 ID
|
||||
|当前集群 ID，用于判断集群是否享有授权。
|
||||
|
||||
|授权类型
|
||||
|**未输入激活码**、**订阅**或**永久授权**。
|
||||
|
||||
|授权用量
|
||||
|显示当前集群规模以及被许可使用{ks_product_both}的集群规模，单位为**核**。
|
||||
|
||||
|生效时间
|
||||
|许可证的生效时间。
|
||||
|
||||
|截止时间
|
||||
|许可证的过期时间。
|
||||
|===
|
||||
|
||||
* 扩展组件许可
|
||||
+
|
||||
--
|
||||
显示当前平台已安装的扩展组件的许可证。
|
||||
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|
||||
|名称
|
||||
|扩展组件的名称。
|
||||
|
||||
|授权状态
|
||||
|
|
||||
* **未授权**：未获得{ks_product_both}的许可证。
|
||||
* **授权已过期**：{ks_product_left}的许可证已过期。
|
||||
* **授权数量不足**：当前集群规模超出被许可使用{ks_product_both}的集群规模。
|
||||
* **已授权**：{ks_product_left}授权正常。
|
||||
|
||||
|授权类型
|
||||
|**未输入激活码**、**订阅**或**永久授权**。
|
||||
|
||||
|授权单位
|
||||
|CPU 或 vCPU。
|
||||
|
||||
|授权用量
|
||||
|显示当前集群规模以及被许可使用{ks_product_both}的集群规模，单位为**核**。
|
||||
|
||||
|生效时间
|
||||
|许可证的生效时间。
|
||||
|
||||
|截止时间
|
||||
|许可证的过期时间。
|
||||
|===
|
||||
|
||||
* 在列表上方点击搜索框并输入组件名称，可搜索组件的许可证。
|
||||
|
||||
include::../../../../../_ks_components/oper-refreshListData.adoc[]
|
||||
|
||||
include::../../../../../_ks_components/oper-customizeColumns.adoc[]
|
||||
--
|
||||
====
|
||||
|
|
@ -1,48 +0,0 @@
|
|||
---
|
||||
title: "添加许可证"
|
||||
linkTitle: "添加许可证"
|
||||
keywords: "Kubernetes, KubeSphere, 平台设置, 许可证, 管理许可证"
|
||||
description: "介绍如何管理许可证。"
|
||||
weight: 03
|
||||
---
|
||||
|
||||
:ks_navigation: **许可证**
|
||||
:ks_permission: **平台设置管理**
|
||||
|
||||
|
||||
本节介绍如何添加许可证。
|
||||
|
||||
|
||||
== 前提条件
|
||||
|
||||
|
||||
:relfileprefix: ../../../../
|
||||
|
||||
include::../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[]
|
||||
|
||||
:relfileprefix: ./
|
||||
|
||||
|
||||
== 操作步骤
|
||||
|
||||
include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[]
|
||||
|
||||
. 在页面右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。
|
||||
|
||||
+
|
||||
|
||||
include::../../../../../_ks_components/oper-navigate.adoc[]
|
||||
|
||||
. 点击**许可证管理**页签，查看已添加的许可证信息。
|
||||
|
||||
. 点击**添加许可证**，输入激活码，点击**确定**完成添加。
|
||||
+
|
||||
--
|
||||
* 许可证添加完成后将显示在许可证管理列表中。
|
||||
|
||||
* 在列表上方点击搜索框并输入组件名称，可搜索组件的许可证。
|
||||
|
||||
include::../../../../../_ks_components/oper-refreshListData.adoc[]
|
||||
|
||||
include::../../../../../_ks_components/oper-customizeColumns.adoc[]
|
||||
--
|
||||
|
|
@ -1,47 +0,0 @@
|
|||
---
|
||||
title: "删除许可证"
|
||||
linkTitle: "删除许可证"
|
||||
keywords: "Kubernetes, KubeSphere, 平台设置, 许可证, 管理许可证"
|
||||
description: "介绍如何管理许可证。"
|
||||
weight: 05
|
||||
---
|
||||
|
||||
:ks_navigation: **许可证**
|
||||
:ks_permission: **平台设置管理**
|
||||
|
||||
|
||||
本节介绍如何删除许可证。
|
||||
|
||||
[.admon.warning,cols="a"]
|
||||
|===
|
||||
|警告
|
||||
|
||||
|许可证被删除后，您将丢失该组件的授权，请谨慎执行此操作。
|
||||
|
||||
|===
|
||||
|
||||
== 前提条件
|
||||
|
||||
|
||||
:relfileprefix: ../../../../
|
||||
|
||||
include::../../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[]
|
||||
|
||||
:relfileprefix: ./
|
||||
|
||||
|
||||
== 操作步骤
|
||||
|
||||
include::../../../../_custom/platformManagement/platformManagement-oper-logIn.adoc[]
|
||||
|
||||
. 在页面右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]进入**平台设置**页面。
|
||||
|
||||
+
|
||||
|
||||
include::../../../../../_ks_components/oper-navigate.adoc[]
|
||||
|
||||
. 点击**许可证管理**页签，查看已添加的许可证信息。
|
||||
|
||||
. 在需要删除的许可证右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]。
|
||||
|
||||
. 在**删除许可证**对话框，输入组件的名称，然后点击**确定**。
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
---
|
||||
title: "许可证 FAQ"
|
||||
linkTitle: "许可证 FAQ"
|
||||
weight: 07
|
||||
---
|
||||
|
||||
== 添加 license 时报错
|
||||
|
||||
问题描述：添加许可证时报错 `admission webhook "validator.config.kubesphere.io" denied the request: license for whizard-telemetry already exist`
|
||||
|
||||
原因：添加 license 或者 license bundle 时，其中的 whizard-telemetry（WhizardTelemetry 平台服务） 的 license 已在{ks_product_both}平台中存在。
|
||||
|
||||
解决办法：删除原有的 whizard-telemetry 许可证，再添加新的许可证。
|
||||
|
||||
[.admon.attention,cols="a"]
|
||||
|===
|
||||
|注意
|
||||
|
||||
|
|
||||
license 过期后，也要先删除过期的 license，再添加新的 license。
|
||||
|===
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
---
|
||||
title: "许可证"
|
||||
linkTitle: "许可证"
|
||||
keywords: "Kubernetes, KubeSphere, 平台设置, 许可证"
|
||||
description: "介绍如何管理 KubeSphere 平台和扩展组件的许可证。"
|
||||
layout: "second"
|
||||
weight: 02
|
||||
---
|
||||
|
||||
|
||||
本节介绍如何查看及管理{ks_product_both}平台和扩展组件的许可证。
|
||||
|
||||
{ks_product_right}许可证，用于激活{ks_product_both}平台。如果您需要购买或更新平台许可证，请联系 KubeSphere 技术支持。
|
||||
|
||||
扩展组件许可证，用于激活某些需购买的扩展组件，此处仅展示扩展组件的授权信息。
|
||||
有关扩展组件许可的更多信息，请访问扩展中心的组件详情页，联系扩展组件供应商获取支持。
|
||||
|
|
@ -0,0 +1,160 @@
|
|||
---
|
||||
title: "配置外部身份验证"
|
||||
keywords: "Kubernetes, KubeSphere, 第三方认证"
|
||||
description: "了解如何在 KubeSphere 上设置外部身份验证。"
|
||||
weight: 01
|
||||
---
|
||||
|
||||
:ks_navigation: **配置 > 保密字典**
|
||||
|
||||
{ks_product_right}支持设置外部身份验证，平台管理员可以通过 secret（保密字典）配置身份提供者。
|
||||
|
||||
配置外部身份提供者后，允许使用 LDAP、CAS、GitHub、阿里云 IDaas、或 OpenID Connect 的用户名和密码登录{ks_product_left} Web 控制台。
|
||||
|
||||
== 操作步骤
|
||||
|
||||
. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。
|
||||
|
||||
. 进入企业空间 **system-workspace** 下的项目 **kubesphere-system**。
|
||||
|
||||
+
|
||||
|
||||
include::../../../../../_ks_components/oper-navigate.adoc[]
|
||||
|
||||
+
|
||||
|
||||
include::../../../../../_ks_components/oper-clickCreate.adoc[]
|
||||
|
||||
. 在**创建保密字典**对话框，点击右上角的**编辑 YAML** 开关，使用 yaml 创建保密字典。
|
||||
|
||||
. 按照以下示例及配置说明修改 yaml 文件，配置完成后，点击**创建**。
|
||||
|
||||
. 登出{ks_product_left} Web 控制台，在登录页面，根据配置的外部身份验证类型，输入 LDAP、CAS、GitHub、阿里云 IDaas、或 OpenID Connect 的用户名和密码登录。
|
||||
|
||||
[.admon.note,cols="a"]
|
||||
|===
|
||||
|说明
|
||||
|
||||
|
|
||||
多集群环境中，只需要在主集群中进行配置。
|
||||
|===
|
||||
|
||||
== OpenLDAP 示例 yaml
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
apiVersion: v1
|
||||
kind: Secret
|
||||
metadata:
|
||||
namespace: kubesphere-system
|
||||
name: identity-provider-ldap
|
||||
labels:
|
||||
config.kubesphere.io/type: identityprovider
|
||||
stringData:
|
||||
configuration.yaml: |
|
||||
name: openldap
|
||||
type: LDAPIdentityProvider
|
||||
mappingMethod: auto
|
||||
provider:
|
||||
host: "192.168.0.2:389"
|
||||
managerDN: uid=root,cn=users,dc=nas
|
||||
managerPassword: "********"
|
||||
userSearchBase: cn=users,dc=nas
|
||||
loginAttribute: uid
|
||||
mailAttribute: mail
|
||||
type: config.kubesphere.io/identityprovider
|
||||
----
|
||||
|
||||
[.admon.attention,cols="a"]
|
||||
|===
|
||||
|注意
|
||||
|
||||
|
|
||||
- secret 必须创建在 `kubeshere-system` 项目中。
|
||||
|
||||
- secret 必须包含 type。
|
||||
+
|
||||
`type: config.kubesphere.io/identityprovider`。
|
||||
|
||||
- secret 必须包含 label。
|
||||
+
|
||||
`config.kubesphere.io/type: identityprovider`。
|
||||
|===
|
||||
|
||||
== 配置说明
|
||||
|
||||
上述示例的 `stringData:configuration.yaml` 参数中：
|
||||
|
||||
- name: 指定外部身份验证的名称，必须唯一，否则会创建失败。
|
||||
|
||||
- type: 指定外部身份验证的类型，支持以下类型：
|
||||
+
|
||||
--
|
||||
- LDAP: `LDAPIdentityProvider`
|
||||
|
||||
- CAS: `CASIdentityProvider`
|
||||
|
||||
- GitHub: `GitHubIdentityProvider`
|
||||
|
||||
- 阿里云 IDaas: `AliyunIDaaSProvider`
|
||||
|
||||
- OpenID Connect: `OIDCIdentityProvider`
|
||||
--
|
||||
|
||||
- mappingMethod: 指定外部身份用户与{ks_product_both}用户的关联方式。
|
||||
+
|
||||
--
|
||||
- auto: 自动创建相同名称的{ks_product_both}用户，当平台中已存在名称时会创建失败。
|
||||
|
||||
- manual: 登录后创建一个任意名称的新用户。
|
||||
|
||||
- lookup: 自动关联已存在的具有相同名称的{ks_product_both}用户，如果不存在该名称的用户，则创建失败。
|
||||
--
|
||||
|
||||
- provider: 外部身份验证的具体参数。以下是不同身份验证类型的 provider 参数示例。
|
||||
+
|
||||
--
|
||||
- LDAPIdentityProvider
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
host: 192.168.0.2:389
|
||||
managerDN: uid=root,cn=users,dc=nas
|
||||
managerPassword: "********"
|
||||
userSearchBase: cn=users,dc=nas
|
||||
loginAttribute: uid
|
||||
mailAttribute: mail
|
||||
----
|
||||
|
||||
|
||||
- CASIdentityProvider
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
redirectURL: "https://ks-console:30880/oauth/redirect/cas"
|
||||
casServerURL: "https://cas.example.org/cas"
|
||||
insecureSkipVerify: true
|
||||
----
|
||||
|
||||
- OIDCIdentityProvider
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
clientID: '********'
|
||||
clientSecret: '********'
|
||||
issuer: https://accounts.google.com
|
||||
redirectURL: 'https://ks-console/oauth/redirect/google'
|
||||
----
|
||||
|
||||
- GitHubIdentityProvider
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
clientID: '******'
|
||||
clientSecret: '******'
|
||||
redirectURL: 'https://ks-console/oauth/redirect/github'
|
||||
----
|
||||
|
||||
阿里云 IDaaS 身份提供者的配置方法，请参阅link:https://www.alibabacloud.com/help/zh/idaas/[阿里云 IDaaS 文档]。
|
||||
|
||||
--
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: "外部身份验证"
|
||||
weight: 03
|
||||
---
|
||||
|
||||
本节演示如何在{ks_product_both}上配置第三方身份验证。
|
||||
|
||||
|
|
@ -6,4 +6,4 @@ layout: "second"
|
|||
---
|
||||
|
||||
|
||||
本节介绍如何管理{ks_product_left} Web 控制台的基本信息以及许可证。
|
||||
本节介绍如何管理{ks_product_left} Web 控制台的基本信息。
|
||||
|
|
|
|||
|
|
@ -9,33 +9,3 @@ icon: "/images/docs/common/docs.svg"
|
|||
---
|
||||
|
||||
本节介绍{ks_product_both}各模块的功能，以及如何对该平台进行设置。
|
||||
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
== 产品版本
|
||||
|
||||
本文档适用于{ks_product_left} v4.1.0 版本。
|
||||
|
||||
== 读者对象
|
||||
|
||||
本文档主要适用于以下读者：
|
||||
|
||||
* {ks_product_right}用户
|
||||
|
||||
* 交付工程师
|
||||
|
||||
* 运维工程师
|
||||
|
||||
* 售后工程师
|
||||
|
||||
|
||||
== 修订记录
|
||||
|
||||
[%header,cols="1a,1a,3a"]
|
||||
|===
|
||||
|文档版本 |发布日期 |修改说明
|
||||
|
||||
|01
|
||||
|{pdf_releaseDate}
|
||||
|第一次正式发布。
|
||||
|===
|
||||
endif::[]
|
||||
|
|
|
|||
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
title: "重置用户密码"
|
||||
linkTitle: "重置用户密码"
|
||||
keywords: "Kubernetes, {ks_product}, 访问控制, 用户, 重置密码"
|
||||
description: "介绍如何重置用户密码。"
|
||||
weight: 07
|
||||
---
|
||||
|
||||
本节介绍如何重置用户密码。
|
||||
|
||||
若普通用户忘记密码，无法登录{ks_product_left} Web 控制台，请参阅link:../06-change-the-password-of-a-user[此文档]，由管理员修改用户密码即可。
|
||||
|
||||
若平台管理员忘记密码，需在 host 集群执行以下命令修改指定帐户的密码。
|
||||
|
||||
[,bash]
|
||||
----
|
||||
kubectl patch users <USERNAME> -p '{"spec":{"password":"<YOURPASSWORD>"}}' --type='merge' && kubectl annotate users <USERNAME> iam.kubesphere.io/password-encrypted-
|
||||
----
|
||||
|
||||
[.admon.note,cols="a"]
|
||||
|===
|
||||
|说明
|
||||
|
||||
|
|
||||
请将命令中的 <USERNAME> 修改为实际的用户名，将 <YOURPASSWORD> 修改为实际的新密码。
|
||||
|===
|
||||
|
||||
[.admon.attention,cols="a"]
|
||||
|===
|
||||
|注意
|
||||
|
||||
|
|
||||
新密码 <YOURPASSWORD> 必须符合密码要求。密码必须包含至少一个数字、一个小写字母、一个大写字母和一个特殊字符（~!@#$%^&*()-_=+\|[{}];:'",<.>/? 或空格），长度为 8 到 64 个字符。
|
||||
|===
|
||||
|
||||
示例：
|
||||
|
||||
[,bash]
|
||||
----
|
||||
kubectl patch users admin -p '{"spec":{"password":"P@88w0rd"}}' --type='merge' && kubectl annotate users admin iam.kubesphere.io/password-encrypted-
|
||||
----
|
||||
|
|
@ -1,57 +0,0 @@
|
|||
---
|
||||
title: "开启和关闭二次认证"
|
||||
linkTitle: "开启和关闭二次认证"
|
||||
weight: 07
|
||||
---
|
||||
|
||||
本节介绍如何为当前用户开启和关闭二次认证。
|
||||
|
||||
开启二次认证后，用户登录时，输入账号和密码之后，还必须输入身份认证器生成的动态认证口令。借助二次认证，用户通过密码和手机为账户提供双重保护。
|
||||
|
||||
|
||||
== 前提条件
|
||||
|
||||
已获取{ks_product_left} Web 控制台的用户名和密码。
|
||||
|
||||
|
||||
== 开启二次认证
|
||||
|
||||
. 登录{ks_product_left} Web 控制台。
|
||||
|
||||
. 在页面右上角点击当前用户名，然后在下拉列表中选择**用户设置**。
|
||||
|
||||
. 在**二次认证**页签点击**开启二次认证**。
|
||||
|
||||
. 在手机上的各大应用市场搜索关键词 “Authenticator” 或 “身份认证器”，下载身份认证器 App。推荐使用 Google Authenticator。安装完成后，在{ks_product_left} Web 控制台点击**下一步**。
|
||||
|
||||
. 打开身份认证器 App，点击“扫描二维码”扫描右侧二维码。扫描完成后，在{ks_product_left} Web 控制台点击**下一步**。
|
||||
|
||||
. 输入身份认证器 App 生成的动态认证码，点击**认证并开启**开启二次认证。
|
||||
+
|
||||
--
|
||||
|
||||
至此，二次认证开启完成。再次登录{ks_product_left} Web 控制台时，输入账号和密码之后，还必须输入身份认证器 App 生成的动态认证码。
|
||||
|
||||
image:/images/ks-qkcp/zh/v4.1/enable-two-factor-authentication.png[ enable-two-factor-authentication,50%]
|
||||
--
|
||||
|
||||
== 关闭二次认证
|
||||
|
||||
. 登录{ks_product_left} Web 控制台。
|
||||
|
||||
. 在页面右上角点击当前用户名，然后在下拉列表中选择**用户设置**。
|
||||
|
||||
. 在**二次认证**页签点击**关闭二次认证**。
|
||||
|
||||
. 在**关闭二次认证**对话框，输入身份认证器 App 生成的动态认证码，然后点击**确定**。
|
||||
+
|
||||
image:/images/ks-qkcp/zh/v4.1/disable-two-factor-authentication.png[ disable-two-factor-authentication,100%]
|
||||
|
||||
=== 无法获取动态口令
|
||||
|
||||
若无法获取二次认证动态口令，导致无法登录，可联系管理员执行以下命令关闭二次认证。
|
||||
|
||||
[,bash]
|
||||
----
|
||||
kubectl annotate user <USERNAME> iam.kubesphere.io/totp-auth-key-ref-
|
||||
----
|
||||
|
|
@ -17,48 +17,8 @@ KubeSphere 中的资源被划分为平台、企业空间、集群、项目四个
|
|||
|
||||
本节介绍如何在{ks_product_both}平台控制访问权限，包括用户和平台角色的管理。
|
||||
|
||||
ifeval::["{file_output_type}" == "html"]
|
||||
有关集群角色的更多信息，请参阅link:../07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。
|
||||
|
||||
有关企业空间角色的更多信息，请参阅link:../08-workspace-management/06-workspace-settings/04-workspace-roles/[企业空间角色]。
|
||||
|
||||
有关项目角色的更多信息，请参阅link:../09-project-management/06-project-settings/02-project-roles/[项目角色]。
|
||||
endif::[]
|
||||
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
有关集群角色的更多信息，请参阅《{ks_product_right}集群管理指南》的“集群角色”章节。
|
||||
|
||||
有关企业空间角色的更多信息，请参阅《{ks_product_right}企业空间管理指南》的“企业空间角色”章节。
|
||||
|
||||
有关项目角色的更多信息，请参阅《{ks_product_right}项目管理指南》的“项目角色”章节。
|
||||
endif::[]
|
||||
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
== 产品版本
|
||||
|
||||
本文档适用于{ks_product_left} v4.1.0 版本。
|
||||
|
||||
== 读者对象
|
||||
|
||||
本文档主要适用于以下读者：
|
||||
|
||||
* {ks_product_right}用户
|
||||
|
||||
* 交付工程师
|
||||
|
||||
* 运维工程师
|
||||
|
||||
* 售后工程师
|
||||
|
||||
|
||||
== 修订记录
|
||||
|
||||
[%header,cols="1a,1a,3a"]
|
||||
|===
|
||||
|文档版本 |发布日期 |修改说明
|
||||
|
||||
|01
|
||||
|{pdf_releaseDate}
|
||||
|第一次正式发布。
|
||||
|===
|
||||
endif::[]
|
||||
|
|
|
|||
|
|
@ -1,39 +0,0 @@
|
|||
---
|
||||
title: "订阅扩展组件"
|
||||
linkTitle: "订阅扩展组件"
|
||||
keywords: "Kubernetes, KubeSphere,订阅，组件，KubeSphere Cloud,云账号"
|
||||
description: "介绍如何订阅扩展组件。"
|
||||
weight: 01
|
||||
---
|
||||
|
||||
本节介绍如何订阅扩展组件。
|
||||
|
||||
在安装组件之前，您需要使用 KubeSphere 云账号在扩展市场订阅组件。
|
||||
|
||||
== 前提条件
|
||||
|
||||
* 以 platform-admin 角色登录到{ks_product_left} Web 控制台。
|
||||
* 已注册一个 https://kubesphere.cloud/login/[KubeSphere 云账号]。
|
||||
|
||||
== 操作步骤
|
||||
|
||||
. 点击{ks_product_left} Web 控制台左上角的**扩展市场**，进入扩展市场页面。
|
||||
|
||||
. 搜索您要安装的扩展组件，点击**订阅**。
|
||||
+
|
||||
--
|
||||
* 点击扩展组件名称进入组件的详情页面，查看基本信息、概览、更新日志、权限需求等。
|
||||
* 点击详情页面左侧的image:/images/ks-qkcp/zh/icons/chevron-down.svg[chevron-down,18,18]，选择扩展组件的版本。
|
||||
* 点击**订阅**安装当前版本的扩展组件。
|
||||
* 点击**查看文件**查看该扩展组件 Helm Chart 包中的所有文件。点击页面右侧的image:/images/ks-qkcp/zh/icons/copy.svg[copy,18,18]复制当前查看文件的内容，点击image:/images/ks-qkcp/zh/icons/download-dark.svg[download-dark,18,18]将当前查看的文件下载到本地。
|
||||
--
|
||||
. 如果您未绑定 https://kubesphere.cloud/login/[KubeSphere 云账号]，前往**扩展中心**绑定您的 KubeSphere 云账户，然后进入订阅流程。
|
||||
. 在订单确认与支付页面，选择**订阅方案**、**订阅时长**后，提交订单进行支付。
|
||||
. 支付完成后，在扩展市场的组件详情页面，点击**安装**，进入组件安装流程。
|
||||
|
||||
+
|
||||
include::../../../../_ks_components/admonitions/note.adoc[]
|
||||
|
||||
扩展市场中部分组件可免费订阅，部分需要付费订阅。
|
||||
|
||||
include::../../../../_ks_components/admonitions/admonEnd.adoc[]
|
||||
|
|
@ -1,56 +0,0 @@
|
|||
---
|
||||
title: "安装扩展组件"
|
||||
linkTitle: "安装扩展组件"
|
||||
keywords: "Kubernetes, KubeSphere,安装，组件，多集群"
|
||||
description: "介绍如何安装扩展组件。"
|
||||
weight: 02
|
||||
---
|
||||
|
||||
本节介绍如何安装扩展组件。
|
||||
|
||||
== 前提条件
|
||||
|
||||
ifeval::["{file_output_type}" == "html"]
|
||||
* 以 platform-admin 角色登录到{ks_product_left} Web 控制台。有关平台角色的更多信息，请参阅link:../../../05-users-and-roles/02-platform-roles/[平台角色]。
|
||||
endif::[]
|
||||
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
* 以 platform-admin 角色登录到{ks_product_left} Web 控制台。有关平台角色的更多信息，请参阅《{ks_product_right}用户和角色管理指南》。
|
||||
endif::[]
|
||||
|
||||
* 请先订阅您要安装的扩展组件。
|
||||
|
||||
|
||||
== 安装步骤
|
||||
|
||||
. 采用以下方式之一，进入安装页面，开始安装流程。
|
||||
|
||||
* 点击扩展市场中组件详情页的**安装**按钮，进入组件安装页面。
|
||||
* 在扩展中心绑定 KubeSphere 云账号后，对已订阅未安装的组件，点击右侧的**安装**按钮，进入组件安装页面。
|
||||
|
||||
. 在组件安装对话框的**版本选择**页签，选择扩展组件的版本号，并安装好所有必装组件，点击**下一步**。
|
||||
|
||||
+
|
||||
|
||||
include::../../../../_ks_components/admonitions/note.adoc[]
|
||||
|
||||
安装检测时，会识别扩展组件是否有依赖组件。依赖组件分为必装组件和选装组件。
|
||||
|
||||
若必装组件的状态为**未就绪**，您需要先行安装正确版本的必装组件，以确保扩展组件的正常使用。而选装组件不会影响扩展组件的安装。
|
||||
|
||||
include::../../../../_ks_components/admonitions/admonEnd.adoc[]
|
||||
|
||||
. 在**扩展组件安装**页签，修改扩展组件的配置后（可选），点击**开始安装**，开始安装扩展组件。
|
||||
+
|
||||
image:/images/ks-qkcp/zh/v4.0/install-extensions.png[,100%]
|
||||
|
||||
. 在**集群选择**页签，根据名称，标识，标签选择集群，可选择多个集群。
|
||||
|
||||
. 在**差异化配置**页签，分别编辑选中集群的 YAML 配置，也可不修改，使用初始默认配置。点击**确定**，开始配置集群 Agent。
|
||||
+
|
||||
include::../../../../_ks_components/admonitions/note.adoc[]
|
||||
部分扩展组件可能需要安装集群 Agent，以便能正常使用扩展组件的功能。
|
||||
|
||||
include::../../../../_ks_components/admonitions/admonEnd.adoc[]
|
||||
|
||||
安装完成后，默认启用该组件。您可以在扩展中心配置、升级、禁用、卸载扩展组件，还可以点击顶部导航栏上的image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，查看使用该组件。
|
||||
|
|
@ -1,28 +0,0 @@
|
|||
---
|
||||
title: "同步和设置云账号"
|
||||
linkTitle: "同步和设置云账号"
|
||||
keywords: "Kubernetes, KubeSphere,同步,设置,KubeSphere Cloud,云账号"
|
||||
description: "介绍如何同步和设置 KubeSphere 云账号。"
|
||||
weight: 01
|
||||
---
|
||||
|
||||
本节介绍如何在扩展中心同步和设置 KubeSphere 云账号。
|
||||
|
||||
== 前提条件
|
||||
|
||||
* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../05-users-and-roles/01-users/[用户]和link:../../../../05-users-and-roles/02-platform-roles/[平台角色]。
|
||||
* 您需要在扩展中心授权登录 KubeSphere 云账号。
|
||||
|
||||
== 同步云账号
|
||||
|
||||
完成组件订阅后，若扩展中心的组件列表未更新，您可能需要手动同步订阅信息。
|
||||
|
||||
. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。
|
||||
. 点击**扩展中心**。
|
||||
. 点击组件列表右上角的云账号头像，选择**同步云账户**，即可在组件列表查看您已订阅的所有组件。
|
||||
|
||||
== 设置云账号
|
||||
. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。
|
||||
. 点击**扩展中心**。
|
||||
. 点击组件列表右上角的云账号头像，选择**云账户设置**。
|
||||
. 设置账号信息、安全验证、支付货币等。
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
---
|
||||
title: "管理订阅"
|
||||
linkTitle: "管理订阅"
|
||||
keywords: "Kubernetes, KubeSphere,组件,订阅管理,KubeSphere Cloud,云账号"
|
||||
description: "介绍如何管理 KubeSphere 云账号下已订阅的组件。"
|
||||
weight: 02
|
||||
|
||||
---
|
||||
|
||||
本节介绍如何管理 KubeSphere 云账号下已订阅的组件。
|
||||
|
||||
== 前提条件
|
||||
|
||||
* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../05-users-and-roles/01-users/[用户]和link:../../../../05-users-and-roles/02-platform-roles/[平台角色]。
|
||||
* 您需要在扩展中心授权登录 KubeSphere 云账号。
|
||||
|
||||
== 操作步骤
|
||||
|
||||
. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。
|
||||
. 点击**扩展中心**。
|
||||
. 点击组件列表右上角的头像，选择**订阅管理**。
|
||||
. 在订阅管理页面，查看各组件的订阅状态、订阅计划、订阅时长、到期时间等。
|
||||
. 在需要操作的组件右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**查看订单**，或**订阅**已过期的组件。
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
---
|
||||
title: "管理订单"
|
||||
linkTitle: "管理订单"
|
||||
keywords: "Kubernetes, KubeSphere,组件,订单管理,KubeSphere Cloud,云账号"
|
||||
description: "介绍如何管理 KubeSphere 云账号下的订单。"
|
||||
weight: 03
|
||||
---
|
||||
|
||||
本节介绍如何管理 KubeSphere 云账号下的订单。
|
||||
|
||||
== 前提条件
|
||||
|
||||
* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../05-users-and-roles/01-users/[用户]和link:../../../../05-users-and-roles/02-platform-roles/[平台角色]。
|
||||
* 您需要在扩展中心授权登录 KubeSphere 云账号。
|
||||
|
||||
== 操作步骤
|
||||
|
||||
. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。
|
||||
. 点击**扩展中心**。
|
||||
. 点击组件列表右上角的头像，选择**订单管理**。
|
||||
. 在订单页面，查看您账号下所有订单的详情，包括未支付完成的订单。
|
||||
. 点击未支付完成的订单，可以继续支付或取消订单。
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
---
|
||||
title: "解绑云账号"
|
||||
linkTitle: "解绑云账号"
|
||||
keywords: "Kubernetes, KubeSphere,解绑,组件,KubeSphere Cloud,云账号"
|
||||
description: "介绍如何解绑 KubeSphere 云账号。"
|
||||
weight: 04
|
||||
---
|
||||
|
||||
本节介绍如何解绑 KubeSphere 云账号。
|
||||
|
||||
解绑后，再次授权登录可以绑定新账号。
|
||||
|
||||
|
||||
== 前提条件
|
||||
|
||||
* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../05-users-and-roles/01-users/[用户]和link:../../../../05-users-and-roles/02-platform-roles/[平台角色]。
|
||||
* 您需要在扩展中心授权登录 KubeSphere 云账号。
|
||||
|
||||
== 操作步骤
|
||||
|
||||
. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。
|
||||
. 点击**扩展中心**。
|
||||
. 点击组件列表右上角的头像，选择**解绑云账号**。
|
||||
|
||||
|
|
@ -1,10 +0,0 @@
|
|||
---
|
||||
title: "管理 KubeSphere 云账号"
|
||||
linkTitle: "管理 KubeSphere 云账号"
|
||||
keywords: "Kubernetes, KubeSphere,订阅,安装,组件,KubeSphere Cloud,云账号"
|
||||
description: "介绍如何管理 KubeSphere 云账号的订阅订单等功能。"
|
||||
layout: "second"
|
||||
weight: 03
|
||||
---
|
||||
|
||||
本节介绍如何在扩展中心管理 KubeSphere 云账号下的订阅订单等功能。
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
---
|
||||
title: "订阅与安装扩展组件"
|
||||
linkTitle: "订阅与安装扩展组件"
|
||||
keywords: "Kubernetes, KubeSphere,订阅,安装,组件, KubeSphere Cloud,云账号"
|
||||
description: "介绍如何订阅、安装扩展组件，以及管理 KubeSphere 云账号的相关功能。"
|
||||
layout: "second"
|
||||
draft: true
|
||||
weight: 02
|
||||
---
|
||||
|
||||
// 导出说明：此文档用于在线订阅 pdf 版本，不可与 01-install-components-pdf 同时存在。
|
||||
|
||||
本节介绍如何订阅、安装扩展组件，以及管理 KubeSphere 云账号的相关功能。
|
||||
|
|
@ -8,7 +8,7 @@ weight: 03
|
|||
|
||||
本节介绍如何升级扩展组件。
|
||||
|
||||
在订阅期内，当组件有新版本时，您可以在扩展中心的组件详情页升级组件。
|
||||
当组件有新版本时，您可以在扩展中心的组件详情页升级组件。
|
||||
|
||||
== 前提条件
|
||||
|
||||
|
|
|
|||
|
|
@ -8,50 +8,8 @@ weight: 06
|
|||
icon: "/images/docs/common/docs.svg"
|
||||
---
|
||||
|
||||
ifeval::["{file_output_type}" == "html"]
|
||||
|
||||
本节介绍如何订阅、安装、管理扩展组件，以及管理 KubeSphere 云账号的相关功能。
|
||||
|
||||
KubeSphere 扩展组件，是构建在 KubeSphere LuBan 之上、用以扩展并增强 KubeSphere 产品能力、进一步满足企业各类型业务需求的应用形态。{ks_product_right}安装完成后默认仅启用了核心组件。建议您在扩展市场订阅安装扩展组件以充分利用{ks_product_both}的功能特性。
|
||||
|
||||
有关如何使用各个扩展组件的更多信息，请参阅link:../11-use-extensions[扩展组件使用]章节。
|
||||
|
||||
endif::[]
|
||||
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
|
||||
本节介绍如何安装和管理扩展组件。
|
||||
|
||||
KubeSphere 扩展组件，是构建在 KubeSphere LuBan 之上、用以扩展并增强 KubeSphere 产品能力、进一步满足企业各类型业务需求的应用形态。{ks_product_right}安装完成后默认仅启用了核心组件。建议您在扩展中心安装扩展组件以充分利用{ks_product_both}的功能特性。
|
||||
|
||||
有关如何使用各个扩展组件的更多信息，请参阅《{ks_product_right}扩展组件使用指南》。
|
||||
|
||||
== 产品版本
|
||||
|
||||
本文档适用于{ks_product_left} v4.1.0 版本。
|
||||
|
||||
== 读者对象
|
||||
|
||||
本文档主要适用于以下读者：
|
||||
|
||||
* {ks_product_right}用户
|
||||
|
||||
* 交付工程师
|
||||
|
||||
* 运维工程师
|
||||
|
||||
* 售后工程师
|
||||
|
||||
|
||||
== 修订记录
|
||||
|
||||
[%header,cols="1a,1a,3a"]
|
||||
|===
|
||||
|文档版本 |发布日期 |修改说明
|
||||
|
||||
|01
|
||||
|{pdf_releaseDate}
|
||||
|第一次正式发布。
|
||||
|===
|
||||
|
||||
endif::[]
|
||||
// 有关如何使用各个扩展组件的更多信息，请参阅《{ks_product_right}扩展组件使用指南》。
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: "Web 控制台"
|
||||
linkTitle: "Web 控制台"
|
||||
title: "进入集群"
|
||||
linkTitle: "进入集群"
|
||||
keywords: "Kubernetes, KubeSphere, 集群管理, Web 控制台"
|
||||
description: "介绍如何登录 KubeSphere Web 控制台并进入集群，以及修改用户的邮箱、语言和密码。"
|
||||
layout: "second"
|
||||
|
|
|
|||
|
|
@ -21,6 +21,7 @@ weight: 06
|
|||
include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[]
|
||||
|
||||
:relfileprefix: ./
|
||||
|
||||
== 操作步骤
|
||||
|
||||
include::../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[]
|
||||
|
|
|
|||
|
|
@ -16,7 +16,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-rollBack
|
|||
== 前提条件
|
||||
|
||||
:relfileprefix: ../../../../
|
||||
* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。
|
||||
* {empty}
|
||||
include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[]
|
||||
|
||||
:relfileprefix: ./
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,8 @@ include::../../../../_custom/clusterManagement/routes/routes-desc-createARoute.a
|
|||
== 前提条件
|
||||
|
||||
:relfileprefix: ../../../../
|
||||
* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。
|
||||
* {empty}
|
||||
include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[]
|
||||
|
||||
:relfileprefix: ./
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,8 @@ include::../../../../_custom/clusterManagement/routes/routes-desc-accessABackend
|
|||
== 前提条件
|
||||
|
||||
:relfileprefix: ../../../../
|
||||
* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。
|
||||
* {empty}
|
||||
include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[]
|
||||
|
||||
:relfileprefix: ./
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,8 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent
|
|||
== 前提条件
|
||||
|
||||
:relfileprefix: ../../../../
|
||||
* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。
|
||||
* {empty}
|
||||
include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[]
|
||||
|
||||
:relfileprefix: ./
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,8 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent
|
|||
== 前提条件
|
||||
|
||||
:relfileprefix: ../../../../
|
||||
* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。
|
||||
* {empty}
|
||||
include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[]
|
||||
|
||||
:relfileprefix: ./
|
||||
|
||||
|
|
|
|||
|
|
@ -1,60 +0,0 @@
|
|||
---
|
||||
title: "设置存储卷自动扩展"
|
||||
linkTitle: "设置存储卷自动扩展"
|
||||
keywords: "Kubernetes, KubeSphere, 集群管理, 存储, 持久卷声明, 持久卷,自动扩展"
|
||||
description: "介绍如何设置存储卷自动扩展。"
|
||||
weight: 07
|
||||
draft: true
|
||||
---
|
||||
|
||||
:ks_permission: **持久卷声明管理**
|
||||
:ks_navigation: **存储 > 持久卷声明**
|
||||
|
||||
|
||||
卷容量自动扩展指系统在卷剩余空间低于阈值时自动扩展卷容量。本节介绍如何设置存储卷自动扩展。
|
||||
|
||||
|
||||
== 前提条件
|
||||
|
||||
:relfileprefix: ../../../../
|
||||
* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。
|
||||
|
||||
:relfileprefix: ./
|
||||
|
||||
include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-prer-persistentVolumeCreated.adoc[]
|
||||
|
||||
* 请确保后端存储系统支持卷扩展功能，并已在持久卷声明对应的存储类上启用卷扩展功能。有关更多信息，请参阅link:../../02-storage-classes/05-enable-and-disable-volume-operations/[启用和禁用卷操作]。
|
||||
|
||||
|
||||
== 操作步骤
|
||||
|
||||
include::../../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[]
|
||||
|
||||
+
|
||||
|
||||
include::../../../../../_ks_components/oper-navigate.adoc[]
|
||||
|
||||
+
|
||||
|
||||
include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistentVolumeClaims-oper-openDetailsPage.adoc[]
|
||||
|
||||
+
|
||||
|
||||
. 在持久卷声明详情页面的左上角，选择**更多操作 > 设置自动扩展**。
|
||||
|
||||
. 在**设置自动扩展**对话框，点击页面右侧的**已禁用**按钮启用自动扩展功能。
|
||||
+
|
||||
--
|
||||
// Note
|
||||
include::../../../../../_ks_components/admonitions/note.adoc[]
|
||||
|
||||
如果您需要禁用自动扩展功能，在页面右侧点击**已启用**。
|
||||
|
||||
include::../../../../../_ks_components/admonitions/admonEnd.adoc[]
|
||||
--
|
||||
|
||||
. 在**自动扩展**设置区域，设置扩展的最大容量、阈值、以及增量。
|
||||
|
||||
. （可选）如果您需要系统自动检查卷状态并重启工作负载，请勾选**自动重启工作负载**。
|
||||
|
||||
. 设置完成后，点击**确定**以开启自动扩展。
|
||||
|
|
@ -16,7 +16,8 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent
|
|||
== 前提条件
|
||||
|
||||
:relfileprefix: ../../../../
|
||||
* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。
|
||||
* {empty}
|
||||
include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[]
|
||||
|
||||
:relfileprefix: ./
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,8 @@ include::../../../../../_ks_components/admonitions/admonEnd.adoc[]
|
|||
== 前提条件
|
||||
|
||||
:relfileprefix: ../../../../
|
||||
* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。
|
||||
* {empty}
|
||||
include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[]
|
||||
|
||||
:relfileprefix: ./
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,8 @@ weight: 01
|
|||
== 前提条件
|
||||
|
||||
:relfileprefix: ../../../../
|
||||
* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。
|
||||
* {empty}
|
||||
include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[]
|
||||
|
||||
:relfileprefix: ./
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,8 @@ include::../../../../../_ks_components/admonitions/admonEnd.adoc[]
|
|||
== 前提条件
|
||||
|
||||
:relfileprefix: ../../../../
|
||||
* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/_index.adoc[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/_index.adoc[集群角色]。
|
||||
* {empty}
|
||||
include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[]
|
||||
|
||||
:relfileprefix: ./
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: "编辑集群基本信息"
|
||||
linkTitle: "编辑集群基本信息"
|
||||
keywords: "Kubernetes, KubeSphere, 集群管理, 基本信息, 编辑集群基本信息"
|
||||
description: "介绍如何查看集群基本信息。"
|
||||
description: "介绍如何编辑集群基本信息。"
|
||||
weight: 02
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,8 @@ weight: 02
|
|||
* 您可以将一个集群授权给多个企业空间，从而允许企业空间中的资源运行在该集群上。
|
||||
|
||||
ifeval::["{file_output_type}" == "html"]
|
||||
* 您也可以将多个集群授权给同一个企业空间，从而在企业空间中创建联邦项目。有关联邦项目的更多信息，请参阅link:../../../11-use-extensions/04-kubefed[联邦项目]。
|
||||
* 您也可以将多个集群授权给同一个企业空间，从而在企业空间中创建联邦项目。
|
||||
// 有关联邦项目的更多信息，请参阅link:../../../11-use-extensions/04-kubefed[联邦项目]。
|
||||
endif::[]
|
||||
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: "移除集群成员"
|
||||
linkTitle: "移除集群成员"
|
||||
keywords: "Kubernetes, KubeSphere, 集群管理, 集群设置, 集群成员, 移除集群成员"
|
||||
description: "介绍如何将用户邀请到集群。"
|
||||
description: "介绍如何移除集群成员。"
|
||||
weight: 04
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -22,7 +22,8 @@ weight: 01
|
|||
|说明
|
||||
|
||||
|
|
||||
若要使用代理连接，{ks_product_both}平台需要安装并启用 **KubeSphere 多集群代理连接**扩展组件。有关更多信息，请参阅link:../../../../11-use-extensions/19-tower/02-add-a-member-cluster-using-proxy-connection/[通过代理连接添加成员集群]。
|
||||
若要使用代理连接，{ks_product_both}平台需要安装并启用 **KubeSphere 多集群代理连接**扩展组件。
|
||||
// 有关更多信息，请参阅link:../../../../11-use-extensions/19-tower/02-add-a-member-cluster-using-proxy-connection/[通过代理连接添加成员集群]。
|
||||
|===
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -11,33 +11,3 @@ icon: "/images/docs/common/docs.svg"
|
|||
本文档介绍如何以集群成员身份在{ks_product_both}管理单个或多个集群中的所有资源。
|
||||
|
||||
{ks_product_right}支持对多个集群进行管理，每个集群可授权给多个企业空间，每个企业空间可包含多个项目。作为多租户系统，{ks_product_right}支持在平台、集群、企业空间和项目级别基于角色对用户的权限进行控制。
|
||||
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
== 产品版本
|
||||
|
||||
本文档适用于{ks_product_left} v4.1.0 版本。
|
||||
|
||||
== 读者对象
|
||||
|
||||
本文档主要适用于以下读者：
|
||||
|
||||
* {ks_product_right}用户
|
||||
|
||||
* 交付工程师
|
||||
|
||||
* 运维工程师
|
||||
|
||||
* 售后工程师
|
||||
|
||||
|
||||
== 修订记录
|
||||
|
||||
[%header,cols="1a,1a,3a"]
|
||||
|===
|
||||
|文档版本 |发布日期 |修改说明
|
||||
|
||||
|01
|
||||
|{pdf_releaseDate}
|
||||
|第一次正式发布。
|
||||
|===
|
||||
endif::[]
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: "Web 控制台"
|
||||
linkTitle: "Web 控制台"
|
||||
title: "进入企业空间"
|
||||
linkTitle: "进入企业空间"
|
||||
keywords: "Kubernetes, KubeSphere, 企业空间管理, Web 控制台"
|
||||
description: "介绍如何登录 KubeSphere Web 控制台并进入企业空间，以及修改用户的邮箱、语言和密码。"
|
||||
layout: "second"
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ weight: 02
|
|||
. 点击**企业空间管理**。
|
||||
+
|
||||
--
|
||||
* 企业空间列表显示当前{ks_product}平台的所有企业空间。
|
||||
* 企业空间列表显示当前 KubeSphere 平台的所有企业空间。
|
||||
|
||||
* 在企业空间列表中，点击企业空间的名称可进入企业空间，查看和管理企业空间中的资源。
|
||||
--
|
||||
|
|
|
|||
|
|
@ -15,33 +15,3 @@ icon: "/images/docs/common/docs.svg"
|
|||
在{ks_product_both}平台，企业空间用于对资源进行分组管理。集群管理员可以将一个或多个集群授权给企业空间，从而允许企业空间中的资源运行在集群上。每个企业空间可包含多个项目。用户可以被邀请加入企业空间，并根据企业空间角色获得企业空间资源的查看和管理权限。
|
||||
|
||||
{ks_product_right}安装完成后系统将自动创建 **system-workspace** 企业空间，其中包含系统项目，用于管理系统资源。
|
||||
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
== 产品版本
|
||||
|
||||
本文档适用于{ks_product_left} v4.1.0 版本。
|
||||
|
||||
== 读者对象
|
||||
|
||||
本文档主要适用于以下读者：
|
||||
|
||||
* {ks_product_right}用户
|
||||
|
||||
* 交付工程师
|
||||
|
||||
* 运维工程师
|
||||
|
||||
* 售后工程师
|
||||
|
||||
|
||||
== 修订记录
|
||||
|
||||
[%header,cols="1a,1a,3a"]
|
||||
|===
|
||||
|文档版本 |发布日期 |修改说明
|
||||
|
||||
|01
|
||||
|{pdf_releaseDate}
|
||||
|第一次正式发布。
|
||||
|===
|
||||
endif::[]
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue