v2.1

v2.1
v2.0
v1.0
Express
  1. Release Notes
  1. 产品介绍
  1. 安装指南
    1. 安装说明
    1. 在 Linux 快速安装 KubeSphere
    1. 安装可插拔的功能组件
    1. 集群高可用配置安装
    1. 在 Kubernetes 安装 KubeSphere
    1. 相关工具与插件
    1. 认证与安全
    1. 运维指南
  1. 快速入门
  1. 管理员指南
    1. 多租户管理
    1. 平台管理
    1. 基础设施
    1. 监控中心
    1. 平台设置
    1. 工具箱
    1. 通用配置
    1. FAQ
  1. 用户指南
    1. 应用
    1. 工作负载
    1. 存储
    1. 网络与服务
    1. 监控告警
    1. 配置中心
    1. 项目设置
    1. DevOps 工程
  1. 开发者指南
    1. Helm 应用开发
  1. API 文档
  1. 常见问题
  1. 附录
KubeSphere®️ 2019 All Rights Reserved.

安装说明

KubeSphere 是在 Kubernetes 之上构建的以应用为中心企业级分布式容器平台,为用户提供简单易用的操作界面以及向导式操作方式,KubeSphere 提供了在生产环境集群部署的全栈化容器部署与管理平台。

KubeSphere 支持部署和运行在包括公有云、私有云、VM、BM 和 Kubernetes 等任何基础设施之上,KubeSphere 可以部署在公有云托管的 Kubernetes 之上(如 GKE、EKS、ACK),也支持部署在私有化的 Kubernetes 之上(如 kubeadm、k3s、RKE 部署的集群)。目前已在 阿里云、腾讯云、华为云、青云 QingCloud、AWS、Google Cloud、Kubernetes、GKE、RKE 上进行过部署测试。同时,KubeSphere 支持在线安装与离线安装

KubeSphere 所有版本 100% 开源免费,已大规模服务于社区用户,广泛地应用在以容器为中心的开发测试及生产环境,大量服务平稳地运行在 KubeSphere 之上。

安装须知

  • 由于安装过程中需要更新操作系统和从镜像仓库拉取镜像,因此必须能够访问外网。如果不能访问外网,则需要下载离线安装包。
  • 当进行 all-in-one 模式进行单节点安装时,这个节点既是管理节点,也是工作节点。
  • 当进行 multi-node 模式安装多节点集群时,可在配置文件中设置集群各节点的角色。
  • 如果是新安装的系统,在 Software Selection 界面需要把 OpenSSH Server 选上。
  • KubeSphere 的部署架构中,由于各模块的服务和角色不同,分为管理节点和工作节点两个角色,即 Master 和 Node。
  • Master 节点由三个紧密协作的组件组合而成,即负责 API 服务的 kube-apiserver、负责调度的 kube-scheduler、负责容器编排的 kube-controller-manager。
  • 集群的持久化数据,由 kube-apiserver 处理后保存至 etcd 中。

快速安装(适用于快速体验测试)

KubeSphere 在 2.1 版本的 Installer 对各功能组件进行了解耦快速安装将默认仅开启最小化安装(Minimal Installation), 支持在安装前或安装后 自定义可插拔的功能组件的安装,使最小化安装更快速轻量且资源占用更少,方便不同用户按需选择安装不同的功能组件

快速安装的方式无需配置持久化存储,仅建议您用来快速安装测试和体验 2.1 的功能特性。正式环境建议配置持久化存储与集群的高可用部署。

安装在 Linux

  • all-in-one:单节点安装,支持一键安装。
  • multi-node:多节点安装,支持一键安装。

安装在 Kubernetes

正式环境安装

正式环境建议使用多节点(Multi-node)部署,并且同时配置 持久化存储集群的高可用

  • 持久化存储配置说明: KubeSphere 默认开启了 Local Volume 方便初次安装但没有准备存储服务端的场景下进行部署测试。若在 正式环境安装使用需配置 KubeSphere 支持的持久化存储服务,并准备相应的存储服务端。本文档说明安装过程中如何在 Installer 中配置持久化存储服务端。
  • 高可用集群配置与安装:Multi-Node 模式安装 KubeSphere 可以帮助用户顺利地部署环境,由于在实际的生产环境我们还需要考虑 master 节点的高可用问题,本文档以配置负载均衡器 (Load Banlancer) 为例,引导您在安装过程中如何配置高可用的 Master 和 etcd 节点。

自定义安装可插拔的功能组件

Installer 支持在 KubeSphere 安装前和安装后单独安装可选的功能组件,您可以根据业务需求和机器配置选择安装所需的组件,体验 KubeSphere 完整的端到端的容器产品解决方案,并且 所有组件都是开源免费的

可插拔功能组件介绍

提示:各功能组件的介绍可参考 产品功能,还可以在 视频资源 - 入门教程 下查看各个功能模块的视频 Demo,以下文档也提供了各模块的使用示例。

可插拔功能组件列表

