add 4.1 docs

Signed-off-by: zhuxiujuan28 <562873187@qq.com>
This commit is contained in:
zhuxiujuan28 2024-09-10 16:49:05 +08:00
parent 6f5b8a2271
commit 45d7975e2b
53 changed files with 1391 additions and 2540 deletions

View File

@ -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}`;
}
});

View File

@ -28,9 +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_ver = "v4.1"
[security]
enableInlineShortcodes = false
@ -43,6 +46,9 @@ ignorefiles = [ ".*/_custom" ]
methods = ['(?i)GET|POST']
urls = ['.*']
[security.gotemplates]
allowActionJSTmpl = true
[Taxonomies]
[params]
@ -153,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
@ -318,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

View File

@ -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::[]

View File

@ -5,5 +5,5 @@ ifeval::["{file_output_type}" == "html"]
endif::[]
ifeval::["{file_output_type}" == "pdf"]
有关更多信息,请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。
有关更多信息,请参阅《{ks_product_right}平台管理指南》的“扩展组件管理”章节。
endif::[]

View File

@ -7,6 +7,6 @@ endif::[]
ifeval::["{file_output_type}" == "pdf"]
* {ks_product_right}平台需要启用告警系统扩展组件。关于更多信息,请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。
* {ks_product_right}平台需要启用告警系统扩展组件。关于更多信息,请参阅《{ks_product_right}平台管理指南》的“扩展组件管理”章节。
endif::[]

View File

@ -1,6 +1,6 @@
// :ks_include_id: 01792eb26cce4187b5a1f964404e6037
ifeval::["{file_output_type}" == "pdf"]
有关如何在项目中启用**收集卷上的日志**,请参阅《{ks_product_full_right}项目管理指南》的“日志收集”章节。
有关如何在项目中启用**收集卷上的日志**,请参阅《{ks_product_right}项目管理指南》的“日志收集”章节。
endif::[]

View File

@ -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

View File

@ -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
----
--

View File

@ -7,6 +7,6 @@ endif::[]
ifeval::["{file_output_type}" == "pdf"]
* {ks_product_right}平台需要启用应用治理扩展组件。有关更多信息,请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。
* {ks_product_right}平台需要启用应用治理扩展组件。有关更多信息,请参阅《{ks_product_right}平台管理指南》的“扩展组件管理”章节。
endif::[]

View File

@ -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::[]

View File

@ -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::[]

View File

@ -7,6 +7,6 @@ endif::[]
ifeval::["{file_output_type}" == "pdf"]
* {ks_product_right}平台需要启用应用管理扩展组件。有关更多信息,请参阅《{ks_product_full_right}平台管理指南》的“扩展组件管理”章节。
* {ks_product_right}平台需要启用应用管理扩展组件。有关更多信息,请参阅《{ks_product_right}平台管理指南》的“扩展组件管理”章节。
endif::[]

View File

@ -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::[]

View File

@ -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::[]

View File

@ -9,35 +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::[]

View File

@ -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 不支持 arm64arm64 环境部署时,可不配置该参数。
type: harbor
# 如使用 kk 部署的 harbor 或其他需要登录的仓库,需设置对应仓库的 auths如使用 kk 部署默认的 docker registry 仓库,则无需配置 auths 参数。
# 注意:如使用 kk 部署 harborauths 参数请于创建 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 控制台,可在扩展中心查看并安装扩展组件。或者,按照以下步骤快速部署扩展组件。
// . 若要安装可观测相关扩展组件,需要先部署 vectorWhizardTelemetry 数据流水线)和 whizard-monitoringWhizardTelemetry 监控)
// 扩展组件。否则,可跳过此步骤。
// +
// --
// [,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%]
--

View File

@ -0,0 +1,121 @@
---
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。
+
====
* 如果您无法访问 docker.io请执行以下安装命令。
+
[,bash]
----
helm upgrade --install -n kubesphere-system --create-namespace ks-core chart=https://charts.kubesphere.io/main/ks-core-1.1.0.tgz --debug --wait -f value.yaml
----
* 如果您能正常访问 docker.io请执行以下安装命令。
+
[,bash]
----
helm upgrade --install -n kubesphere-system --create-namespace ks-core chart=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[]
--

View File

@ -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。
安装完成后,默认启用该组件。您可以在扩展中心配置、升级、禁用、卸载扩展组件。

View File

@ -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::[]

View File

@ -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
// |===

View File

@ -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[此文件]。
@ -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,65 @@ 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。
+
====
* 如果您无法访问 docker.io请执行以下安装命令。
+
[,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 chart=https://charts.kubesphere.io/main/ks-core-1.1.0.tgz --debug --wait -f value.yaml
----
[.admon.attention,cols="a"]
|===
|注意
* 如果您能正常访问 docker.io请执行以下安装命令。
+
[,bash]
----
helm upgrade --install -n kubesphere-system --create-namespace ks-core chart=https://charts.kubesphere.io/main/ks-core-1.1.0.tgz --debug --wait
----
|
将 **global.imageRegistry** 和 **extension.imageRegistry** 的默认地址 **dockerhub.kubekey.local/kse** 替换为您的实际镜像仓库地址。
|===
取决于您的硬件和网络环境,您可能需要配置流量转发规则并在防火墙中放行 30880 端口。如果显示如下信息,则表明 ks-core 安装成功:
如果显示如下信息,则表明 ks-core 安装成功:
[,yaml]
----
@ -550,101 +423,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 控制台,可在扩展中心查看并安装扩展组件。或者,按照以下步骤快速部署扩展组件。
. 若要安装可观测相关扩展组件,需要先部署 vectorWhizardTelemetry 数据流水线)和 whizard-monitoringWhizardTelemetry 监控)扩展组件。否则,可跳过此步骤。
+
--
[,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[订阅并安装扩展组件]。

View File

@ -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/[Lets Encrypt 官方文档]。
|===
=== 高级选项
[%header,cols="1,1,3a"]
|===
|选项 |默认值 |描述
|internalTLS | false | bool - 如果值为 true, 启用内部 TLS。console 和 apiserver 均会启用 HTTPS 服务。
|ingress.ingressClassName | "" | string - 使用网关的可选 Ingress 类,可选项:"nginxtraefik"。
|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 |否
|Lets 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 的一半。
|===

View File

@ -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
----
--

View File

@ -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
---
@ -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
----
--

View File

@ -21,18 +21,13 @@ 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: ../../../
@ -53,13 +48,7 @@ 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
----
如果显示新增节点的信息,则表明节点添加成功。

View File

@ -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: ./
@ -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
----
如果没有显示已删除节点的信息,则表明节点删除成功。

View File

@ -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::[]

View File

@ -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
|平台级、多集群和多租户级扩展组件的全局访问入口,支持快捷访问已安装的扩展组件。
|平台设置
|查看并自定义平台信息。
|查看平台信息。
|===

View File

@ -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::[]

View File

@ -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-
----

View File

@ -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::[]

View File

@ -8,7 +8,7 @@ weight: 03
本节介绍如何升级扩展组件。
在订阅期内,当组件有新版本时,您可以在扩展中心的组件详情页升级组件。
当组件有新版本时,您可以在扩展中心的组件详情页升级组件。
== 前提条件

View File

@ -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}扩展组件使用指南》。

View File

@ -1,6 +1,6 @@
---
title: "Web 控制台"
linkTitle: "Web 控制台"
title: "进入集群"
linkTitle: "进入集群"
keywords: "Kubernetes, KubeSphere, 集群管理, Web 控制台"
description: "介绍如何登录 KubeSphere Web 控制台并进入集群,以及修改用户的邮箱、语言和密码。"
layout: "second"

View File

@ -1,61 +0,0 @@
---
title: "设置存储卷自动扩展"
linkTitle: "设置存储卷自动扩展"
keywords: "Kubernetes, KubeSphere, 集群管理, 存储, 持久卷声明, 持久卷,自动扩展"
description: "介绍如何设置存储卷自动扩展。"
weight: 07
draft: true
---
:ks_permission: **持久卷声明管理**
:ks_navigation: **存储 > 持久卷声明**
卷容量自动扩展指系统在卷剩余空间低于阈值时自动扩展卷容量。本节介绍如何设置存储卷自动扩展。
== 前提条件
:relfileprefix: ../../../../
* {empty}
include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.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[]
--
. 在**自动扩展**设置区域,设置扩展的最大容量、阈值、以及增量。
. (可选)如果您需要系统自动检查卷状态并重启工作负载,请勾选**自动重启工作负载**。
. 设置完成后,点击**确定**以开启自动扩展。

View File

@ -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::[]

View File

@ -1,6 +1,6 @@
---
title: "Web 控制台"
linkTitle: "Web 控制台"
title: "进入企业空间"
linkTitle: "进入企业空间"
keywords: "Kubernetes, KubeSphere, 企业空间管理, Web 控制台"
description: "介绍如何登录 KubeSphere Web 控制台并进入企业空间,以及修改用户的邮箱、语言和密码。"
layout: "second"

View File

@ -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::[]

View File

@ -1,6 +1,6 @@
---
title: "Web 控制台"
linkTitle: "Web 控制台"
title: "进入项目"
linkTitle: "进入项目"
keywords: "Kubernetes, KubeSphere, 项目管理, Web 控制台"
description: "介绍如何登录 KubeSphere Web 控制台并进入项目,以及修改用户的邮箱、语言和密码。"
layout: "second"

View File

@ -27,7 +27,7 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent
* 请确保后端存储系统支持卷快克隆功能,并且持久卷声明对应的存储类已启用卷克隆功能。
// * 请确保后端存储系统支持卷克隆功能,并且持久卷声明对应的存储类已启用卷克隆功能。有关更多信息,请参阅《{ks_product_full_right}集群管理指南》的“启用和禁用卷操作”章节。
// * 请确保后端存储系统支持卷克隆功能,并且持久卷声明对应的存储类已启用卷克隆功能。有关更多信息,请参阅《{ks_product_right}集群管理指南》的“启用和禁用卷操作”章节。
== 操作步骤

View File

@ -13,33 +13,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::[]

View File

@ -11,33 +11,3 @@ icon: "/images/docs/common/docs.svg"
{ks_product_right}集成了 kubectl 命令行工具,以及集群的 kubeconfig 文件。通过使用 kubeconfig 文件,您可以配置当前集群的访问信息。
本节介绍如何通过 kubectl 运行命令,以及如何查看下载集群的 kubeconfig 文件。
ifeval::["{file_output_type}" == "pdf"]
== 产品版本
本文档适用于{ks_product_left} v4.1.0 版本。
== 读者对象
本文档主要适用于以下读者:
* {ks_product_right}用户
* 交付工程师
* 运维工程师
* 售后工程师
== 修订记录
[%header,cols="1a,1a,3a"]
|===
|文档版本 |发布日期 |修改说明
|01
|{pdf_releaseDate}
|第一次正式发布。
|===
endif::[]

View File

@ -1,732 +0,0 @@
---
title: "KubeSphere v4.1.0 版本说明"
linkTitle: "KubeSphere v4.1.0 版本说明"
keywords: "v4.1.0 版本说明, KubeSphere"
description: "介绍 KubeSphere 新特性、功能增强以及问题修复。"
weight: 01
---
== KubeSphere Core
KubeSphere v4.1.0 是青云科技 KubeSphere 团队匠心打造的全新云原生操作系统,是 KubeSphere 架构革新后的第一个全功能版本。
KubeSphere v4.1.0 在 KubeSphere LuBan 全新云原生可扩展开放架构的基础上,将 KubeSphere v3.x 的全产品功能解耦,并基于可插拔的架构规范进行重构、升级。自此,各 KubeSphere 扩展组件可独立发版、迭代。用户可根据需要的产品能力安装扩展组件,保持平台的轻量与灵活,轻松定制“千人千面”的专属操作系统。
KubeSphere v4.1.0 内置丰富全能的 KubeSphere 扩展市场。其中发布的扩展组件均经过严格审校,优质可控,覆盖云原生核心业务的方方面面。用户可自助式一键安装扩展组件,通过扩展中心一站式管理扩展组件的全生命周期。 此外,企业或个人开发者也可根据 KubeSphere LuBan 的开发规范,将自己的软件和服务上架到 KubeSphere 扩展市场进行分发与商业售卖,丰富多元的云原生应用生态。
=== 新特性
- 基于全新微内核架构 KubeSphere LuBan 重构
- 内置 KubeSphere 扩展市场
- 支持通过扩展中心统一管理扩展组件
- 支持 UI、API 扩展
- 支持通过 kubeconfig 一键导入 member 集群
- 支持 KubeSphere 服务帐户
- 支持基于 TOTP 的二次认证
- 支持动态扩展 Resource API
- 支持添加集群、企业空间、项目到快捷访问
- 支持通过容器终端进行文件上传和下载
- 支持适配不同厂商的云原生网关Kubernetes Ingress API
=== 优化
- 创建企业空间时支持选取所有集群
- 优化 web kubectl支持 pod 动态回收、切换集群时支持模糊搜索
- 优化节点管理列表,将默认排序修改为升序
- 仅允许受信的 OAuth Client 直接使用用户名和密码对用户身份进行校验
- 精简 member 集群中部署的 Agent 组件
- 拆分 KubeSphere Config 中部分配置作为独立的配置项
- 容器镜像搜索调整为按时间倒序进行排序
- 支持编辑用户别名
- 集群列表新增调度状态的展示
- 配置字典详情页支持 binaryData 数据显示
- 重构工作台管理页面
=== 缺陷修复
- 修复节点终端一直显示 connecting 的问题
- 修复潜在的企业空间资源越权访问的问题
- 修复潜在的企业空间集群授权 API 越权访问的问题
- 修复因错误配置导致会话异常登出的问题
- 修复添加镜像服务信息从指定仓库拉取镜像时异常的问题
- 编辑保密字典编辑时 ownerReferences 丢失的问题
- 修复首次登录白屏和页面错误重定向的问题
- 修复 Windows 环境下,选择框滚动的问题
- 修复当 cluster-admin 登录时找不到集群管理入口的问题
=== API 更新
==== **API 移除**
v4.1 版本将停止提供以下 API
**多集群**
`/API_PREFIX/clusters/{cluster}/API_GROUP/API_VERSION/...` 多集群代理请求 API 被移除。请使用新的多集群代理请求路径规则代替,`/clusters/{cluster}/API_PREFIX/API_GROUP/API_VERSION/...`。
**访问控制**
- `iam.kubesphere.io/v1alpha2` API 版本被移除。请使用 `iam.kubesphere.io/v1beta1` API 版本代替。
- `iam.kubesphere.io/v1beta1` 中的显著变化:
Role、RoleBinding、ClusterRole、ClusterRoleBinding 资源的 API Group 从 `rbac.authorization.k8s.io` 变更为 `iam.kubesphere.io`。
**多租户**
- `tenant.kubesphere.io/v1alpha1` 和 `tenant.kubesphere.io/v1alpha2` API 版本部分 API 被移除。请使用 `tenant.kubesphere.io/v1beta1` API 版本代替。
- `tenant.kubesphere.io/v1beta1` 中的显著变化:
`Workspace` 中 `spec.networkIsolation` 被移除。
**kubectl**
- `/resources.kubesphere.io/v1alpha2/users/{user}/kubectl` 接口已移除,终端相关操作无需再调用该接口
- 用户 web kubectl 终端 API 路径从 `/kapis/terminal.kubesphere.io/v1alpha2/namespaces/{namespace}/pods/{pod}/exec` 调整为 `/kapis/terminal.kubesphere.io/v1alpha2/users/{user}/kubectl`
**gateway**
`gateway.kubesphere.io/v1alpha1` API 版本被移除。
- 配置 Ingress 查询相关网关的 API 调整为
+
[,bash]
----
/kapis/gateway.kubesphere.io/v1alpha2/namespaces/{namespace}/availableingressclassscopes
----
==== **API 弃用**
以下 API 标记为弃用,将在未来的版本中移除:
- Cluster validation API
- Config configz API
- OAuth token review API
- Operations job rerun API
- Resources v1alpha2 API
- Resources v1alpha3 API
- Tenant v1alpha3 API
- Legacy version API
=== 已知问题
- LDAP Identity Provider 将在后续版本中支持
- 企业空间部门管理将在后续版本中支持
- KEDA 将在后续版本中支持
=== 其他
- 默认移除除英文和简体中文之外的所有语言选项
- 移除系统组件相关内容
== 可观测性
原 KubeSphere v3.x 中的可观测性相关功能如监控、告警、日志、审计、事件、通知与事件告警等在 v4.1.0 进行了比较大的重构和优化,逐渐统一在 `WhizardTelemetry 可观测平台` 中持续演进,并随 KubeSphere v4.1.0 发布 v1.0.0 版本。除了架构、API、技术栈等方向的优化与重构之外减少不必要的工作负载也是 WhizardTelemetry 可观测平台 v1.0.0 这个版本的重要目标:
- 原 v3.x 中的可观测性相关功能拆分成 10 个符合 KubeSphere LuBan 架构的扩展组件,包括 `WhizardTelemetry 平台服务`、`WhizardTelemetry 监控`、`WhizardTelemetry 告警管理`、`WhizardTelemetry 日志管理`、`WhizardTelemetry 事件管理`、`WhizardTelemetry 审计管理`、`WhizardTelemetry 通知管理`、`WhizardTelemetry 事件告警`、`WhizardTelemetry 数据流水线`、`OpenSearch 分布式检索与分析引擎`,这些扩展组件共同形成了 `WhizardTelemetry 可观测平台`。用户可以根据自己的需求安装所需的扩展组件,而不必如 KubeSphere v3.5.0 及之前版本一样,将一些不需要的组件也默认安装。
- 监控 API 在保有原来 KubeSphere 监控 API 风格的前提下,有了较大的调整及变更。
- 告警与通知同样进行了较大的架构及 API 优化与调整,包括:
+
--
- 多集群模式下流程的优化,尤其是在启用可观测中心场景下显著缩短了流程。
- 多集群模式下 member 集群的轻量化在启用可观测中心场景下member 集群无需部署用于告警的工作负载。
- 原需部署到每个集群的 Alertmanager 和 Notification Manager 改为只部署到 host 集群;同时 host 集群新增 Alertmanager Proxy 用于接收 member 集群发过来的告警进而转发给 Alertmanager。
--
- 日志、审计、事件及通知历史等功能也做了架构上较大的重构与优化,实现了真正的多集群架构:
+
--
- 原用于日志、审计、事件、通知历史等信息采集的 Agent 由 `Fluent Bit` 替换为 `Vector Agent`,新增 `Vector Aggregator` 用于部署到 host 集群收集通知历史等信息。
- 原每个集群都会部署的 `OpenSearch` 改为可以被属于相同区域或组织的多个集群共用,而不必每个集群都安装,不同的集群会创建以集群名称为前缀的 index。
- 用于接收审计数据的 kube-auditing-webhook 已被移除,审计数据落盘后将被 Vector Agent 收集。
- 原用于管理 Kubernetes 原生事件的 kube-events controllerrulerCRDs 已被移除,仅保留 kube-events-exporter 用于导出 Kubernetes 事件。
- K8s 及 KubeSphere 审计信息的归档改为统一由 Vector Agent 从写到磁盘的文件收集,去掉了之前的 Webhook。
- 原事件及审计的告警功能合并为 `WhizardTelemetry 事件告警`,未来会在此组件里支持日志告警;事件和审计各自的告警规则也被合并为一个 CRD `ClusterRuleGroup.logging.whizard.io`。
--
=== WhizardTelemetry 平台服务 v1.0.0
`WhizardTelemetry 平台服务` 是从原 KubeSphere APIServer 中将可观测相关功能剥离出来形成的新增服务,是 `WhizardTelemetry 可观测平台` 中各个可观测服务共用的 `APIServer`,为所有可观测功能提供公共的后端平台服务,目前提供监控、日志、审计、事件、通知等服务的 API。
==== **新特性**
- 接入 KubeSphere 鉴权认证,支持用户权限校验
- 监控 API 支持通过模板文件加载 PromQL 查询表达式
- 监控 API 支持自定义组件查询
==== **优化**
- 优化监控 API 查询性能
- 优化日志 API 查询性能
- 优化审计 API 查询性能
- 优化事件 API 查询性能
- 优化通知历史 API 查询性能
==== **弃用**
- 监控 API `monitoring.kubesphere.io/v1alpha3` 已在 KubeSphere v3.5.0 弃用,并且在 KubeSphere v4.1.0 正式移除
- 日志、审计、事件 API `tenant.kubesphere.io/v1alpha2` 已在 KubeSphere v4.1.0 正式移除
==== **API 更新**
- 监控 API 已升级为 `monitoring.kubesphere.io/v1beta1` 版本,更多 API 细节可参考 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/montoring-extension-dev-guide.md#whizardtelemetry-monitoring-api-%E5%8F%82%E8%80%83[WhizardTelemetry Monitoring API 参考]及 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/swagger.json[Swagger]
- 日志、审计、事件、通知历史 API 已升级为 `logging.kubesphere.io/v1alpha2` 版本,更多 API 细节可参考 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/logging-dev-guide.md[WhizardTelemetry API 参考]及 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/swagger.json[Swagger]
=== WhizardTelemetry 监控 v1.0.0
`WhizardTelemetry 监控` 是 WhizardTelemetry 可观测平台中提供监控功能的扩展组件。其中包含 Whizard 可观测中心,可提供多租户视角的云原生资源监控能力,包括针对多集群,节点, 工作负载、GPU、K8s 控制面等对象的核心监控指标实时和历史数据展示等功能。
可通过该扩展组件部署与管理如下组件:
- Whizard Prometheus 长期存储
+
Whizard 是一个企业级多云多集群监控告警产品解决可观测领域基于指标Metrics监控、告警的长期存储问题。
- Kube-Prometheus-Stack
+
Kube-Prometheus-Stack 是使用 Prometheus 监控 Kubernetes 集群及运行在上面的应用的监控栈,包含 Prometheus Operator、kube-state-metrics、node-exporter 等组件,以及 Kubernetes 组件指标收集配置清单和相关 Prometheus Rules。
- Calico Exporter部署在 Kube-Prometheus-Stack 的 node-exporter 内,可单独启用)
+
Calico Exporter 是一个用于收集 Calico 网络性能指标的指标导出器。
- Process-exporter (部署在 Kube-Prometheus-Stack 的 node-exporter 内, 可单独启用)
+
Process-exporter 是一个用于收集进程性能指标的指标导出器。
- DCGM-Exporter
+
DCGM-Exporter 是一个用于收集 Nvidia GPU 性能和健康度指标的指标导出器。
- Whizard Monitoring Helper
+
便于部署 `WhizardTelemetry 监控` 的助手工具。
==== **新特性**
- Whizard Gateway 支持暴露查询 UI并支持查询外部数据源
- Whizard 支持接入外部数据源鉴权认证
- Whizard 支持 Services 层级组件配置,支持配置差异化
- Whizard 优化内部 TLS 配置,提升查询性能
- Whizard 更多特性及优化可参考 Whizard v0.10.0 Release
- Kube-Prometheus-Stack 与社区项目 link:https://github.com/prometheus-operator/kube-prometheus[kube-prometheus] 完全兼容
- 集成 Calico Exporter 与 Process-exporter 到 Kube-Prometheus-Stack 的 node-exporter 内
- DCGM-Exporter 优化默认指标配置,支持更多 GPU 指标采集
==== **优化**
- 优化 Kube-Prometheus-Stack 中 recording rules 配置,同步社区最新更新
- 优化 Kube-Prometheus-Stack 各组件资源配额,剪裁无用指标,提升性能
==== **缺陷修复**
- 修复启用可观测中心时,集群/项目的规则组页面自定义规则无法自动提示的问题
==== **API 更新**
- 监控 API 已集成到 `WhizardTelemetry 平台服务` 中API 变更请参考 WhizardTelemetry 平台服务
==== **其他**
- Whizard 升级至 v0.10.0
- Prometheus Operator 升级至 v0.68.0
- Prometheus 升级至 v2.50.1
- kube-state-metrics 升级至 v2.8.2
- node-exporter 升级至 v1.6.0
- DCGM-Exporter 升级至 v3.4.0
=== WhizardTelemetry 告警管理 v1.0.0
`WhizardTelemetry 告警管理` 是 WhizardTelemetry 可观测平台中基于监控指标进行告警的扩展组件,提供多集群的规则组管理、评估和告警等功能。
可通过该扩展组件部署与管理如下组件:
- apiserver: 提供规则组和告警的相关 APIs
- controller-manager: 提供规则组的同步管理等功能
- ruler: 负责规则组的规则评估和告警功能
与 KubeSphere v3.5.0 相比,该扩展组件还从架构设计上对多集群告警的流程以及轻量化方面进行了显著优化。
==== **优化**
- 告警流程优化,尤其在启用可观测中心的场景下显著缩短了告警流程
- 降低 member 集群的告警负载,在启用可观测中心的场景下实现 member 集群的告警负载轻量化
==== **缺陷修复**
- 修复规则检查时间短暂出现零时间戳的问题
- 修复在告警页面使用多个过滤条件查询告警时数据未显示和分页异常等问题
==== **API 更新**
与 KubeSphere v3.5.0 相比API 更新主要体现在请求路径的变更上:
- 集群级别和项目级别的规则组和告警API 路径前缀由 `[apis|kapis]/clusters/{cluster}/alerting.kubesphere.io/v2beta1/` 更新为 `/proxy/alerting.kubesphere.io/v2beta1/clusters/{cluster}/`
- 全局级别的规则组和告警API 路径前缀由 `[apis/kapis]/alerting.kubesphere.io/v2beta1/` 更新为 `/proxy/alerting.kubesphere.io/v2beta1/`
- 对于内置的规则组,当可观测中心未启用时,通过集群级别规则组的 API 路径以及一个 `builtin=true` 的请求参数进行访问。例如请求
+
[,bash]
----
/proxy/alerting.kubesphere.io/v2beta1/clusters/{cluster}/[clusterrulegroups|clusteralerts]?builtin=true
----
+
可分别访问内置规则组和它们的告警
请求体和响应的数据结构保持不变。
更多细节请参考 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/altering-api_zh.md[API 文档]。
==== **其他**
- process-exporter-rules 规则组作为内置规则组,支持在启用可观测中心的场景下通过全局规则组进行管理
=== WhizardTelemetry 日志管理 v1.0.0
`WhizardTelemetry 日志管理` 是 WhizardTelemetry 可观测平台中用于日志采集、处理、存储和查询的扩展组件。
可通过该扩展组件部署与管理如下组件:
- logsidecar-injector 用于采集 Pod 中容器输出的落盘日志(不同于普通容器输出到 stdout 的日志)
- K8s 日志采集与转换
- 缺省的 OpenSearch sink
==== **新特性**
- 新增 Vector Agent 用于缺省的落盘日志采集
- 原每个集群都会部署的 OpenSearch 改为可以多集群共用,不同的集群会创建以集群名称为前缀的 index
- 支持一部分集群(可用区 a 或部门 a输出日志到一个 OpenSearch另一部分集群可用区 b 或部门 b输出日志到不同的 OpenSearch经过配置后可在同一日志控制台进行查询。具体细节请参考 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/logging-README_zh.md[README]
==== **缺陷修复**
- 修复日志查询前端页面访问缓慢的问题
==== **弃用**
- 原用作采集落盘日志的 filebeat 已被废弃并将在后续版本移除
=== WhizardTelemetry 事件管理 v1.0.0
`WhizardTelemetry 事件管理` 是 WhizardTelemetry 可观测平台中用于 Kubernetes 原生事件导出的扩展组件。该扩展组件可以部署与管理 kube-events-exporter。主要负责
- 收集 Kubernetes 原生事件并导出到 stdout
- 由 Vector Agent 收集落盘的 Kubernetes 事件日志并进行格式转换后,发送给用户指定的接收者如 OpenSearch
- UI 上支持查询各集群的 Kubernetes 事件日志
==== **新特性**
- 新增用于导出 Kubernetes 原生事件的 kube-events-exporter
- Kubernetes 事件由之前的 Webhook 方式接收改为由 Vector Agent 收集由 kube-events-exporter 输出到 stdout 进而落盘的 Kubernetes 事件,并发送到 OpenSearch 等用于归档或查询
==== **弃用**
- 弃用并移除原 kube-events 项目定义的 CRDsRuler 及 Controller
=== WhizardTelemetry 审计管理 v1.0.0
`WhizardTelemetry 审计管理` 是 WhizardTelemetry 可观测平台中用于对 Kubernetes 和 KubeSphere 的审计信息进行归档和查询的扩展组件。该扩展组件主要负责:
- 由 Vector Agent 收集落盘的 Kubernetes 及 KubeSphere 审计日志并进行格式转换
- 转换后的审计日志被发送给用户指定的接收者如 OpenSearch
- UI 上支持查询各集群的审计日志
==== **优化**
- 审计日志收集由之前的 Webhook 方式接收改为由 Vector Agent 收集落盘的审计日志文件
==== **弃用**
- 原接收审计日志的 Webhook 已被弃用并移除
- 原定义审计告警规则的 CRD Rule.auditing.kubesphere.io 已被弃用并移除
=== WhizardTelemetry 通知管理 v2.5.1
`WhizardTelemetry 通知管理` 是 WhizardTelemetry 可观测平台中提供通知功能的扩展组件可提供电子邮件、Slack、企业微信、钉钉、飞书、Webhook 等多渠道通知功能。
可通过该扩展组件部署与管理如下组件:
- Notification Manager
- Notification History
- Alertmanager
- Alertmanager Proxy
==== **新特性**
- 支持通知历史配置接收者
==== **优化**
- 优化通知历史收集方式,移除 notification adaptor 组件
- 支持在通知中显示 receiver 名称
- 支持为 notification manager deployment 添加注解和标签
==== **缺陷修复**
- 修复正则匹配会匹配所有告警的问题
- 修复编辑订阅条件,选择过滤条件为“包含”后,页面白屏的问题
==== **弃用**
- v2beta1 版本的 CRD 已被移除
- 移除 notification adaptor 组件
==== **其他**
- Notification Manager 升级至 v2.5.1
- Alertmanager 升级至 v0.26.0
=== WhizardTelemetry 事件告警 v1.0.0
`WhizardTelemetry 事件告警` 是 WhizardTelemetry 可观测平台中提供事件告警功能的扩展组件,它可以为 K8s 原生事件和 K8s/KubeSphere 审计事件定义告警规则,对传入的事件数据进行评估,并将告警发送到指定的接收器如 HTTP 端点。
此为本扩展组件的第一个正式版本,适配 KubeSphere v4.1.0。
==== **新特性**
- 为发出的告警新增 `cluster` 字段以区分事件告警来自于哪个集群
- 支持通过配置接收器将消息发送至 Webhook 或其他目的地,如 host 集群上部署的 Alertmanager Proxy: `http://< host node ip >:31093/api/v1/alerts`
==== **优化**
- 合并原 `kube-events` 与 `kube-auditing` 项目中根据告警规则对 K8s 原生事件与 K8s/KubeSphere 审计事件进行评估的功能到 `WhizardTelemetry 事件告警`
- 合并原 `kube-events` 与 `kube-auditing` 项目中各自的告警规则至同一个 CRD `ClusterRuleGroup.logging.whizard.io`
=== OpenSearch 分布式检索与分析引擎 v2.11.1
`OpenSearch 分布式检索与分析引擎` 是 WhizardTelemetry 可观测平台中内置的分布式检索与分析引擎, 是用于存储、检索与分析日志、审计、事件、通知历史等可观测数据的扩展组件。
可通过该扩展组件部署与管理如下组件:
- OpenSearch 的 Master 节点
- OpenSearch 的 Data 节点
- OpenSearch Dashboard
- OpenSearch Curator (用于定期清理过期数据)
==== **优化**
- 调整 OpenSearch Data 节点的 Service 为 NodePort 类型(端口 30920
- 降低 OpenSearch Master 节点与 Data 节点请求的 CPU 与 Memory
- 调整 OpenSearch Curator 索引清理规则
==== **其他**
- OpenSearch 升级至 v2.11.1
- OpenSearch Dashboard 升级至 v2.11.1
=== WhizardTelemetry 数据流水线 v1.0.0
`WhizardTelemetry 数据流水线` 是 WhizardTelemetry 可观测平台中提供可观测性数据收集、转换和路由能力的扩展组件。
==== **新特性**
- 原用于日志、审计、事件、通知历史等信息采集的 Agent 由 Fluent Bit 替换为 Vector Agent
- 新增 Vector Aggregator 用于部署到 host 集群收集通知历史等信息
- 为 Vector 新增 vector-config sidecar 容器,用于监听存储 Vector 配置的 Secret并自动生成 Vector 的配置文件
- 定制 Vector Helm Chart 使得可以将 Vector 配置存储在 Secret取代 Vector 上游将包含敏感信息的 Vector 配置存储在 ConfigMap 的做法
==== **弃用**
- 原用于日志、审计、事件、通知历史等信息采集的 Fluent Bit 及 FluentBit Operator 已被弃用并移除
== 平台管理
=== 应用商店管理 v2.0.0
`应用商店管理` 是一个基于 OpenPitrix 自研的多云应用管理平台,用于上传、审核并管理多云环境中不同类型的应用。
在 v2.0.0 中,进一步提升仓库应用的同步性能,支持使用 YAML 文件创建应用模板。
==== **新特性**
- 支持应用上传、统一审核与上下架管控
- 支持使用 YAML 文件创建应用模板
- 支持外置 S3 对象存储
- 支持全局应用仓库配置
- 支持更细粒度的权限配置,包含应用、应用版本、应用实例的查看、创建、删除与整体管理
==== **优化**
- 优化产品交互,划定 KubeSphere 应用商店与应用商店管理的功能边界
- 移除内置的开源仓库和开源应用模板
- 提升仓库应用的同步性能
==== **缺陷修复**
- 修复安装 helm 应用 CRD 不能立即使用的问题
==== **弃用**
- 移除 openpitrix.io/v1 系列的 API
- 移除 manifests.application.kubesphere.io 系列 API
==== **API 更新**
- 增加创建 YAML 应用的 API
- 使用 KubeSphere 平台统一的分页,筛选条件查询
=== 服务网格 v1.0.0
`服务网格` 是一款强大的微服务治理与微服务可视化管理工具。它提供包括蓝绿部署、金丝雀发布与流量镜像三种灰度发布策略,与流量监控、链路追踪两项可观测能力。
==== **新特性**
- 支持更细粒度的权限配置,包含服务网格管理与查看
==== **优化**
- 优化产品交互,改变“自制应用”与“灰度发布”的入口位置
==== **其他**
- Istio 从 v1.14.6 升级至 v1.16.5
- Kiali 从 v1.50 升级至 v1.59
- Jaeger 从 v1.29 升级至 v1.35
=== Spring Cloud v1.0.0
`Spring Cloud` 是一个提供微服务、微服务配置和微服务网关功能的扩展组件。
==== **新特性**
- 支持更细粒度的权限配置,包含 Spring Cloud 的管理与查看
==== **优化**
- 减少 spring-cloud-controller 中不必要的日志记录
- 存量项目下启用 Spring Cloud 功能时增加友好提醒
==== **其他**
- spring-cloud-controller 从 v0.1.0 升级至 v0.1.1
=== 多集群代理连接 v1.0.0
`多集群代理连接` 是一种通过代理在集群间建立网络连接的工具。如果主集群无法直接访问成员集群,您可以暴露主集群的代理服务地址,这样可以让成员集群通过代理连接到主集群。
该扩展组件将 KubeSphere v3.5.0 中的多集群代理连接模块,基于全新的微内核架构 KubeSphere LuBan 重构,整体功能没有改变。
=== 联邦集群应用管理 v1.0.0
`联邦集群应用管理` 是一个旨在简化跨多个联邦 Kubernetes 集群管理应用程序的扩展组件,用户可以轻松地在多个联邦集群中部署、更新和管理应用程序,同时提供灵活的配置选项以满足不同需求。
该扩展组件将 KubeSphere v3.5.0 中的多集群项目模块,基于全新的微内核架构 KubeSphere LuBan 重构,整体功能没有改变。
=== KubeEdge 边缘计算框架 v1.0.0
`KubeEdge 边缘计算框架` 是 KubeEdge 的扩展组件,可将本机容器化应用编排和管理扩展到边缘端设备。
可通过该扩展组件部署与管理如下组件:
- cloudcore: 提供云端接入功能
- frontend: 提供前端界面功能
==== **其他**
- 该扩展组件暂时只支持 host 集群
=== Metrics Server v0.7.0
`Metrics Server` 是一个可扩展、高效的容器资源度量源,为 Kubernetes 内置的自动扩展管道提供服务。
该扩展组件将 link:https://github.com/kubernetes-sigs/metrics-server[metrics-server] 基于全新的微内核架构 KubeSphere LuBan 重构,其代码、镜像等没有改变。
==== **其他**
- metrics-server 从 v0.4.2 升级至 v0.7.0
== 数据库与中间件
=== RadonDB DMP v2.1.0
`RadonDB DMP` 扩展组件提供数据库/中间件的可视化统一管理界面,支持数据库/中间件实例的全生命周期管理与运维。支持手动备份、自动化备份、从备份中恢复等功能;支持监控指标展示和告警功能(需安装可观测组件)。支持以下数据库/中间件MySQL、PostgreSQL、MongoDB、Redis、OpenSearch、Kafka、RabbitMQ。
==== **新特性**
- 支持通过编辑 YAML 的方式修改数据库实例
- 支持独立配置数据库备份 S3 地址
==== **缺陷修复**
- 修复在命令行直接修改数据库配置会被重置的问题
- 修复 Logstash 没有关联 role 导致无法写入 OpenSearch 数据的问题
- 修复 OpenSearch 监控按条件查询无响应的问题
- 调整 PostgreSQL 的资源规格避免内存不足导致 pod 重启
==== **弃用**
- 弃用 `manifests.application.kubesphere.io`
==== **已知问题**
- MySQL 集群的备份恢复功能需要手动修复
- PostgreSQL 集群的备份恢复功能需要手动修复
== DevOps
=== DevOps v1.1.0
`KubeSphere DevOps 系统` 是专为 Kubernetes 中的 CI/CD 工作流设计的。它提供一站式的解决方案,帮助开发和运维团队用非常简单的方式构建、测试和发布应用到 Kubernetes。具有**插件管理、代码依赖缓存、代码质量分析、流水线日志**等功能,**兼容第三方私有镜像仓库(如 Harbor和代码库如 GitLab/GitHub/SVN/BitBucket**。为用户提供全面的、可视化的 CI/CD 流水线,打造极佳的用户体验,而且这种兼容性强的流水线能力在离线环境中非常有用。
与 KubeSphere v3.5.0 相比,该扩展组件不仅修复了已知问题,完善了功能,优化了使用体验,而且为适配 KubeSphere v4.1.0,大量减少了对 KubeSphere Core 的依赖,使 DevOps 组件更加独立,版本管理更加灵活。
==== **新特性**
- 部署时自动识别运行时环境,以便自动适配 Agent 镜像
- 支持查看已取消的流水线详情
- 调整 DevOps RoleTemplates 适配 KubeSphere LuBan IAMDevOps 权限管理更加灵活便捷
==== **优化**
- 支持流水线详情页日志查看功能
- 优化 devops-controller 日志输出,信息更明确
- 调整多分支流水线关于过期分支清理的描述
==== **缺陷修复**
- 修复 devops-controller 由于流水线 cloneOptions.time 为空导致启动失败的问题
- 修复流水线中定义的参数未传到 Jenkins 服务的问题
- 修复流水线“打印消息”步骤包含双引号时报错的问题
- 修复多分支流水线里附件下载失败的问题
- 修复回放运行流水线失败的问题
- 修复查询 DevOps 项目别名过滤无效的问题
==== **已知问题**
- 镜像构建器S2I、B2I功能在此版本暂不可用
- kubeconfig 类型的凭证在此版本暂不可用
==== **API 更新**
- ks-core 中 DevOps 相关 APIs 移动到此扩展组件中,路径中 `kapis/tenant.kubesphere.io/v1alpha2` 更新为 `kapis/devops.kubesphere.io/v1alpha3`
- 请求路径中把 DevOps 视为普通 Namespace即把路径中 `devops` 改成 `namespaces` 如: `kapis/devops.kubesphere.io/v1alpha3/workspaces/../devops/../` 更新为 `kapis/devops.kubesphere.io/v1alpha3/workspaces/../namespaces/../`
- DevOps 项目成员管理 API 更新: `kapis/iam.kubesphere.io/v1alpha2/devops/../members` 更新为 `kapis/iam.kubesphere.io/v1beta1/namespaces/../namespacemembers`
- DevOps 项目角色管理 API 更新:`kapis/iam.kubesphere.io/v1alpha2/devops/../roles?annotation=kubesphere.io/creator` 更新为 `kapis/iam.kubesphere.io/v1beta1/namespaces/../roles?annotation=kubesphere.io/creator`
- DevOps 项目权限项管理 API 更新:`kapis/iam.kubesphere.io/v1alpha2/devops/../roles?label=iam.kubesphere.io/role-template=true` 更新为 `kapis/iam.kubesphere.io/v1beta1/roletemplates?labelSelector=iam.kubesphere.io/scope=namespacedevops.kubesphere.io/managed=true`
==== **其他**
- 更新 devops-jenkins 认证方式为 ks-core OpenId Connect Authentication移除对 LDAP 认证方式的依赖
== 网络
=== 网关 v1.0.0
`网关` 是聚合服务、管理 KubeSphere 平台外部访问的扩展组件。基于全新的微内核架构 KubeSphere LuBan 重构,支持一键启用和管理集群网关、企业空间网关、项目网关,帮助企业实现各层级网络配置的全覆盖。
==== **新特性**
- 调整网关的架构,便于解耦不同厂商的网关
- 整合网关创建、编辑时的配置步骤
- 通过编辑网关 YAML 管理网关 values 中所有配置项
- 可配置通过 NodePort 对外暴露时展示网关地址
- 支持更细粒度的权限配置,包含网关管理与查看
==== **缺陷修复**
- 修复网关日志导出异常的 bug
==== **弃用**
- 移除 Gateway v1alpha1 CRD
- 移除 Nginx v1alpha1 CRD
==== **API 更新**
- 新增 Gateway v2alpha1 CRD
==== **其他**
- nginx-ingress 从 v1.3.1 升级至 v1.4.0
=== 网络 v1.0.0
`网络` 扩展组件基于全新微内核架构 KubeSphere LuBan 重构,功能基本与 KubeSphere v3.5.0 中网络模块的功能一致,目前包含有 IPPool 和 NetworkPolicy 的管理配置,同时也有一部分架构的变化和新特性的增加。
- IPPool 弃用原有的 KubeSphere 封装的管理方式ippools.network.kubesphere.io直接管理 calico ippoolippools.crd.projectcalico.org避免与其他的第三方管理工具冲突同时支持 calico ippool 更多字段的配置。
- NetworkPolicy 主要优化用户在项目网络隔离的外部白名单的操作友好性。
==== **新特性**
- 支持用户通过 YAML 创建 IP 池以及 YAML 的动态编辑
- 支持 IP 池 nodeSelector、NatOutgoing 等更多字段的 UI 化配置
- 支持项目网络隔离外部白名单的端口范围的配置
- 支持项目网络隔离外部白名单的多网段、多端口的配置
- 支持项目网络隔离外部白名单的配置、基本信息的动态修改
==== **弃用**
- 弃用 ippool 绑定到企业空间,但支持原生 calico ippool 绑定 namespace 的操作
- 移除 network.kubesphere.io/v1alpha1 中的 ippools、ipamblocks、ipamhandles
==== **API 更新**
- ippool 更新为 ippools.crd.projectcalico.org/v1更多 API 细节可参考 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/network-api_doc.md[Network API 参考]及 link:https://yunify-qingcloud-docs.pek3b.qingstor.com/docs/kse/v4.1/network-swagger.yaml[Swagger]
== 安全
=== Gatekeeper v1.0.0
link:https://github.com/open-policy-agent/gatekeeper[Gatekeeper] 是一个用于 Kubernetes 可灵活配置策略的准入控制器,使用 link:https://www.openpolicyagent.org/[Open Policy Agent (OPA)] 验证在 Kubernetes 集群上创建和更新资源的请求。
借助 Gatekeeper 可以灵活地定义准入策略,在集群层面强制执行安全准入审查,从而确保 Kubernetes 集群的稳定性和安全合规性。
==== **新特性**
- 支持在集群层面配置安全准入策略
== 存储
=== 存储 v1.0.0
`存储` 扩展组件包含多个存储相关的实用工具。
可通过该扩展组件部署与管理如下组件:
- snapshot-controller: 用于为 PVC 创建快照。
- snapshotclass-controller: 用于为快照计数。
- pvc-auto-resizer: 用于为 PVC 在容量不足的情况下实现自动扩容。
- storageclass-accessor: 提供准入控制器,用来验证是否准许在某个命名空间或企业空间创建 PVC。
==== **优化**
- 提高存储类授权规则的验证速度
- 提高自动扩展的响应速度
==== **其他**
- snapshot-controller 升级至 v4.2.1

View File

@ -9,4 +9,4 @@ icon: "/images/docs/common/docs.svg"
---
本节介绍 KubeSphere v4.1.0 的版本更新记录。
本节介绍 KubeSphere 的版本更新记录。

View File

@ -0,0 +1,89 @@
---
title: "3.3.0 版本说明"
keywords: "Kubernetes, KubeSphere, 版本说明"
description: "KubeSphere 3.3.0 版本说明"
linkTitle: "3.3.0 版本说明"
weight: 50
---
## DevOps
### 新特性
- 提供了基于 GitOps 的持续部署方案,底层支持 Argo CD可以实时查看持续部署的状态。
- 支持配置持续部署白名单,限制持续部署的目标代码仓库和部署位置。
- 支持导入并管理代码仓库。
- 新增多款基于 CRD 的内置流水线模板,支持参数自定义。
- 支持查看流水线事件。
## 存储
### 新特性
- 支持租户级存储类权限管理。
- 新增卷快照内容和卷快照类管理。
- 支持 deployment 与 statefulSet 资源调整存储卷声明修改后自动重启。
- 支持存储卷声明设定使用阈值自动扩容。
## 多租户和多集群
### 新特性
- 支持 kubeconfig 证书到期提示。
- 支持 kubesphere-config configmap 以显示当前集群的名称。
- 支持集群层级的成员管理。
## 可观察性
### 新特性
- 增加容器进程/线程监控指标。
- 支持监控节点用量。
- 支持导入 Grafana 模板实现自定义监控看板。
- 支持为容器日志、资源事件和审计日志指定不同的数据保存时间。
### 优化增强
- Alertmanager 从 v0.21.0 升级至 v0.23.0。
- Grafana 从 7.4.3 升级至 8.3.3。
- kube-state-metrics 从 v1.9.7 升级至 v2.3.0。
- node-exporter 从 v0.18.1 升级至 v1.3.1。
- Prometheus 从 v2.26.0 升级至 v2.34.0。
- Prometheus Operator 从 v0.43.2 升级至 v0.55.1。
- kube-rbac-proxy 从 v0.8.0 升级至 v0.11.0。
- configmap-reload 从 v0.3.0 升级至 v0.5.0。
- Thanos 从 v0.18.0 升级至 v0.25.2。
- kube-events 从 v0.3.0 升级至 v0.4.0。
- Fluent Bit Operator 从 v0.11.0 升级至 v0.13.0。
- Fluent Bit 从 v1.8.3 升级至 v1.8.11。
## KubeEdge 集成
### 新特性
- 支持节点终端,可以直接在 UI 上登陆集群节点,包括边缘节点。
### 优化增强
- KubeEdge 版本从v1.7.2 升级到 v1.9.2。
- 移除 EdgeWatcher。
## 网络
### 优化增强
- 负载均衡类型选择新增 OpenELB。
### 问题修复
- 修复了删除项目后项目网关遗留的问题。
## App Store
### 问题修复
- 修复 Helm Controller NPE 错误引起的 ks-controller-manager 崩溃。
## 验证和授权
### 新特性
- 支持手动启用/禁用用户。
## 用户体验
- 新增 Kubernetes 审计日志开启提示。
- 支持容器生命周期管理。
- 支持应用整个配置字典或保密字典文件。
- 支持在**流量监控**页签选择时间段。
- 新增在**审计日志搜索** 对话框提醒用户开启审计日志的功能。
- 支持通过 `ClusterConfiguration` 配置更多 Istio 参数。
- 新增多语言支持,如土耳其语。
- 支持用户密码合规性检查。
- 新增在 webhook 设置页面将**访问令牌**设置为必填项的功能。
- 修复**服务拓扑**页面的服务详情区域数据未自动更新的问题。
- 修复“修改有状态服务时未显示服务名称”问题。
- 修复用户点击按钮过快造成的应用安装失败问题。
- 修复容器组探针删除后仍然显示的问题。
- 修复存储卷挂载到 init 容器时 statefulset 创建失败的问题。
- 优化了服务拓扑图详情展示窗口。
- 优化了 ClusterConfiguration 更新机制,无需重启 ks-apiserver、ks-controller-manager。
- 优化了部分页面文案描述。
有关 KubeSphere 3.3.0 的 Issue 和贡献者详细信息,请参阅 [GitHub](https://github.com/kubesphere/kubesphere/blob/master/CHANGELOG/CHANGELOG-3.3.md)。

View File

@ -0,0 +1,38 @@
---
title: "3.3.1 版本说明"
keywords: "Kubernetes, KubeSphere, 版本说明"
description: "KubeSphere 3.3.1 版本说明"
linkTitle: "3.3.1 版本说明"
weight: 49
---
## DevOps
### 优化增强
- 支持通过 UI 编辑流水线中 kubeconfig 文件绑定方式。
### 问题修复
- 修复用户查看 CI/CD 模板失败的问题。
- 将 `Deprecated` 标签从 CI/CD 模版中移除,并将部署环节由 `kubernetesDeploy` 修改为 kubeconfig 绑定方式。
## 网络
### 问题修复
- 修复 IPv4/IPv6 双栈模式下用户创建路由规则失败的问题。
## 存储
### 问题修复
- 当用户使用 `hostpath` 作为存储时,必须填写主机路径。
## 验证和授权
### 问题修复
- 删除角色 `users-manager``workspace-manager`
- 新增角色 `platform-self-provisioner`
- 屏蔽用户自定义角色的部分权限。
## 用户体验
- 支持修改每页列表的展示数量。
- 新增对 statefulset 和 deamonset 批量停止的支持
有关 KubeSphere 3.3.1 的 Issue 和贡献者详细信息,请参阅 [GitHub](https://github.com/kubesphere/kubesphere/blob/master/CHANGELOG/CHANGELOG-3.3.1.md)。

View File

@ -0,0 +1,97 @@
---
title: "3.3.2 版本说明"
keywords: "Kubernetes, KubeSphere, 版本说明"
description: "KubeSphere 3.3.2 版本说明"
linkTitle: "3.3.2 版本说明"
weight: 48
---
## DevOps
### 优化增强
- 添加最新的 GitHub Actions。
- 将 PipelineRun 的结果保存到 configmap 中。
- 修改持续部署应用程序状态的中文描述。
- 为持续部署参数添加更丰富的信息。
- 为处于中止状态的 PipelineRun 添加链接。
- 为 PipelineRun 增加 ID 列,用于执行 kubectl 命令时展示。
- PipelineRun 生命周期中去掉 Queued 状态。
### 问题修复
- 修复用户修改并保存流水线配置后 Webhook 配置丢失的问题。
- 修复下载 DevOps 流水线制品失败的问题。
- 修复使用 JAR/WAR 文件创建服务时,镜像地址不匹配的问题。
- 修复 PipelineRun 从“取消”状态变成“未运行”状态的问题。
- 修复 Pipeline 的自动清理策略,使其与 Jenkins 的清理保持一致。
## App Store
### 问题修复
- 修复上传的应用程序模板上不显示图标的问题。
- 修复应用商店应用信息处没有显示应用首页的问题。
- 修复应用商店导入内置应用时导入失败的问题。
- 修复 IPv6 环境下 UUID 生成错误的问题。
## 可观测性
### 问题修复
- 修复 logsidecar-injector 配置文件中的解析问题。
## 微服务
### 问题修复
- 修复未启用 service mesh 时创建的 Bookinfo 项目没有默认关闭应用治理的问题。
- 修复蓝绿部署发布模式下线按钮缺失的问题。
## 网络
### 优化增强
- 限制项目的网络隔离范围为当前企业空间。
## 存储
### 优化增强
- 在多集群环境中显示 system-workspace 所属集群。
- 将“应用路由”的英文词条由 “route” 修改为 “ingress”。
### 问题修复
- 修复编辑联邦项目中的持久卷声明存储类错误的问题。
## 验证和授权
### 优化增强
- 增加了动态的 cache 配置项。
- 移除“告警消息管理”权限。
### 问题修复
- 修复拥有集群管理权限的平台角色无法管理集群的问题。
## 开发 & 测试
### 问题修复
- 修复引入热加载功能后部分数据后处于“不同步”状态的问题。
- 修复 ks-apiserver 多次重载后崩溃的问题。
- 修复缺少必要的 CRD 造成的资源缓存失败问题。
- 修复 ks-apiserver 在 Kubernetes 1.24+ 版本中异常崩溃的问题。
- 修复审计功能中协程泄露的问题。
## 用户体验
- 限制集群名称长度。
- 修复 pod 副本不能自动刷新的问题。
- 修复删除服务时,相关的 pod 没有删除的问题。
- 修复只有一个节点时,节点数量和角色显示错误的问题。
有关 KubeSphere 3.3.2 的 Issue 和贡献者详细信息,请参阅 [GitHub](https://github.com/kubesphere/kubesphere/blob/master/CHANGELOG/CHANGELOG-3.3.2.md)。

View File

@ -0,0 +1,156 @@
---
title: "3.4.0 版本说明"
keywords: "Kubernetes, KubeSphere, 版本说明"
description: "KubeSphere 3.4.0 版本说明"
linkTitle: "3.4.0 版本说明"
weight: 47
---
## DevOps
### 优化增强
- 支持用户自定义流水线配置步骤。
- 优化 DevOps Jenkins JVM 内存配置。
### 问题修复
- 修复级联删除 ArgoCD 资源的问题。
- 修复多分支流水线下载制品失败的问题。
- 修复流水线运行状态与 Jenkins 不一致的问题(增加重试以同步状态)。
- 修复新建用户运行流水线一直等待中的问题。
## 存储
### 问题修复
- 修复 pvc 无法删除的问题。
## 网关和微服务
### 新特性
- 网关支持配置 TCP/UDP 流量转发。
### 优化增强
- 升级 ingress nginx 版本: v1.1.0 -> v1.3.1。
- 升级 servicemesh 组件版本istio: 1.11.1 -> 1.14.6kiali: v1.38.1 -> v1.50.1jaeger: 1.27 -> 1.29。
### 问题修复
- 修复返回集群网关数据重复的问题。
- 修复网关升级校验错误 。
- 修复更改网关命名空间配置后,集群网关日志和资源状态显示异常的问题。
## 可观测性
### 新特性
- 新增 RuleGroup, ClusterRuleGroup, GlobalRuleGroup 等 CRDs用于支持 Alerting v2beta1 APIs。
- 新增 RuleGroup, ClusterRuleGroup, GlobalRuleGroup 等资源的准入控制 webhook。
- 新增 Controllers将 RuleGroup, ClusterRuleGroup, GlobalRuleGroup 资源同步为 PrometheusRule 资源。
- 添加 Alerting v2beta1 APIs。
- 在 Kubesphere 的 ks-apiserver 中集成了 opensearch 的 v1 和 v2 版本,用户可以使用外置或内置的 opensearch 集群进行日志的存储和查询。(目前 Kubesphere 内置的 opensearch 版本为 v2
- ks-installer 集成了 opensearch 的 dashboard需要用户自行开启。
### 优化增强
- 升级 Prometheus 栈依赖。
- 支持配置最大日志导出数量。
- 监控组件部署支持 Kubernetes PDB Apiversion 变更。
- 升级 Notification Manager 到 v2.3.0。
- 支持删除集群时删除集群上的通知设置。
- 支持切换通知语言。
- 通知支持路由功能。
### 问题修复
- 修复潜在 Go 协程泄漏的问题。
- 修复 ingress P95 延迟时间 promql 语句。
## 多租户和多集群
### 优化增强
- 更新集群的时候校验集群 ID。
### 问题修复
- 确保在清理通知相关资源时集群状态正常。
- 修复针对新集群的校验问题。
- 修复集群状态信息不正确的问题。
- 限制企业空间授权集群不可重复。
## App Store
### 问题修复
- 修复 IPv6 环境下应用商店模块无法生成 ID 的问题。
- 修复应用模板 Home 字段缺失的问题。
- 修复应用模板图标缺失的问题。
- 修复应用模板缺少 Maintainers 字段的问题。
- 修复应用部署失败后无法重新部署的问题。
- 修复应用 ID 参数错误的问题。
- 修复部分应用无法正确安装的问题。
- 修复应用仓库状态不正确的问题。
## 网络
### 优化增强
- 升级依赖。
## 验证和授权
### 新特性
- 新增 inmemory cache。
- 新增 Resource Getter v1beta1。
- 新增 Resource Manager 写操作。
### 优化增强
- 新增 iam.kubesphere/v1beta1 RoleTemplate。
- 更新密码最小长度为 8 位。
- 修改 Version 的 API。
- 修改 identityProvider 的 API。
- 新增 IAM v1beta1 APIs。
### 问题修复
- 修复 enableMultiLogin 配置不生效的问题。
## API Changes
- 使用 autoscaling/v2 版本 API。
- 使用 batch/v1 版本的 API 。
- 更新 KubeSphere 健康检查 API。
- 修复 K8s 1.25 版本中 ks-apiserver 崩溃的问题。
## 用户体验
### 新特性
- Resource API 支持别名搜索。
### 问题修复
- 修复潜在 Websocket 链接泄漏的问题。
### 优化增强
- 使用 helm action 包代替直接使用 helm 二进制。
- 调整 kubectl terminal 中 bash 和 sh 的优先级。
- 修复由于 DiscoveryAPI 异常导致 ks-apiserver 无法启动的问题。
- 修复容器组列表页按状态查询时,显示的状态与筛选的结果不一致的问题。
- 查询 Secret 支持 fieldSelector 筛选。
有关 KubeSphere 3.4.0 的 Issue 和贡献者详细信息,请参阅 [GitHub](https://github.com/kubesphere/kubesphere/blob/master/CHANGELOG/CHANGELOG-3.4.0.md)。

View File

@ -0,0 +1,96 @@
---
title: "3.4.1 版本说明"
keywords: "Kubernetes, KubeSphere, 版本说明"
description: "KubeSphere 3.4.1 版本说明"
linkTitle: "3.4.1 版本说明"
weight: 46
---
## 应用商店
### 问题修复
- 修复应用仓库页面的报错。
- 修复应用审核报错。
- Appdeploy schemaform 支持 select。
## 控制台
### 问题修复
- 修复编辑 CRD 资源后,状态丢失的问题。
- 修复网络隔离页面的 IsolateInfo 和 RuleInfo 样式错误。
- 修复某些页面的中文翻译错误。
- 修复高版本 K8s 中,资源创建失败的问题。
- 修复最近访问面板中名称被遮挡的问题。
- 修复在列表页面点击定制内容按钮,内容显示不全。
- 修复容器状态显示错误。
- 修复在 PVC 页面设置卷容量时,数字显示有误。
- 修复添加容器页面,使用 tag 搜索 image 失效。
- 支持构建 ARM64 镜像。
## 多集群
### 问题修复
- 修复多集群中CD 关联集群显示错误。
- 修复主机集群被错误地添加为其他集群的成员集群。
## 可观测性
### 问题修复
- 修复 CPU 和内存统计图表不显示。
- 修复通知渠道页面API 调用错误。
- 修复日志接收器页面,显示空白。
- 修复新建通知渠道页面,条件过滤值丢失。
## 认证和授权
### 问题修复
- 修复 LDAP 登录失败。
## DevOps
### 问题修复
- 修复图形化编辑 Shell 不生效。
- 当集群未就绪或未安装 DevOps 时DevOps 项目不可用。
- 修复 jenkins 参数传递不正确的问题。
- 修复点击回放按钮时报错。
- 修复 Pipeline 详情无法查看的问题。
- 修复流水线日志过大引发的问题。
- 修复 Jenkins 镜像漏洞。
- 修复 DevOps 更新版本后无法正常使用的问题。
- 修复流水线清理任务报错。
- 修复设置 timeout 失败的问题。
- 修复多分支流水线下载制品失败的问题。
- 修复无法禁用已丢弃的历史 Pipelinerun。
- 修复级联删除多个应用程序时,一些应用程序资源未被删除的问题。
### 优化增强
- 在流水线页面显示 git 仓库地址。
- 完善 API 文档。
## 用户体验
### 问题修复
- 修复 Statefuls 页面缺少 Pod Grace Period 参数。
- 修复集群管理中,集群网关不显示。
- 修复创建应用路由报错。
- 在列出仓库标签时实现分页功能。
## 监控
### 问题修复
- 修复监控目标显示为空。
有关 KubeSphere 3.4.1 的 Issue 和贡献者详细信息,请参阅 [GitHub](https://github.com/kubesphere/kubesphere/blob/master/CHANGELOG/CHANGELOG-3.4.1.md)。

View File

@ -0,0 +1,174 @@
---
title: "4.1.1 版本说明"
keywords: "Kubernetes, KubeSphere, 版本说明"
description: "KubeSphere 4.1.1 版本说明"
linkTitle: "4.1.1 版本说明"
weight: 45
---
## KubeSphere
### 新特性
- 基于全新微内核架构 KubeSphere LuBan 重构
- 内置 KubeSphere 扩展市场
- 支持通过扩展中心统一管理扩展组件
- 支持 UI、API 扩展
- 支持通过 kubeconfig 一键导入 member 集群
- 支持 KubeSphere 服务帐户
- 支持动态扩展 Resource API
- 支持添加集群、企业空间、项目到快捷访问
- 支持通过容器终端进行文件上传和下载
- 支持适配不同厂商的云原生网关Kubernetes Ingress API
- 支持 API 限流
- 支持在页面创建持久卷
### 优化
- 创建企业空间时支持选取所有集群
- 优化 web kubectl支持 pod 动态回收、切换集群时支持模糊搜索
- 优化节点管理列表,将默认排序修改为升序
- 仅允许受信的 OAuth Client 直接使用用户名和密码对用户身份进行校验
- 精简 member 集群中部署的 Agent 组件
- 拆分 KubeSphere Config 中部分配置作为独立的配置项
- 容器镜像搜索调整为按时间倒序进行排序
- 支持编辑用户别名
- 集群列表新增调度状态的展示
- 配置字典详情页支持 binaryData 数据显示
- 重构工作台管理页面
- 删除不必要的扩展组件
- 支持通过 helm 快速部署和卸载
- 简化成员集群中 agent 的部署
- 支持禁用控制平面节点终端
- 支持主动触发集群资源同步
- 集群下工作负载页面的用户体验优化
- 应用列表页的用户体验优化
- 持久卷声明和存储类列表页的用户体验优化
- 资源名超长显示优化
- 支持全局开启 fieldValidation
- 集群节点的列表页支持横向移动
### 缺陷修复
- 修复节点终端一直显示 connecting 的问题
- 修复潜在的企业空间资源越权访问的问题
- 修复潜在的企业空间集群授权 API 越权访问的问题
- 修复因错误配置导致会话异常登出的问题
- 修复添加镜像服务信息从指定仓库拉取镜像时异常的问题
- 编辑保密字典编辑时 ownerReferences 丢失的问题
- 修复首次登录白屏和页面错误重定向的问题
- 修复 Windows 环境下,选择框滚动的问题
- 修复当 cluster-admin 登录时找不到集群管理入口的问题
- 修复 kubectl 容器终端关闭 pod 未停止的问题
- 修复 kubeconfig 下载时无法选择集群的问题
- 修复部分列表中资源名称过长无法完全显示的问题
- 修复部分页面文本翻译缺失的问题
- 修复容器详情页显示空白的问题
- 修复创建镜像服务地址选 https 时,默认跳过证书验证的问题
- 修复 member 集群的服务账户无法编辑项目角色的问题
- 修复无键值对的配置字典无法编辑设置的问题
- 修复 member 集群的配置字典无法编辑、删除键值对数据的问题
- 修复集群管理页面,移除未就绪集群时弹窗的样式问题
- 修复集群管理页面,移除集群时进度条的显示问题
- 修复在“添加标签到集群”的弹窗中,搜索集群后,之前已选中的集群选中状态消失
- 修复工作负载详情页的容器组未分页的问题
- 修复扩展组件详情页面的更新日志显示 HTML 注释的问题
- 修复在某些情况下列表页面的悬浮元素显示不完整的问题
- 修复右上角错误提示显示异常的问题
- 修复“创建企业空间”弹窗的样式问题
- 修复无法搜索 Harbor 2.8.0 及之后的版本)镜像的问题
- 修复在 https 协议下 console 加载缓慢的问题
- 创建集群时默认指定创建者为集群管理员
- 修复删除节点的标签数据时出现异常的问题
- 修复添加 member 集群时,页面未实时更新的问题
- 添加容器上传的提示信息
- 修复选择集群时,未根据用户权限过滤集群的问题
- 修复 helm 应用部署存在潜在的权限提升、越权风险
- 修复创建应用模板时上传文件卡住
- 修复项目中创建的应用在其他项目中也可见的问题
- 修复应用仓库的 bitnami 源无法同步的问题
- 修复应用模板显示无数据的问题
- 修复无权限用户在应用商店部署应用时白屏的问题
- 修复保密字典的类型显示错误
- 修复企业空间列表的显示问题
- 修复持久卷列表的状态错误
- 修复基于快照创建 pvc 失败的问题
- 删除持久卷扩容时的无用提示
- 修复创建保密字典时类型下拉框显示错误
- 修复创建“镜像服务信息”类型的保密字典时,数据填充错误
- 修复工作负载列表不能检索全部项目的问题
- 修复工作负载中容器组的提示信息显示异常
- 修复定制资源定义页面中显示的版本不是最新版本的问题
- 修复在集群列表搜索集群时的显示问题
- 修复 EKS 环境中 web kubectl 终端无法使用的问题
### API 更新
#### API 移除
v4.1 版本将停止提供以下 API
**多集群**
`/API_PREFIX/clusters/{cluster}/API_GROUP/API_VERSION/...` 多集群代理请求 API 被移除。请使用新的多集群代理请求路径规则代替,`/clusters/{cluster}/API_PREFIX/API_GROUP/API_VERSION/...`。
**访问控制**
- `iam.kubesphere.io/v1alpha2` API 版本被移除。请使用 `iam.kubesphere.io/v1beta1` API 版本代替。
- `iam.kubesphere.io/v1beta1` 中的显著变化:
Role、RoleBinding、ClusterRole、ClusterRoleBinding 资源的 API Group 从 `rbac.authorization.k8s.io` 变更为 `iam.kubesphere.io`
**多租户**
- `tenant.kubesphere.io/v1alpha1``tenant.kubesphere.io/v1alpha2` API 版本部分 API 被移除。请使用 `tenant.kubesphere.io/v1beta1` API 版本代替。
- `tenant.kubesphere.io/v1beta1` 中的显著变化:
`Workspace``spec.networkIsolation` 被移除。
**kubectl**
- `/resources.kubesphere.io/v1alpha2/users/{user}/kubectl` 接口已移除,终端相关操作无需再调用该接口
- 用户 web kubectl 终端 API 路径从 `/kapis/terminal.kubesphere.io/v1alpha2/namespaces/{namespace}/pods/{pod}/exec` 调整为 `/kapis/terminal.kubesphere.io/v1alpha2/users/{user}/kubectl`
**gateway**
`gateway.kubesphere.io/v1alpha1` API 版本被移除。
- 配置 Ingress 查询相关网关的 API 调整为 `/kapis/gateway.kubesphere.io/v1alpha2/namespaces/{namespace}/availableingressclassscopes`
#### API 弃用
以下 API 标记为弃用,将在未来的版本中移除:
- Cluster validation API
- Config configz API
- OAuth token review API
- Operations job rerun API
- Resources v1alpha2 API
- Resources v1alpha3 API
- Tenant v1alpha3 API
- Legacy version API
### 已知问题
- 目前不支持从 3.x 版升级到 4.x将在后续版本支持
- 以下功能暂不可用,之后将作为扩展组件提供:
* 监控
* 告警
* 通知
* Istio
* DevOps
* 项目网关和集群网关
* 卷快照
* 网络隔离
* 用于应用管理的 OpenPitrix
- 以下功能暂不可用,将在后续版本支持:
* 企业空间的部门管理功能
### 其他
- 默认移除除英文和简体中文之外的所有语言选项
- 移除系统组件相关内容

View File

@ -1,6 +1,5 @@
---
title: 文档中心
weight: 45
css: scss/docs.scss
isDocsRoot: true
LinkTitle: 文档
@ -15,23 +14,14 @@ sectionLink:
title: 常用文档
description: 通过快速入门、教程和示例等学习使用 KubeSphere。
list:
- /docs/v4.1/02-quickstart/01-install-ks-core
- /docs/v4.1/06-extension-user-guide/01-install-components-pdf.adoc
- /docs/v4.1/02-quickstart/01-install-kubesphere.adoc
- /docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc
- /docs/v4.1/02-quickstart/03-control-user-permissions.adoc
- /docs/v4.1/01-intro/01-introduction.adoc
- /docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/01-add-cluster-nodes.adoc
- /docs/v4.1/07-cluster-management/10-multi-cluster-management
- /docs/v4.1/10-toolbox
videos:
title: 视频教程
description: 观看视频教程学习 KubeSphere。
list:
- link: https://www.bilibili.com/video/BV1KA411s7D3
text: All-in-One 模式安装 KubeSphere
- link: https://www.bilibili.com/video/BV16y4y1v7cn
text: 多节点安装 KubeSphere
- link: https://www.bilibili.com/video/BV1Pz4y1C7jr
text: 离线安装 KubeSphere
- /docs/v4.1/09-project-management/06-project-settings/02-project-roles/01-create-a-project-role.adoc
- /docs/v4.1/06-extension-user-guide/01-install-components-pdf.adoc
- /docs/v4.1/10-toolbox/01-use-kubectl-tool.adoc
section3:
title: 在云服务上运行 KubeSphere 与 Kubernetes 技术栈

View File

@ -39,13 +39,13 @@ footer:
- title: 文档中心
list:
- content: 产品介绍
link: '../../../zh/docs/v3.4/introduction/what-is-kubesphere/'
link: '../../../zh/docs/v4.1/introduction/what-is-kubesphere/'
- content: 如何安装
link: '../../../zh/docs/v3.4/quick-start/all-in-one-on-linux/'
link: '../../../zh/docs/v4.1/quick-start/all-in-one-on-linux/'
- content: 快速入门
link: '../../../zh/docs/v3.4/quick-start/create-workspace-and-project/'
link: '../../../zh/docs/v4.1/quick-start/create-workspace-and-project/'
- content: API 文档
link: '../../../zh/docs/v3.4/reference/api-docs/'
link: '../../../zh/docs/v4.1/reference/api-docs/'
- title: 开源社区
list:

View File

@ -4,4 +4,3 @@ User-agent: *
Disallow: {{ .RelPermalink }}
{{ end }}
{{ end }}
Disallow: /zh/docs/v4.1/