v2.0
v1.0
  1. Release Notes
    1. Release Notes - 2.0.2最新
    1. Release Notes - 2.0.1
    1. Release Notes - 2.0.0
  1. 产品介绍
    1. 产品简介
    1. 产品功能
    1. 产品优势
    1. 架构说明
    1. 应用场景
    1. 名词解释
  1. 安装指南
    1. 安装说明
    1. 需开放的端口
    1. All-in-One 模式
    1. Multi-Node 模式
    1. 在 Kubernetes 在线部署 KubeSphere
    1. 在 Kubernetes 离线部署 KubeSphere
    1. Master 和 etcd 节点高可用
    1. 存储安装配置说明
    1. 集群组件配置说明
    1. 安装负载均衡器插件
    1. 安装内置 Harbor
    1. 安装内置 GitLab
    1. 升级
    1. 访问 SonarQube 和 Jenkins 服务端
    1. 集群节点扩容
    1. 卸载
  1. 快速入门
    1. 入门必读
    1. 示例一 - 多租户管理快速入门
    1. 示例二 - 应用路由与服务示例
    1. 示例三 - 部署 MySQL
    1. 示例四 - 部署 Wordpress
    1. 示例五 - 创建简单任务
    1. 示例六 - 一键部署应用
    1. 示例七 - 设置弹性伸缩 (HPA)
    1. 示例八 - Source-to-Image
    1. 示例九 - Bookinfo 微服务的灰度发布
    1. 示例十 - 基于Spring Boot项目构建流水线
    1. 示例十一 - 图形化构建流水线
    1. 示例十二 - CI/CD 流水线(离线版)
    1. 示例十三 - 使用 Ingress-Nginx 进行灰度发布
  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. 通用配置
      1. 系统配置修改
      2. 上传镜像至 Harbor
      3. Jenkins 系统设置
    1. FAQ
      1. DevOps 运维FAQ
  1. 用户指南
    1. 应用
      1. 应用模板
      2. 自制应用
      3. 流量治理
      4. 熔断
    1. 工作负载
      1. 工作负载概述
      2. 部署
      3. 有状态副本集
      4. 守护进程集
      5. 任务
      6. 定时任务
      7. 设置健康检查器
      8. 工作负载管理
      9. 自定义 S2i 模板
    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. API 文档
    1. API 文档
    1. 如何调用 API
    1. API 常用术语对照
    1. 监控指标说明
  1. 常见问题
    1. 安装常见问题
    1. 存储常见问题
    1. 控制台使用常见问题
    1. DevOps 常见问题
  1. 附录
    1. 部署 Ceph 存储服务端
    1. 部署 GlusterFS 存储服务端
    1. 云平台配置端口转发和防火墙
KubeSphere®️ 2020 All Rights Reserved.

集群组件配置释义

用户在获取 installer 并解压至目标安装机器后,如果需要查看或修改存储、网络、组件版本、可选安装项 (如 GitLab、Harbor)、外部负载均衡器、Jenkins、邮件服务器等配置参数时,可参考以下说明进行修改,本文档对 installer 中的安装配置文件 conf/vars.yml 进行说明,简单介绍每一个字段的意义。

负载均衡器插件与 QingCloud CSI 配置

配置文件 conf/vars.yml 中的前 9 项 qingcloud 开头的配置项是与 QingCloud 云平台负载均衡器插件和 QingCloud CSI 块存储插件相关的公共配置参数,第 10、11 项是启用安装 QingCloud 负载均衡器插件和私有网络配置,释义分别在 安装负载均衡器插件存储配置说明 - QingCloud 云平台块存储

存储相关配置

Installer 默认使用 local 类型的存储方便 all-in-one 模式进行安装,若使用 Multi-node 进行安装,则需要配置持久化存储作为存储服务端再执行安装,在 conf/vars.yml 支持配置 QingCloud CSI、Ceph RBD、NFS Client、NeonSAN CSI、GlusterFS 等,存储配置相关参数释义请参考 存储配置说明

集群组件相关配置

参数说明:

参数 含义
ks_version KubeSphere 版本号
kube_version Kubernetes 版本号
etcd_version etcd 版本号
openpitrix_version OpenPitrix 版本号
ks_image_pull_policy 默认 IfNotPresent,表示优先使用本地镜像,还支持 Always (尝试重新下载镜像) 和 Never (仅使用本地镜像)
kube_network_plugin 默认的网络插件(支持 Calico、Flannel)
kube_service_addresses Service 网络 IP 地址段(未被使用的地址段)
kube_pods_subnet Pod 网络 IP 地址段(未被使用的地址段)
kube_proxy_mode kube-proxy 模式默认 ipvs (支持 ipvs, iptables)
kubelet_max_pods 单台机器默认 Pod 数量
dns_mode DNS 模式,建议 coredns
console_port KubeSphere 控制台访问端口(默认 30880)
disableMultiLogin 禁止同一用户多点登录,默认 true 即禁用
loadbalancer_apiserver.address 外部负载均衡器地址
loadbalancer_apiserver.port 外部负载均衡器端口
apiserver_loadbalancer_domain_name 负载均衡器域名,默认 lb.kubesphere.local
periodic_cleaning_time weekly,Docker 自动清理镜像的周期
docker_registry_mirrors 默认 Docker 镜像仓库的 mirror 仓库,可以加快镜像下载 (国外地区下载可将此参数注释)
etcd_backup_period 默认备份的周期为 30 分钟
keep_backup_number 默认保留最近 5 次备份的数据
etcd_backup_dir 默认备份的目录为 "/var/backups/kube_etcd"
prometheus_memory_size Prometheus 内存请求大小
prometheus_volume_size Prometheus 存储空间大小
keep_log_days 集群内置的 Elasticsearch 中日志保留时间,默认是 7 天
kibana_enable 是否部署 Kibana (默认 false)
elasticsearch_volume_size Elasticsearch 存储空间
EMAIL_SMTP_HOST SMTP 邮件服务器地址
EMAIL_SMTP_PORT SMTP 邮件服务器端口
EMAIL_FROM_ADDR 发件人邮箱地址
EMAIL_FROM_NAME 通知邮件名称
EMAIL_FROM_PASS 密码
EMAIL_USE_SSL 是否开启 SSL 配置
jenkins_memory_lim Jenkins 内存限制
jenkins_memory_req Jenkins 内存请求
Java_Opts jvm 启动参数
JenkinsLocationUrl jenkins 域名
harbor_enable 是否安装 Harbor
harbor_domain Harbor 域名
gitlab_enable 是否部署 GitLab
gitlab_hosts_domain GitLab 域名
sonarqube_enable 是否集成并开启 SonarQube,默认安装内置的 SonarQube
sonar_server_url 对接已有的外部 SonarQube 地址(如需集成安装则取消注释)
sonar_server_token 对接已有 SonarQube token(如需集成安装则取消注释)
nvidia_accelerator_enabled 是否开启 Nvidia GPU 加速
nvidia_gpu_nodes hosts.ini 中要开启 GPU 加速的节点名称(列表),目前 GPU 节点仅支持 Ubuntu 16.04。参考以下配置示例

GPU 节点配置示例

注意,在安装前可对 GPU 节点在 vars.yml 文件中进行设置,例如在 hosts.ini 文件配置的两台工作节点 node1 是 CPU 节点, node2 是 GPU 节点,那么在 vars.yml 仅需要在该处填写 node2,注意 "-" 前面需缩进两格。

 nvidia_accelerator_enabled: true
 nvidia_gpu_nodes:
   - node2