v2.1
v2.0
v1.0
  1. Release Notes
    1. Release Notes - 2.1.1最新
    1. Release Notes - 2.1.0
    1. Release Notes - 2.0.2
    1. Release Notes - 2.0.1
    1. Release Notes - 2.0.0
  1. 产品介绍
    1. 什么是 KubeSphere
    1. 平台功能
    1. 为什么选择 KubeSphere
    1. 架构说明
    1. 应用场景
    1. 名词解释
  1. 安装指南
    1. 安装说明
      1. 概览
      2. 网络防火墙配置
      3. 集群其它参数配置
    1. 在 Linux 快速安装 KubeSphere
      1. All-in-One 模式
      2. Multi-Node 模式
      3. 完整安装(开启所有功能组件)
    1. 在 Kubernetes 安装 KubeSphere
      1. 准备工作
      2. 在 Kubernetes 安装 KubeSphere
    1. 安装可插拔的功能组件
      1. 可插拔功能组件概览
      2. 安装应用商店
      3. 安装内置的 DevOps 系统
      4. 安装内置的日志系统
      5. 安装微服务治理组件(Service Mesh)
      6. 安装告警通知系统
      7. 安装 Metrics-server 开启 HPA
      8. 验证可插拔功能组件的安装
    1. 集群高可用配置安装
      1. 在青云安装 HA 集群
      2. 在华为云安装 HA 集群
      3. 持久化存储配置说明
    1. 相关工具与插件
      1. 安装内置 Grafana
      2. 访问 SonarQube 和 Jenkins 服务端
      3. 安装 Porter 负载均衡器插件
      4. 安装 QingCloud 负载均衡器插件
    1. 认证配置
      1. 接入 LDAP / AD 域账号(Beta)
    1. 集群运维
      1. 安装后添加新的存储类型
      2. 集群节点扩容
      3. 卸载
  1. 升级指南
    1. 升级必读
    1. All-in-One 升级
    1. Multi-node 升级
  1. 快速入门
    1. 入门必读
    1. 1. 多租户管理快速入门
    1. 2. 应用路由与服务示例
    1. 3. 创建 Wordpress 应用并发布至 K8s
    1. 4. 一键部署应用
    1. 5. 创建简单任务
    1. 6. 设置弹性伸缩 (HPA)
    1. 7. Source-to-Image
    1. 8. Binary-to-Image
    1. 9. 基于Spring Boot项目构建流水线
    1. 10. 图形化构建流水线
    1. 11. Bookinfo 微服务的灰度发布
    1. 12. 使用 Ingress-Nginx 进行灰度发布
    1. 13. 应用商店
  1. 管理员指南
    1. 多租户管理
      1. 多租户管理概述
      2. 角色权限概览
    1. 平台管理
      1. 企业空间管理
      2. 账号管理
      3. 平台角色
    1. 基础设施
      1. 服务组件
      2. 主机管理
      3. 存储类型
    1. 监控中心
      1. 监控概述
      2. 如何利用监控定位问题
      3. 集群状态监控
      4. 应用资源监控
      5. 监控策略 - 节点级别
      6. 监控消息 - 节点级别
    1. 平台设置
      1. 应用仓库
      2. 基于本地仓库搭建应用仓库部署Redis
      3. 上传应用到 KubeSphere 官方仓库
      4. 基于 GitHub 搭建自有应用仓库
      5. 邮件服务器
      6. 日志收集
      7. 添加 Fluentd 作为日志接收者
      8. 添加 Kafka 作为日志接收者
    1. 工具箱
      1. Web Kubectl
      2. 日志收集
    1. DevOps 配置
      1. 系统配置修改
      2. 上传镜像至 Harbor
      3. 流水线配置邮件服务器
      4. Jenkins 系统设置
    1. FAQ
      1. DevOps 运维FAQ
  1. 用户指南
    1. 应用
      1. 应用模板
      2. 自制应用
      3. 流量治理
      4. 熔断
    1. 工作负载
      1. 工作负载概述
      2. 部署
      3. 有状态副本集
      4. 守护进程集
      5. 任务
      6. 定时任务
      7. 设置健康检查器
      8. 工作负载管理
      9. 落盘日志收集
    1. 存储
      1. 存储概述
      2. 存储卷
      3. Local Volume 使用方法
    1. 网络与服务
      1. 服务管理
      2. 灰度发布
      3. 应用路由
    1. 监控告警
      1. 告警策略 - 工作负载级别
      2. 告警消息 - 工作负载级别
    1. 配置中心
      1. 密钥
      2. 配置
      3. 镜像仓库
    1. 项目设置
      1. 基本信息
      2. 成员角色
      3. 项目成员
      4. 外网访问
    1. DevOps 工程
      1. DevOps 工程概述
      2. 管理 DevOps 工程
      3. 流水线
      4. 凭证管理
      5. 添加代码仓库
      6. 访问 SonarQube 并创建 Token
      7. 设置自动触发扫描
      8. Jenkins Agent 说明
      9. 流水线常见问题
  1. 开发者指南
    1. Helm 应用开发
      1. 开发模板规范
      2. Helm 应用开发入门
    1. Source to Image(S2I) 自定义模版开发
      1. S2I 原理及流程介绍
      2. 自定义 S2I 模版
  1. API 文档
    1. API 文档
    1. 如何调用 API
    1. API 常用术语对照
    1. 监控指标说明
  1. 常见问题
    1. 安装常见问题
    1. 存储常见问题
    1. 控制台使用常见问题
    1. DevOps 常见问题
  1. 附录
    1. 部署 Ceph 存储服务端
    1. 部署 GlusterFS 存储服务端
    1. 安装 OpenEBS 创建 LocalPV 存储类型
    1. 云平台配置端口转发和防火墙
