diff --git a/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc b/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc index 5f2b04a08..daa60bfc3 100644 --- a/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc +++ b/content/zh/docs/_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc @@ -1,2 +1,2 @@ // :ks_include_id: f3341457c4584e59b799240a35ca496d -您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 +您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅“集群成员”和“集群角色”。 diff --git a/content/zh/docs/_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc b/content/zh/docs/_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc index 0af0397f4..072183001 100644 --- a/content/zh/docs/_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc +++ b/content/zh/docs/_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 95e415bcbafa45ed8545cb7700801b09 -您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:05-users-and-roles/01-users/[用户]和xref:05-users-and-roles/02-platform-roles/[平台角色]。 +您需要在{ks_product_both}平台具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅“用户”和“平台角色”。 diff --git a/content/zh/docs/_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc b/content/zh/docs/_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc index 03dd264e1..0ef9a87f0 100644 --- a/content/zh/docs/_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc +++ b/content/zh/docs/_custom/projectManagement/projectManagement-prer-requiredPermission_new.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 6579f3ef4c70439ca10c8e8de94ce9fb -您需要加入一个项目并在项目中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:09-project-management/06-project-settings/03-project-members/[项目成员]和xref:09-project-management/06-project-settings/02-project-roles/[项目角色]。 +您需要加入一个项目并在项目中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅“项目成员”和“项目角色”。 diff --git a/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc b/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc index a574caac3..211c56c0c 100644 --- a/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc +++ b/content/zh/docs/_custom/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc @@ -1,2 +1,2 @@ // :ks_include_id: 05d7ebe027f04cc589e8baa04343e651 -您需要加入一个企业空间并在企业空间中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:08-workspace-management/06-workspace-settings/03-workspace-members/[企业空间成员]和xref:08-workspace-management/06-workspace-settings/04-workspace-roles/[企业空间角色]。 +您需要加入一个企业空间并在企业空间中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅“企业空间成员”和“企业空间角色”。 diff --git a/content/zh/docs/v4.1/02-quickstart/01-install-ks-core.adoc b/content/zh/docs/v4.1/02-quickstart/01-install-ks-core.adoc index 5e6118829..db1939179 100644 --- a/content/zh/docs/v4.1/02-quickstart/01-install-ks-core.adoc +++ b/content/zh/docs/v4.1/02-quickstart/01-install-ks-core.adoc @@ -178,23 +178,23 @@ sudo apt install socat conntrack ebtables ipset -y ---- kse-all-v4.1.0-offline-linux-amd64/ ├── charts -│   ├── ks-core # KubeSphere 企业版核心组件 -│   ├── kse-extensions-publish # 用于发布 KubeSphere 企业版扩展组件 +│   ├── 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 企业版升级脚本，提供快速升级能力 +│ ├── pre-check.sh # 用于 KubeSphere 升级前的集群环境检查 +│ ├── backup.sh # 用于 KubeSphere 升级前备份系统企业空间中的关键资源 +│ └── upgrade.sh # KubeSphere 升级脚本，提供快速升级能力 │ ├── oras # OCI 工具，便于镜像同步等操作 │ └── ks-core-values.yaml # 升级配置示例文件，用于配置各组件的升级参数 -├── kse-extensions # 其中包含所有扩展组件的 installplan，可用于快速安装 KubeSphere 企业版扩展组件 +├── kse-extensions # 其中包含所有扩展组件的 installplan，可用于快速安装 KubeSphere 扩展组件 ├── config-sample.yaml # 安装配置文件的模版 ├── create_project_harbor.sh # 用于快速创建 harbor 项目 ├── kk # 集群部署工具 -├── kubekey-artifact.tar.gz # KubeSphere 企业版制品，其中包含集群部署所需的二进制文件及镜像 -└── manifest-v410-amd64.yaml # KubeSphere 企业版制品清单，其中包含各组件的版本以及镜像列表 +├── kubekey-artifact.tar.gz # KubeSphere 制品，其中包含集群部署所需的二进制文件及镜像 +└── manifest-v410-amd64.yaml # KubeSphere 制品清单，其中包含各组件的版本以及镜像列表 ---- diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/03-configure-high-availability.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/03-configure-high-availability.adoc index 9dc101467..a64b87ec6 100644 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/03-configure-high-availability.adoc +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/03-configure-high-availability.adoc @@ -40,7 +40,7 @@ spec: ---- -KubeKey 将自动在工作节点上安装 HAProxy 并完成高可用配置，您无需进行其他操作。有关更多信息请参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere 企业版]。 +KubeKey 将自动在工作节点上安装 HAProxy 并完成高可用配置，您无需进行其他操作。有关更多信息请参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere]。 == 使用专用负载均衡器 如需使用云环境提供的专用负载均衡器实现高可用性，您需要在云环境中进行以下操作： diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/04-configure-neosan-csi.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/04-configure-neosan-csi.adoc index 0002895b0..e45f27a27 100644 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/04-configure-neosan-csi.adoc +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/01-preparations/04-configure-external-persistent-storage/04-configure-neosan-csi.adoc @@ -15,7 +15,7 @@ NeonSAN 是青云的一款企业级分布式块存储系统，NeonSAN CSI 是 Ne == 前提条件 -- 您已经成功部署 NeonSAN v2.2.0 及以上版本，且容器集群的每个节点都已安装 QBD 与 NeonSAN 连通。具体操作请咨询 KubeSphere 企业版技术支持人员。 +- 您已经成功部署 NeonSAN v2.2.0 及以上版本，且容器集群的每个节点都已安装 QBD 与 NeonSAN 连通。具体操作请咨询 KubeSphere 技术支持人员。 - 您已经安装 Kubernetes v1.16 及其以上版本。 - 您已经在容器集群的 master 节点安装了 Helm。本节以 Helm 3 为例。 @@ -328,5 +328,5 @@ $ docker images . 参考link:#_在线安装_neonsan_csi[在线安装]中步骤 8 - 12 执行安装后检查。 + -- -NeonSAN CSI 安装成功后，您可以在 KubeSphere 企业版控制台上的**存储**区域查看。 +NeonSAN CSI 安装成功后，您可以在 KubeSphere 控制台上的**存储**区域查看。 -- diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc index 4ec98ce98..20baa2817 100644 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc @@ -177,23 +177,23 @@ sudo apt install socat conntrack ebtables ipset -y ---- kse-all-v4.1.0-offline-linux-amd64/ ├── charts -│   ├── ks-core # KubeSphere 企业版核心组件 -│   ├── kse-extensions-publish # 用于发布 KubeSphere 企业版扩展组件 +│   ├── 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 企业版升级脚本，提供快速升级能力 +│ ├── pre-check.sh # 用于 KubeSphere 升级前的集群环境检查 +│ ├── backup.sh # 用于 KubeSphere 升级前备份系统企业空间中的关键资源 +│ └── upgrade.sh # KubeSphere 升级脚本，提供快速升级能力 │ ├── oras # OCI 工具，便于镜像同步等操作 │ └── ks-core-values.yaml # 升级配置示例文件，用于配置各组件的升级参数 -├── kse-extensions # 其中包含所有扩展组件的 installplan，可用于快速安装 KubeSphere 企业版扩展组件 +├── kse-extensions # 其中包含所有扩展组件的 installplan，可用于快速安装 KubeSphere 扩展组件 ├── config-sample.yaml # 安装配置文件的模版 ├── create_project_harbor.sh # 用于快速创建 harbor 项目 ├── kk # 集群部署工具 -├── kubekey-artifact.tar.gz # KubeSphere 企业版制品，其中包含集群部署所需的二进制文件及镜像 -└── manifest-v410-amd64.yaml # KubeSphere 企业版制品清单，其中包含各组件的版本以及镜像列表 +├── kubekey-artifact.tar.gz # KubeSphere 制品，其中包含集群部署所需的二进制文件及镜像 +└── manifest-v410-amd64.yaml # KubeSphere 制品清单，其中包含各组件的版本以及镜像列表 ---- diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/03-upgrade-kubephere.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/03-upgrade-kubephere.adoc deleted file mode 100644 index 8b2cb3dc2..000000000 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/03-upgrade-kubephere.adoc +++ /dev/null @@ -1,492 +0,0 @@ ---- -title: "升级 KubeSphere 企业版" -linkTitle: "升级 KubeSphere 企业版" -keywords: "Kubernetes, KubeSphere, 安装, 升级 KubeSphere" -description: "介绍如何升级 KubeSphere。" -weight: 03 ---- - -本节介绍如何在保持当前的 Kubernetes 版本不变的情况下从{ks_product_both} v3.5.0 升级到{ks_product_both} v4.1.0。 - - -== 前提条件 - -* 您需要联系{ks_product_both}的服务支持团队获取{ks_product_left} v4.1.0 安装包，以及 license。 - -// 如实施现场条件允许在线拉取公开仓库，具备在线安装条件，可联系 KubeSphere 产品团队获取在线安装文件及相关信息。 - -* 请确保当前{ks_product_both}版本为 v3.5.0。如果您的{ks_product_both}版本低于 v3.5.0，请先将{ks_product_both}版本升级到 v3.5.0。 - -* 请确保当前 Kubernetes 版本为 v1.21.x、v1.22.x、v1.23.x, v1.24.x, v1.25.x, v1.26.x, v1.27.x 或 v1.28.x。 - -// :relfileprefix: ../../../ - -// include::../../../_custom/installationAndUpgrade/installationAndUpgrade-prer-offlineInstallation.adoc[] - -// :relfileprefix: ./ - -* {empty} -include::../../../_custom/installationAndUpgrade/installationAndUpgrade-prer-backUpData.adoc[] - -== 准备工作 - -. 将{ks_product_both} v4.1.0 安装包传输到所有集群的节点上。 -+ -[.admon.note,cols="a"] -|=== -|说明 - -| -若想了解安装包中各个文件的作用，请参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/#_查看安装包内容[查看安装包内容]。 -|=== - -. 使用 **backup.sh** 备份系统企业空间（system-workspace）下所有项目中的关键资源，以及备份所有自定义角色及权限相关资源。 -+ --- -执行以下命令开始备份。相关资源将备份至 **backup-$timestamp** 目录下。 - -[,bash] ----- -bash backup.sh ----- - -备份完成后，如下图所示。 - -image:/images/ks-qkcp/zh/v4.1/backup.png[ backup, 100%] --- - -. 联系{ks_product_both}的服务支持团队，根据当前集群的 cc.yaml 中的配置和 KubeSphere 组件的 patch 情况（如 cc.yaml 外的配置），确定升级时各组件使用的参数，然后创建 **ks-core-values.yaml** 文件。可参阅安装包中的 ks-core-values.yaml 示例文件。 -+ --- -[.admon.attention,cols="a"] -|=== -|注意 - -| -* 在 ks-core-values.yaml 文件中，可将集群中没有启用的组件设置为 enabled: false。core 和 iam 组件必须配置为 enabled: true，不可禁用。 - -* 部分扩展组件在特定情况下（比如依赖外部服务的访问地址等），升级时不能使用**默认配置**，需手动配置一些字段。请参阅**组件升级配置文档**确认您的组件是否存在此问题，并在 ks-core-values.yaml 文件中做出相应修改。 -请在{ks_product_both} v4.1.0 用户文档中的**升级配置文档**文件夹下查阅“默认配置”和“组件升级配置文档”。 - -|=== --- - -. 将安装包中的 **charts** 文件夹、以及创建的 **ks-core-values.yaml** 文件复制到 **upgrade.sh** 所在的 tools 目录。 - -. 执行安装包中的脚本 **pre-check.sh**，检查是否满足升级条件，需确保所有检查项通过。如果检查未通过，后续升级很有可能失败。 - - -== 单集群升级 - -. 在 host 集群节点上，切换到安装包的 tools 目录（该目录需包含 **charts** 文件夹、**ks-core-values.yaml** 和 **upgrade.sh**）。 - -. 执行以下命令开始升级{ks_product_left}。 -+ --- -[,bash] ----- -bash upgrade.sh host ----- --- - -. 参考以下步骤，检查 host 集群是否升级成功。 - -.. 执行以下命令，upgrade job 应该是成功完成的状态，如下所示。 -+ -[,bash] ----- -root@xxx:~# kubectl -n kubesphere-system get job | grep upgrade -ks-core-post-upgrade 1/1 16s 28m -ks-core-pre-upgrade 1/1 58s 31m -prepare-upgrade 1/1 26s 32m ----- - -.. 执行以下命令，如果显示如下信息，则表明 ks-core Helm Chart 已成功部署。 -+ -[,bash] ----- -root@xxx:~# helm list -n kubesphere-system -NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION -ks-core kubesphere-system 6 2024-04-09 14:54:09.349488995 +0800 CST deployed ks-core-1.0.0 v4.1.0 ----- - -.. 执行以下命令，pod（ks-apiserver, ks-console, ks-controller-manager）应该为 running 状态，如下所示。 -+ -[,bash] ----- -root@xxx:~# kubectl -n kubesphere-system get pod -NAME READY STATUS RESTARTS AGE -ks-apiserver-594bb884db-phrlv 1/1 Running 0 28m -ks-console-7cd55dd9f9-f2jl9 1/1 Running 0 28m -ks-controller-manager-785fc676dc-9d9j2 1/1 Running 0 28m ----- - -.. 执行以下命令，如果所有扩展组件的状态为 Installed，表明扩展组件都已成功安装。 -+ -[,bash] ----- -root@xxx:~# kubectl get installplan -NAME STATE -storage-utils Installed -devops Installed -network Installed -... ----- - -.. 登录{ks_product_left} Web 控制台后，点击右上角用户名 > 关于，显示的平台版本应为 v4.1.0。 - -. 使用原有的 Web 控制台的 IP 地址、管理员用户名和管理员密码，并使用网页浏览器登录 v4.1.0 的{ks_product_left} Web 控制台。 - -. 根据激活提示点击**激活**，导入{ks_product_left}的 license。 - -. 检查 host 集群各项功能和数据是否正常。 - - -== 多集群升级 - -. 按照以上link:#_单集群升级[单集群升级]步骤完成 host 集群的升级。 - -. 在 member 集群节点上，切换到安装包的 tools 目录（该目录需包含 **charts** 文件夹、**ks-core-values.yaml** 和 **upgrade.sh**）。 - -. 执行以下命令开始升级{ks_product_left}。 -+ -[,bash] ----- -bash upgrade.sh member ----- - -. 参考以下步骤，检查 member 集群是否升级成功。 - -.. 执行以下命令，upgrade job 应该是成功完成的状态，如下所示。 -+ -[,bash] ----- -root@xxx:~# kubectl -n kubesphere-system get job | grep upgrade -ks-core-post-upgrade 1/1 16s 28m -ks-core-pre-upgrade 1/1 58s 31m -prepare-upgrade 1/1 26s 32m ----- - -.. 执行以下命令，如果显示如下信息，则表明 ks-core Helm Chart 已成功部署。 -+ -[,bash] ----- -root@xxx:~# helm list -n kubesphere-system -NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION -ks-core kubesphere-system 6 2024-04-09 14:54:09.349488995 +0800 CST deployed ks-core-1.0.0 v4.1.0 ----- - -.. 执行以下命令，ks-agent pod 应该为 running 状态，如下所示。 -+ -[,bash] ----- -root@xxx:~# kubectl -n kubesphere-system get pod -NAME READY STATUS RESTARTS AGE -ks-agent-5dc5b57977-4x6mf 2/2 Running 0 59m ----- - -. member 集群升级成功后，在 host 集群上执行以下命令，修改 member 集群的状态，以便使扩展组件 agent 调度到 member 集群上。 -+ --- -[,bash] ----- -kubectl get clusters.cluster.kubesphere.io {member-x} -o json | jq 'del(.status.conditions[] | select(.type=="Schedulable"))' | kubectl apply -f - ----- - -[.admon.note,cols="a"] -|=== -|说明 - -| 执行 `kubectl get cluster`，替换 `{member-x}`。 - -|=== - -如果节点没有 jq 命令，可通过编辑集群资源的方式实现，编辑 member 集群的 status.conditions 中 type 为 Schedulable 的 condition，将其 status 设置为 True。 - -[,bash] ----- -kubectl edit clusters.cluster.kubesphere.io {member-x} ----- - -[,yaml] ----- -status: - conditions: - - lastTransitionTime: "2024-04-11T09:12:22Z" - lastUpdateTime: "2024-04-11T09:12:22Z" - message: Cluster has been initialized - reason: Initialized - status: "True" - type: Initialized - - lastTransitionTime: "2024-04-12T07:59:14Z" - lastUpdateTime: "2024-04-12T07:59:14Z" - message: Cluster has joined federation control plane successfully - status: "True" - type: Federated - - lastTransitionTime: "2024-04-12T08:02:56Z" - lastUpdateTime: "2024-04-12T08:02:56Z" - message: KS Core is available now - reason: KSCoreReady - status: "True" - type: KSCoreReady - - lastTransitionTime: "2024-04-12T08:02:56Z" - lastUpdateTime: "2024-04-12T08:02:56Z" - message: Not schedulable now - reason: Upgrading - status: "False" # 修改此处即可 - type: Schedulable - - lastTransitionTime: "2024-04-12T08:24:27Z" - lastUpdateTime: "2024-04-12T08:24:27Z" - message: Agent has connected to proxy successfully. - status: "True" - type: AgentAvailable - - lastTransitionTime: "2024-04-12T08:57:40Z" - lastUpdateTime: "2024-04-12T08:57:40Z" - message: Cluster is available now - reason: Ready - status: "True" - type: Ready ----- --- - -. 登录 host 集群的{ks_product_left} Web 控制台，进入**集群管理**页面，检查此 member 集群的各项功能和数据是否正常。 - -. 对下一个 member 集群继续执行以上步骤，直至完成所有集群的升级。 - -== 升级后配置 - -部分扩展组件，如 `KubeSphere 网关`、`WhizardTelemetry 监控`、`WhizardTelemetry 告警管理`、`WhizardTelemetry 通知管理`、`RadonDB DMP` 在升级后需进行额外配置，请参阅{ks_product_both} v4.1.0 用户文档中的**升级配置文档**文件夹下的**组件升级配置文档**进行配置。 - -[.admon.attention,cols="a"] -|=== -|注意 - -| -请务必参阅**组件升级配置文档**对升级后的 `KubeSphere 网关` 扩展组件进行配置，否则无法使用网关相关功能。 -|=== - -== 常见问题 - -=== 无法操作未升级的 member 集群 - -问题描述：host 集群升级到 v4.1.0 以后，无法在{ks_product_left} Web 控制台中查看和操作未升级的 member 集群。 - -原因：v4.1.0 与 v3.5.0 有许多 API 不兼容导致。 - -解决办法： - -* 尽快升级 member 集群。 -* 可在 member 集群升级前，通过 member 集群的 Web 控制台直接访问 member 集群。 - -=== member 集群的 Web 控制台无法登录 - -问题描述：在升级 member 集群前，通过 member 集群的 Web 控制台无法登录任何用户，提示"incorrect username or password"。 - -原因：{ks_product_right} v3.x 默认禁止直接访问 member 集群的 Web 控制台。 - -解决办法： - -. 执行以下命令，增加如下配置。 -+ --- -[,bash] ----- -kubectl -n kubesphere-system edit cm kubesphere-config ----- - -[,yaml] ----- -authentication: - oauthOptions: - accessTokenMaxAge: 0 - clients: - - name: kubesphere - secret: kubesphere - redirectURIs: - - '*' ----- --- - -. 执行以下命令重启 ks-apiserver，即可登录 member 集群的 Web 控制台。 -+ -[,bash] ----- -kubectl -n kubesphere-system rollout restart deployment ks-apiserver ----- - -=== 升级脚本异常退出 - -问题描述：升级过程中，升级脚本异常退出，升级失败。 - -解决办法：执行以下命令，查看升级 Job 日志，排查升级失败原因。 - -[,bash] ----- -kubectl -n kubesphere-system get job/prepare-upgrade - -kubectl -n kubesphere-system get pod |grep prepare-upgrade - -# 查看升级Job日志 -kubectl -n kubesphere-system logs prepare-upgrade-gvc6p ----- - -[,bash] ----- -kubectl -n kubesphere-system get job/ks-core-pre-upgrade - -kubectl -n kubesphere-system get pod |grep ks-core-pre-upgrade - -# 查看升级Job日志 -kubectl -n kubesphere-system logs ks-core-pre-upgrade-4n7tp ----- - -[,bash] ----- -kubectl -n kubesphere-system get job/ks-core-post-upgrade - -kubectl -n kubesphere-system get pod |grep ks-core-post-upgrade - -# 查看升级Job日志 -kubectl -n kubesphere-system logs ks-core-post-upgrade-4nzhk ----- - -=== 自定义角色的权限项为空 - -问题描述：升级后，自定义角色的权限项为空，被赋予自定义角色的用户无法正常使用。 - -解决办法： - -升级脚本 backup.sh 已帮助备份好自定义角色和自定义角色绑定，但由于权限变化，在升级时无法自动转换其权限，所以在升级后需要用户自行补充角色的权限。 - -. 使用升级脚本备份后，在 `backup-$timestamp/kse35-backup-iam-xxx.yaml` 路径下查看已经备份的自定义角色。 - -. 找到 `metadata.annotations[iam.kubesphere.io/aggregation-roles]`，用取到的值对比以下表格的 **3.x** 列中的名称，然后在{ks_product_left} Web 控制台找到对应的**描述**列中的权限名称。 -+ --- -[.admon.note,cols="a"] -|=== -|说明 - -| -平台自定义角色请查阅以下**平台**表格，企业空间自定义角色请查阅以下**企业空间**表格，项目自定义角色请查阅以下**项目**表格，确认对应关系。 -|=== --- - -**示例：** - -已经备份好的平台自定义角色 `test` 的信息如下 - -```yaml -apiVersion: iam.kubesphere.io/v1alpha2 -kind: GlobalRole -metadata: - annotations: - iam.kubesphere.io/aggregation-roles: '["role-template-view-roles","role-template-view-users","role-template-view-basic","role-template-manage-clusters","role-template-view-clusters"]' - kubesphere.io/alias-name: test-name - kubesphere.io/creator: admin - creationTimestamp: "2024-04-11T11:59:08Z" - generation: 3 - name: test #自定义角色的名称 - resourceVersion: "529194" - uid: a3ad5e39-2959-4e14-aa8f-e0c0ad8e6889 -rules: - ... - ... -``` - -. 取到 `metadata.annotations[iam.kubesphere.io/aggregation-roles]` 的值，如下： -+ -```yaml -'["role-template-view-roles","role-template-view-users","role-template-view-basic","role-template-manage-clusters","role-template-view-clusters"]' -``` - -. 对比以下**平台**表格，`metadata.annotations[iam.kubesphere.io/aggregation-roles]` 的各个值在表格的 **3.x** 列，对应的权限项在表格的**描述**列，故应该勾选**角色查看**、**用户查看**、**基础查看**、**集群管理**、**集群查看**。但因基础查看在 **4.1** 列被标记为 `none`，所以无法勾选**基础查看**。 - -. 在{ks_product_left} Web 控制台的**平台角色**页面编辑 `test` 角色的权限。 -+ --- -image:/images/ks-qkcp/zh/v4.1/edit-permission.png[ edit-permission, 100%] - -勾选**角色查看**、**用户查看**、**集群管理**、**集群查看**。 - -image:/images/ks-qkcp/zh/v4.1/check-permission.png[ check-permission, 100%] --- - -[.admon.attention,cols="a"] -|=== -|注意 - -| -一些权限项在 v4.1.0 中已经移除，标记为 `none`。有些没有移除，但出于安全考虑无法再将此权限授权给自定义角色，标记为 `can not use`。标记为 `none` 或 `can not use` 的权限项，在编辑自定义角色的权限时，不能被勾选。 -|=== - - -**平台** -[%header,cols="1a,2a,2a"] -|=== -| 描述 | 3.x | 4.1 - -|企业空间创建|role-template-create-workspaces| global-create-workspaces -|应用模版管理|role-template-manage-app-templates | `none` -|集群管理|role-template-manage-clusters | global-manage-clusters -|平台设置管理| role-template-manage-platform-settings | `can not use` -|角色管理| role-template-manage-roles | `can not use` -|用户管理|role-template-manage-users | `can not use` -|企业空间管理|role-template-manage-workspaces | global-manage-workspaces -|应用查看| role-template-view-app-templates | `none` -|基础查看|role-template-view-basic | `none` -|集群查看|role-template-view-clusters | global-view-clusters -|角色查看|role-template-view-roles | global-view-roles -|用户查看| role-template-view-users | global-view-users -|企业空间查看|role-template-view-workspaces | global-view-workspaces -|=== - -**企业空间** -[%header,cols="1a,2a,2a"] -|=== -| 描述 | 3.x | 4.1 - -|DevOps 项目创建|role-template-create-devops | workspace-create-devops -|项目创建|role-template-create-projects | workspace-create-projects -|应用仓库管理|role-template-manage-app-repos | workspace-manage-app-repos -|应用模板管理|role-template-manage-app-templates | workspace-manage-app-templates -|DevOps 项目管理|role-template-manage-devops | workspace-manage-devops -|部门管理 |role-template-manage-groups | `none` -|成员管理|role-template-manage-members | `can not use` -|项目管理|role-template-manage-projects | workspace-manage-projects -|角色管理|role-template-manage-roles | `can not use` -|企业空间设置管理|role-template-manage-workspace-settings | `can not use` -|应用仓库查看|role-template-view-app-repos | workspace-view-app-repos -|应用模版查看|role-template-view-app-templates | workspace-view-app-templates -|基础查看|role-template-view-basic | `none` -|DevOps 项目查看|role-template-view-devops | workspace-view-devops -|部门查看|role-template-view-groups | `none` -|成员查看|role-template-view-members | workspace-view-members -|角色查看|role-template-view-roles | workspace-view-roles -|企业空间设置查看|role-template-view-workspace-settings | `can not use` -|=== - -**项目** - -[%header,cols="1a,2a,2a"] -|=== -| 描述 | 3.x | 4.1 - -|应用负载管理|role-template-manage-app-workloads | namespace-manage-app-workloads -|配置字典管理|role-template-manage-configmaps | namespace-manage-configmaps -|成员管理|role-template-manage-members | `can not use` -|项目设置管理|role-template-manage-project-settings | namespace-manage-project-settings -|角色管理|role-template-manage-roles | `can not use` -|保密字典管理|role-template-manage-secrets | namespace-manage-secrets -|服务账户管理|role-template-manage-serviceaccount | namespace-manage-serviceaccount -|持久卷声明管理|role-template-manage-volumes | namespace-manage-persistentvolumeclaims -|应用负载查看|role-template-view-app-workloads | namespace-manage-app-workloads -|基础查看|role-template-view-basic|`none` -|配置字典查看|role-template-view-configmaps | namespace-view-configmaps -|成员查看|role-template-view-members | namespace-view-members -|角色查看|role-template-view-roles | namespace-view-roles -|保密字典查看|role-template-view-secrets | namespace-view-secrets -|服务账户查看|role-template-view-serviceaccount | namespace-view-serviceaccount -|持久卷声明查看|role-template-view-volumes | namespace-view-persistentvolumeclaims -|=== - diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/05-appendix-ks-core.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/05-appendix-ks-core.adoc deleted file mode 100644 index 2b6f17da0..000000000 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/05-appendix-ks-core.adoc +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: "附录 1：ks-core Helm Chart 升级参数" -linkTitle: "附录 1：ks-core Helm Chart 升级参数" -weight: 05 ---- - -== 升级 Job 配置 - -[%header,cols="2a,1a,2a"] -|=== -| 选项 | 默认值 | 描述 - -| upgrade.enabled | true | bool - 是否启用升级组件 -| upgrade.image.registry | "" | string - 设置升级 Job 的镜像仓库地址 -| upgrade.image.repository | kse/ks-upgrade | string - 设置升级 Job 的镜像名称 -| upgrade.image.tag | "" | string - 设置升级 Job 的镜像标签 -| upgrade.image.pullPolicy | Always | string - 设置升级 Job 的镜像拉取策略 -| upgrade.persistenceVolume.name | ks-upgrade | string - 设置升级 Job 的存储卷 -| upgrade.persistenceVolume.storageClassName | "" | string - 设置升级 Job 的存储卷类 -| upgrade.persistenceVolume.accessMode | ReadWriteOnce | string - 设置升级 Job 的存储卷访问模式 -| upgrade.persistenceVolume.size | 5Gi | string - 设置升级 Job 的存储卷容量 -| upgrade.resources.limit.cpu | 1 | string - 设置升级 Job 的 CPU 资源配额上限 -| upgrade.resources.limit.memory | 1024Mi | string - 设置升级 Job 的 Memory 资源配额上限 -| upgrade.resources.requests.cpu | 20m | string - 设置升级 Job 的 CPU 资源申请配额 -| upgrade.resources.requests.memory | 100Mi | string - 设置升级 Job 的 Memory 资源申请配额 -|=== - -== 升级应用配置 - -[%header,cols="2a,1a,2a"] -|=== -| 选项 | 默认值 | 描述 - -| upgrade.config.storage.local.path | /tmp/ks-upgrade | string - 设置升级 Job 使用本地目录存储备份数据 -| upgrade.config.storage.s3.endpoint | "" | string - 设置升级 Job 使用支持 S3 协议的对象存储服务备份数据，存储服务地址 -| upgrade.config.storage.s3.region | "" | string - 设置 S3 服务数据存储区域 -| upgrade.config.storage.s3.disableSSL | false | bool - 设置禁用 SSL 安全协议 -| upgrade.config.storage.s3.forcePathStyle | false | bool - 设置 S3 客户端对桶使用路径式寻址 -| upgrade.config.storage.s3.accessKeyID | "" | string - 设置 S3 服务账号的访问键，不使用凭证文件时是必需的 -| upgrade.config.storage.s3.secretAccessKey | "" | string - 设置 S3 服务账号的访问密钥，不使用凭证文件时是必需的 -| upgrade.config.storage.s3.sessionToken | "" | string - 设置 S3 服务的访问凭证文件 -| upgrade.config.storage.s3.bucket | "" | string - 设置 S3 服务的存储桶 -| upgrade.config.download.globalRegistryUrl | oci://hub.kubesphere.com.cn/kse-extensions | string - 设置扩展组件的仓库地址 -| upgrade.config.download.file | - | 系统预留配置 -| upgrade.config.download.http.timeout | 20 | int64 - 设置拉取扩展组件的超时时间 -| upgrade.config.download.http.caBundle | "" | string - 设置扩展组件仓库的自签名证书的 base64 字符串，多个自签名证书合并字符串 base64 -| upgrade.config.download.http.insecureSkipVerify | true | bool - 设置跳过扩展组件仓库 TLS 认证 -| upgrade.config.download.oci | - | 系统预留配置 -| upgrade.config.skipValidator | false | bool - 设置跳过升级 Job 版本校验，当前校验 KubeSphere 版本 -|=== - -== 升级组件配置 - -[%header,cols="2a,1a,2a"] -|=== -| 选项 | 默认值 | 描述 - -|upgrade.config.jobs.$ID.enabled |false |bool - 设置启用升级组件 $ID -|upgrade.config.jobs.$ID.priority |0 |int - 设置组件升级顺序的优先级 -|upgrade.config.jobs.$ID.extensionRef.name |"" |string - 设置扩展组件名称 -|upgrade.config.jobs.$ID.extensionRef.version |"" |string - 设置扩展组件版本 - -|=== - -== 升级组件清单 - -[%header,cols="1a,2a"] -|=== -| ID | 名称/描述 - -| core | ks-core 核心组件 -| iam | 多租户管理 -| network | KubeSphere 网络，用于 IPPool 管理和 NetworkPolicy 管理 -| devops | DevOps 系统 -| storage-utils | KubeSphere 存储 -| tower | KubeSphere 多集群代理连接 -| kubefed | 联邦集群应用管理 -| whizard-monitoring | WhizardTelemetry 监控 -| whizard-notification | WhizardTelemetry 通知管理 -| whizard-alerting | WhizardTelemetry 告警管理 -| whizard-events | WhizardTelemetry 事件管理 -| whizard-auditing | WhizardTelemetry 审计管理 -| whizard-logging | WhizardTelemetry 日志管理 -| whizard-telemetry-ruler | WhizardTelemetry 事件告警 -| whizard-telemetry | WhizardTelemetry 平台服务 -| vector | WhizardTelemetry 数据流水线 -| metrics-server | Metrics Server，集群核心监控数据的聚合器 -| opensearch | 用于日志存储 -| kubeedge | KubeEdge 边缘计算框架 -| springcloud | Spring Cloud，管理微服务、微服务配置和微服务网关 -| servicemesh | KubeSphere 服务网格 -| application | KubeSphere 应用商店管理 -| dmp | RadonDB DMP，云原生数据库管理平台 -| gateway | KubeSphere 网关 -|=== diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/_index.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/_index.adoc deleted file mode 100644 index e7a853013..000000000 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/03-upgrade-kubesphere/_index.adoc +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "升级 KubeSphere" -linkTitle: "升级 KubeSphere" -keywords: "Kubernetes, KubeSphere, 升级" -description: "介绍如何升级 KubeSphere。" -layout: "second" -weight: 03 ---- - - - -本节介绍如何升级{ks_product_left}。 diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/02-uninstall-kubernetes-and-kubesphere.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/02-uninstall-kubernetes-and-kubesphere.adoc index 9eb78c1b4..768b31ffb 100644 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/02-uninstall-kubernetes-and-kubesphere.adoc +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/04-uninstall-kubesphere/02-uninstall-kubernetes-and-kubesphere.adoc @@ -26,14 +26,14 @@ include::../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 -* 您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅link:../../../03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere[安装 Kubernetes 和 KubeSphere 企业版]。 +* 您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅link:../../../03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere[安装 Kubernetes 和 KubeSphere]。 + [.admon.note,cols="a"] |=== |说明 | -如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere 企业版] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，卸载过程可能会出现错误。 +如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，卸载过程可能会出现错误。 |=== * {empty} diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/01-add-cluster-nodes.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/01-add-cluster-nodes.adoc index 0967e9f40..301823926 100644 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/01-add-cluster-nodes.adoc +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/01-add-cluster-nodes.adoc @@ -36,7 +36,7 @@ include::../../../../_ks_components/admonitions/admonEnd.adoc[] :relfileprefix: ../../../ -* 您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅xref:03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc[安装 Kubernetes 和 KubeSphere 企业版]。 +* 您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅xref:03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc[安装 Kubernetes 和 KubeSphere]。 :relfileprefix: ./ @@ -46,7 +46,7 @@ include::../../../../_ks_components/admonitions/warning.adoc[] * 添加节点过程中不支持在 **config-sample.yaml** 配置文件中修改原有的集群配置。 -* 如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere 企业版] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，添加节点后集群可能会出现错误。 +* 如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，添加节点后集群可能会出现错误。 include::../../../../_ks_components/admonitions/admonEnd.adoc[] -- diff --git a/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/02-delete-cluster-nodes.adoc b/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/02-delete-cluster-nodes.adoc index 27a029c21..37333d640 100644 --- a/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/02-delete-cluster-nodes.adoc +++ b/content/zh/docs/v4.1/03-installation-and-upgrade/05-add-and-delete-cluster-nodes/02-delete-cluster-nodes.adoc @@ -36,7 +36,7 @@ include::../../../../_ks_components/admonitions/admonEnd.adoc[] :relfileprefix: ../../../ -* 您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅xref:03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc[安装 Kubernetes 和 KubeSphere 企业版]。 +* 您需要获取安装配置文件 **config-sample.yaml** 并将其传输到用于执行本节操作的集群节点。有关更多信息，请参阅xref:03-installation-and-upgrade/02-install-kubesphere/02-install-kubernetes-and-kubesphere.adoc[安装 Kubernetes 和 KubeSphere]。 :relfileprefix: ./ @@ -44,7 +44,7 @@ include::../../../../_ks_components/admonitions/admonEnd.adoc[] // Warning include::../../../../_ks_components/admonitions/warning.adoc[] -如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere 企业版] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，删除节点后集群可能会出现错误。 +如果您无法获取安装配置文件 **config-sample.yaml**，您需要参阅link:../../02-install-kubesphere/02-install-kubernetes-and-kubesphere/[安装 Kubernetes 和 KubeSphere] 重新创建 **config-sample.yaml** 文件。重新创建该文件时，请务必确保文件中的集群信息与集群的当前实际情况一致。否则，删除节点后集群可能会出现错误。 include::../../../../_ks_components/admonitions/admonEnd.adoc[] -- diff --git a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/01-view-and-customize-platform-information.adoc b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/01-view-and-customize-platform-information.adoc index a4bcd3d88..7a20a20b3 100644 --- a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/01-view-and-customize-platform-information.adoc +++ b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/01-view-and-customize-platform-information.adoc @@ -10,15 +10,6 @@ weight: 01 本节介绍如何查看{ks_product_left} Web 控制台的信息。 -// == 前提条件 - -// :relfileprefix: ../../../ - -// include::../../../_custom/platformManagement/platformManagement-prer-requiredPermission_v4.adoc[] - -// :relfileprefix: ./ - - == 操作步骤 . 登录{ks_product_left} Web 控制台。 diff --git a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc new file mode 100644 index 000000000..20bccc670 --- /dev/null +++ b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/01-set-up-external-authentication.adoc @@ -0,0 +1,160 @@ +--- +title: "配置外部身份验证" +keywords: "Kubernetes, KubeSphere, 第三方认证" +description: "了解如何在 KubeSphere 上设置外部身份验证。" +weight: 01 +--- + +:ks_navigation: **配置 > 保密字典** + +{ks_product_right}支持设置外部身份验证，平台管理员可以通过 secret（保密字典）配置身份提供者。 + +配置外部身份提供者后，允许使用 LDAP、CAS、GitHub、阿里云 IDaas、或 OpenID Connect 的用户名和密码登录{ks_product_left} Web 控制台。 + +== 操作步骤 + +. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。 + +. 进入企业空间 **system-workspace** 下的项目 **kubesphere-system**。 + ++ + +include::../../../../../_ks_components/oper-navigate.adoc[] + ++ + +include::../../../../../_ks_components/oper-clickCreate.adoc[] + +. 在**创建保密字典**对话框，点击右上角的**编辑 YAML** 开关，使用 yaml 创建保密字典。 + +. 按照以下示例及配置说明修改 yaml 文件，配置完成后，点击**创建**。 + +. 登出{ks_product_left} Web 控制台，在登录页面，根据配置的外部身份验证类型，输入 LDAP、CAS、GitHub、阿里云 IDaas、或 OpenID Connect 的用户名和密码登录。 + +[.admon.note,cols="a"] +|=== +|说明 + +| +多集群环境中，只需要在主集群中进行配置。 +|=== + +== OpenLDAP 示例 yaml + +[,yaml] +---- +apiVersion: v1 +kind: Secret +metadata: + namespace: kubesphere-system + name: identity-provider-ldap + labels: + config.kubesphere.io/type: identityprovider +stringData: + configuration.yaml: | + name: openldap + type: LDAPIdentityProvider + mappingMethod: auto + provider: + host: "192.168.0.2:389" + managerDN: uid=root,cn=users,dc=nas + managerPassword: "********" + userSearchBase: cn=users,dc=nas + loginAttribute: uid + mailAttribute: mail +type: config.kubesphere.io/identityprovider +---- + +[.admon.attention,cols="a"] +|=== +|注意 + +| +- secret 必须创建在 `kubeshere-system` 项目中。 + +- secret 必须包含 type。 ++ +`type: config.kubesphere.io/identityprovider`。 + +- secret 必须包含 label。 ++ +`config.kubesphere.io/type: identityprovider`。 +|=== + +== 配置说明 + +上述示例的 `stringData:configuration.yaml` 参数中： + +- name: 指定外部身份验证的名称，必须唯一，否则会创建失败。 + +- type: 指定外部身份验证的类型，支持以下类型： ++ +-- +- LDAP: `LDAPIdentityProvider` + +- CAS: `CASIdentityProvider` + +- GitHub: `GitHubIdentityProvider` + +- 阿里云 IDaas: `AliyunIDaaSProvider` + +- OpenID Connect: `OIDCIdentityProvider` +-- + +- mappingMethod: 指定外部身份用户与{ks_product_both}用户的关联方式。 ++ +-- +- auto: 自动创建相同名称的{ks_product_both}用户，当平台中已存在名称时会创建失败。 + +- manual: 登录后创建一个任意名称的新用户。 + +- lookup: 自动关联已存在的具有相同名称的{ks_product_both}用户，如果不存在该名称的用户，则创建失败。 +-- + +- provider: 外部身份验证的具体参数。以下是不同身份验证类型的 provider 参数示例。 ++ +-- +- LDAPIdentityProvider + +[,yaml] +---- +host: 192.168.0.2:389 +managerDN: uid=root,cn=users,dc=nas +managerPassword: "********" +userSearchBase: cn=users,dc=nas +loginAttribute: uid +mailAttribute: mail +---- + + +- CASIdentityProvider + +[,yaml] +---- +redirectURL: "https://ks-console:30880/oauth/redirect/cas" +casServerURL: "https://cas.example.org/cas" +insecureSkipVerify: true +---- + +- OIDCIdentityProvider + +[,yaml] +---- +clientID: '********' +clientSecret: '********' +issuer: https://accounts.google.com +redirectURL: 'https://ks-console/oauth/redirect/google' +---- + +- GitHubIdentityProvider + +[,yaml] +---- +clientID: '******' +clientSecret: '******' +redirectURL: 'https://ks-console/oauth/redirect/github' +---- + +阿里云 IDaaS 身份提供者的配置方法，请参阅link:https://www.alibabacloud.com/help/zh/idaas/[阿里云 IDaaS 文档]。 + +-- \ No newline at end of file diff --git a/content/zh/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/_index.adoc b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/_index.adoc new file mode 100644 index 000000000..5ec09ccc8 --- /dev/null +++ b/content/zh/docs/v4.1/04-platform-management/03-platform-settings/03-external-authentication/_index.adoc @@ -0,0 +1,7 @@ +--- +title: "外部身份验证" +weight: 03 +--- + +本节演示如何在{ks_product_both}上配置第三方身份验证。 + diff --git a/content/zh/docs/v4.1/05-users-and-roles/01-users/07-two-factor-authentication.adoc b/content/zh/docs/v4.1/05-users-and-roles/01-users/07-two-factor-authentication.adoc deleted file mode 100644 index c52340318..000000000 --- a/content/zh/docs/v4.1/05-users-and-roles/01-users/07-two-factor-authentication.adoc +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "开启和关闭二次认证" -linkTitle: "开启和关闭二次认证" -weight: 07 ---- - -本节介绍如何为当前用户开启和关闭二次认证。 - -开启二次认证后，用户登录时，输入账号和密码之后，还必须输入身份认证器生成的动态认证口令。借助二次认证，用户通过密码和手机为账户提供双重保护。 - - -== 前提条件 - -已获取{ks_product_left} Web 控制台的用户名和密码。 - - -== 开启二次认证 - -. 登录{ks_product_left} Web 控制台。 - -. 在页面右上角点击当前用户名，然后在下拉列表中选择**用户设置**。 - -. 在**二次认证**页签点击**开启二次认证**。 - -. 在手机上的各大应用市场搜索关键词 “Authenticator” 或 “身份认证器”，下载身份认证器 App。推荐使用 Google Authenticator。安装完成后，在{ks_product_left} Web 控制台点击**下一步**。 - -. 打开身份认证器 App，点击“扫描二维码”扫描右侧二维码。扫描完成后，在{ks_product_left} Web 控制台点击**下一步**。 - -. 输入身份认证器 App 生成的动态认证码，点击**认证并开启**开启二次认证。 -+ --- - -至此，二次认证开启完成。再次登录{ks_product_left} Web 控制台时，输入账号和密码之后，还必须输入身份认证器 App 生成的动态认证码。 - -image:/images/ks-qkcp/zh/v4.1/enable-two-factor-authentication.png[ enable-two-factor-authentication,50%] --- - -== 关闭二次认证 - -. 登录{ks_product_left} Web 控制台。 - -. 在页面右上角点击当前用户名，然后在下拉列表中选择**用户设置**。 - -. 在**二次认证**页签点击**关闭二次认证**。 - -. 在**关闭二次认证**对话框，输入身份认证器 App 生成的动态认证码，然后点击**确定**。 -+ -image:/images/ks-qkcp/zh/v4.1/disable-two-factor-authentication.png[ disable-two-factor-authentication,100%] - -=== 无法获取动态口令 - -若无法获取二次认证动态口令，导致无法登录，可联系管理员执行以下命令关闭二次认证。 - -[,bash] ----- -kubectl annotate user iam.kubesphere.io/totp-auth-key-ref- ----- diff --git a/content/zh/docs/v4.1/07-cluster-management/03-nodes/06-edit-node-labels.adoc b/content/zh/docs/v4.1/07-cluster-management/03-nodes/06-edit-node-labels.adoc index 74bd59926..3cbf39c69 100644 --- a/content/zh/docs/v4.1/07-cluster-management/03-nodes/06-edit-node-labels.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/03-nodes/06-edit-node-labels.adoc @@ -21,6 +21,7 @@ weight: 06 include::../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ + == 操作步骤 include::../../../_custom/clusterManagement/clusterManagement-oper-openClusterPage.adoc[] diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/08-roll-back-workload-settings.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/08-roll-back-workload-settings.adoc index 6a4440634..6d7362f5f 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/08-roll-back-workload-settings.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/01-workloads/08-roll-back-workload-settings.adoc @@ -16,7 +16,8 @@ include::../../../../_custom/clusterManagement/workloads/workloads-desc-rollBack == 前提条件 :relfileprefix: ../../../../ -* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/01-create-a-route.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/01-create-a-route.adoc index 8f228d74f..813055a14 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/01-create-a-route.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/01-create-a-route.adoc @@ -16,7 +16,8 @@ include::../../../../_custom/clusterManagement/routes/routes-desc-createARoute.a == 前提条件 :relfileprefix: ../../../../ -* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ diff --git a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/04-access-a-backend-service-of-a-route.adoc b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/04-access-a-backend-service-of-a-route.adoc index 6729d8357..f32b8e099 100644 --- a/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/04-access-a-backend-service-of-a-route.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/05-application-workloads/05-routes/04-access-a-backend-service-of-a-route.adoc @@ -17,7 +17,8 @@ include::../../../../_custom/clusterManagement/routes/routes-desc-accessABackend == 前提条件 :relfileprefix: ../../../../ -* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/04-clone-a-persistent-volume.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/04-clone-a-persistent-volume.adoc index 24826c289..3ebb3b715 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/04-clone-a-persistent-volume.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/04-clone-a-persistent-volume.adoc @@ -16,7 +16,8 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent == 前提条件 :relfileprefix: ../../../../ -* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/05-expand-a-persistent-volume.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/05-expand-a-persistent-volume.adoc index cb05a90f7..25873a6e2 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/05-expand-a-persistent-volume.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/05-expand-a-persistent-volume.adoc @@ -16,7 +16,8 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent == 前提条件 :relfileprefix: ../../../../ -* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/07-set-auto-expansion.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/07-set-auto-expansion.adoc index c49b758e0..258a023a6 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/07-set-auto-expansion.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/07-set-auto-expansion.adoc @@ -17,7 +17,8 @@ draft: true == 前提条件 :relfileprefix: ../../../../ -* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/09-delete-persistent-volume-claim.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/09-delete-persistent-volume-claim.adoc index 25da8e2c8..3755f66d5 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/09-delete-persistent-volume-claim.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/09-delete-persistent-volume-claim.adoc @@ -16,7 +16,8 @@ include::../../../../_custom/clusterManagement/persistentVolumeClaims/persistent == 前提条件 :relfileprefix: ../../../../ -* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/13-delete-a-persistent-volume.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/13-delete-a-persistent-volume.adoc index 2bd06a6e1..ce4abf200 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/13-delete-a-persistent-volume.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/01-persistent-volume-claims/13-delete-a-persistent-volume.adoc @@ -25,7 +25,8 @@ include::../../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 :relfileprefix: ../../../../ -* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/01-create-a-storage-class.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/01-create-a-storage-class.adoc index 8e161e076..750864b6e 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/01-create-a-storage-class.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/01-create-a-storage-class.adoc @@ -16,7 +16,8 @@ weight: 01 == 前提条件 :relfileprefix: ../../../../ -* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ diff --git a/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/05-enable-and-disable-volume-operations.adoc b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/05-enable-and-disable-volume-operations.adoc index 45f83ff37..ffa76e783 100644 --- a/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/05-enable-and-disable-volume-operations.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/08-storage/02-storage-classes/05-enable-and-disable-volume-operations.adoc @@ -25,7 +25,8 @@ include::../../../../../_ks_components/admonitions/admonEnd.adoc[] == 前提条件 :relfileprefix: ../../../../ -* 您需要加入一个集群并在集群中具有pass:a,q[{ks_permission}]权限。有关更多信息，请参阅xref:07-cluster-management/09-cluster-settings/03-cluster-members/[集群成员]和xref:07-cluster-management/09-cluster-settings/04-cluster-roles/[集群角色]。 +* {empty} +include::../../../../_custom/clusterManagement/clusterManagement-prer-requiredPermission_new.adoc[] :relfileprefix: ./ diff --git a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/02-edit-cluster-basic-information.adoc b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/02-edit-cluster-basic-information.adoc index 63c68e4c6..ba1cf4da3 100644 --- a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/02-edit-cluster-basic-information.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/01-basic-information/02-edit-cluster-basic-information.adoc @@ -2,7 +2,7 @@ title: "编辑集群基本信息" linkTitle: "编辑集群基本信息" keywords: "Kubernetes, KubeSphere, 集群管理, 基本信息, 编辑集群基本信息" -description: "介绍如何查看集群基本信息。" +description: "介绍如何编辑集群基本信息。" weight: 02 --- diff --git a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/04-remove-a-cluster-member.adoc b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/04-remove-a-cluster-member.adoc index 5646466d7..077f9ecc1 100644 --- a/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/04-remove-a-cluster-member.adoc +++ b/content/zh/docs/v4.1/07-cluster-management/09-cluster-settings/03-cluster-members/04-remove-a-cluster-member.adoc @@ -2,7 +2,7 @@ title: "移除集群成员" linkTitle: "移除集群成员" keywords: "Kubernetes, KubeSphere, 集群管理, 集群设置, 集群成员, 移除集群成员" -description: "介绍如何将用户邀请到集群。" +description: "介绍如何移除集群成员。" weight: 04 ---