注意:开启可选功能组件之前,请先参考下表确认集群的可用 CPU 与内存空间是否充足(下表是计算得出的各组件 CPU 与内存的 Request 值),否则可能会因为资源不足而导致的机器崩溃或其它问题。

组件名称 组件功能 CPU 内存 说明
openpitrix-system 应用商店 约 0.3 core 约 300 MiB 支持应用声明周期管理
与应用一键部署,建议安装
kubesphere-alerting-system 告警&邮件通知 约 0.08 core 约 80 M alerting 与 notification 安装时
建议同时开启
istio-system 应用与微服务治理(ServiceMesh) 约 2 core 约 3.6 G 支持灰度发布、流量治理、Tracing,建议安装
kubesphere-devops-system(单节点) 构建镜像(s2i/b2i)和 CI/CD 流水线 约 34 m 约 2.69 G 与容器平台打通形成
完整的一站式DevOps 方案
kubesphere-devops-system(多节点) 构建镜像(s2i/b2i)和 CI/CD 流水线 约 0.47 core 约 8.6 G 多节点安装 DevOps 需要
有一个节点的可用内存大于 8G
kubesphere-logging-system 内置的日志系统 约 56 m 约 2.76 G 建议开启,否则无法使用内置的日志系统
metrics-server 支持 HPA 的使用 约 5 m 约 44.35 MiB 若需要使用 HPA 则建议安装
GitLab + Harbor 私有代码仓库 + 私有镜像仓库 约 0.58 core 约 3.57 G 第三方应用

说明:

  • 此表格中的 CPU 与内存占用数据仅为最小资源占用,在实际的集群环境中建议预留更充足的资源空间。
  • 单位后缀 m 表示千分之一核,即 1 Core = 1000m。

KubeSphere 2.1.0 中的相关组件包括了以下版本,其中带 * 号的组件为使用 Installer 最小化安装时的默认安装项,其它组件为可选安装项:

组件 版本
* KubeSphere 2.1.0
* Kubernetes v1.15.5
* etcd 3.2.18
* Prometheus v2.3.1
Fluent Bit v1.2.1
Elasticsearch( 支持外接 v6.7.0 ( 支持对接 ElasticSearch 7.x )
Istio v1.3.3
OpenPitrix v0.4
Jenkins v2.176.2
SonarQube v7.4
GitLab 11.8.1
Harbor 1.7.5

说明:KubeSphere 对 Kubernetes 版本的兼容原则是 最新的版本 + 往前两个版本,因为 Kubernetes v1.16 淘汰了一些 API group,如 extensions/v1beta1,这个 API group 被 helm 和很多 charts 使用到,需要等 helm 和 charts 更新后才能兼容 1.16,并且 v2.1 是在 1.15.x 上开发测试的,所以目前 v2.1 对 Kubernetes 兼容并支持的版本包括 1.15.x、1.14.x 和 1.13.x,近期刚发布的 Kubernetes 1.16 会在 KubeSphere 下一个版本兼容。

如何开启可选功能组件的安装

参考 安装可插拔的功能组件 目录下的 7 篇文档,开启可插拔功能组件的安装。注意,在开启安装前,请先确保机器的 CPU 与内存资源满足最低要求,参考上述的可插拔功能组件列表

集群参数配置

在获取 Installer 并解压至目标安装机器后,如果需要修改网络、组件版本等集群配置相关参数,可参考以下说明进行修改,本文档对 Installer 中的安装配置文件 conf/common.yaml 进行说明,简单介绍每一个字段的意义。参考 集群参数配置)

运维指南

升级

若您的机器已安装的环境为 2.0.x 版本,我们强烈建议您升级至最新的高级版 2.1.0,最新的 Installer 支持将 KubeSphere 从 2.0.x 环境一键升级至目前最新的 2.1.0,详见 升级指南。注意,2.1.0 目前暂不支持回滚至 2.0.x。

集群节点扩容

安装 KubeSphere 后,在正式环境使用时可能会遇到服务器容量不足的情况,这时就需要添加新的节点 (node),然后将应用系统进行水平扩展来完成对系统的扩容,配置详见 集群节点扩容

卸载

卸载将从机器中删除 KubeSphere,该操作不可逆,详见 卸载说明

高危操作

KubeSphere 支持管理节点和 etcd 节点高可用,保证集群稳定性,同时基于 kubernetes 底层调度机制,可以保证容器服务的可持续性及稳定性,但并不推荐无理由关闭或者重启节点,因为这类后台操作均属于高危操作,可能会造成相关服务不可用,请谨慎操作。执行高危操作需将风险告知用户,并由用户以及现场运维人员同意之后,由运维人员进行后台操作。比如以下列表包含了高危操作和禁止操作,可能造成节点或集群不可用:

高危操作列表

序列 高危操作
1 重启集群节点或重装操作系统。
2 建议不要在集群节点安装其它软件,可能导致集群节点不可用。

禁止操作列表

序列 禁止操作
1 删除 /var/lib/etcd/,删除 /var/lib/docker,删除 /etc/kubernetes/,删除 /etc/kubesphere/
2 磁盘格式化、分区。