KubeSphere®️ 2020 All Rights Reserved.

安装说明

编辑

KubeSphere 是在 Kubernetes 之上构建的 企业级分布式容器平台,为用户提供简单易用的操作界面以及向导式操作方式,还能够帮助一键快速安装与运营 Kubernetes 集群。

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

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

KubeSphere Installer 概览

安装须知

  • 由于安装过程中需要更新操作系统和从镜像仓库拉取镜像,因此必须能够访问外网。如果不能访问外网,则需要下载离线安装包。
  • 当进行 all-in-one 模式进行单节点安装时,这个节点既是管理节点,也是工作节点。
  • 当进行 multi-node 模式安装多节点集群时,可在配置文件中设置集群各节点的角色。
  • 如果是新安装的系统,在 Software Selection 界面需要把 OpenSSH Server 选上。
  • 安装之前建议关闭防火墙,或参考 端口防火墙 开放指定端口。

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

快速安装(适用于开发测试环境)

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

安装在 Linux

在线安装

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

离线安装

离线环境可参考 离线安装 KubeSphere 2.1.1

安装在 Kubernetes

在线安装

确保您的 Kubernetes 集群满足前提条件,然后再开启安装。

离线安装

请参考 在 Kubernetes 离线安装 KubeSphere

正式环境安装

安装在 Linux

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

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

安装在 Kubernetes

需要注意的是,为方便快速安装测试,在 Kubernetes 在线部署 KubeSphere 文档中使用的存储类型是基于 OpenEBS 创建的 Local Volume。在正式环境安装 KubeSphere 之前,建议您保证 Kubernetes 集群本身已配置了高可用,即 Kubernetes 集群满足以下两个条件:

  • 集群已配置了持久化存储,并创建了 StorageClass
  • Master 节点数量 ≥ 3,且配置了负载均衡方案满足高可用

若满足以上两个条件,即可参考 在 Kubernetes 在线部署 KubeSphere 进行安装。

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

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

Pluggable Components

升级

若您的机器已安装的环境为 2.0.x 或 2.1.0 版本,我们建议您升级至最新的高级版 2.1.1,Installer 2.1.1 支持将 KubeSphere 从 2.0.x 或 2.1.0 环境一键升级至目前最新的 2.1.1,详见 升级指南

集群参数配置

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

运维指南

集群节点扩容

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

卸载

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

高危操作

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

高危操作列表

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

禁止操作列表

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