From 4e07963e427f29708e96dac0fbd4fcef4462d8e9 Mon Sep 17 00:00:00 2001 From: FeynmanZhou Date: Sun, 1 Mar 2020 15:36:50 +0800 Subject: [PATCH] refine readme, update download url to 2.1.1 Signed-off-by: FeynmanZhou --- README.md | 105 +++++++++++-------------- README_zh.md | 99 ++++++++++++----------- docs/en/guides/Development-workflow.md | 3 +- 3 files changed, 99 insertions(+), 108 deletions(-) diff --git a/README.md b/README.md index 37f2970a35..416caa5e26 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# KubeSphere +# KubeSphere Container Platform [![License](http://img.shields.io/badge/license-apache%20v2-blue.svg)](https://github.com/KubeSphere/KubeSphere/blob/master/LICENSE) [![Build Status](https://travis-ci.org/kubesphere/kubesphere.svg?branch=master)](https://travis-ci.org/kubesphere/kubesphere) [![Go Report Card](https://goreportcard.com/badge/github.com/kubesphere/kubesphere)](https://goreportcard.com/report/github.com/kubesphere/kubesphere) -[![KubeSphere release](https://img.shields.io/github/release/kubesphere/kubesphere.svg?color=release&label=release&logo=release&logoColor=release)](https://github.com/kubesphere/kubesphere/releases/tag/v2.1.0) +[![KubeSphere release](https://img.shields.io/github/release/kubesphere/kubesphere.svg?color=release&label=release&logo=release&logoColor=release)](https://github.com/kubesphere/kubesphere/releases/tag/v2.1.1) ![logo](docs/images/kubesphere-logo.png) @@ -12,9 +12,9 @@ > English | [中文](README_zh.md) -[KubeSphere](https://kubesphere.io/) is a multi-tenant enterprise-grade container platform built on [Kubernetes](http://kubernetes.io), with full-stack automated IT operation and streamlined DevOps workflows. KubeSphere provides developer-friendly wizard web UI, helps enterprises to build out a more robust and feature-rich platform, includes most common functionalities needed for enterprise Kubernetes strategy, such as the **Kubernetes resource management, DevOps (CI/CD), application lifecycle management, monitoring, logging, Service Mesh (Istio-based), multi-tenancy, alerting and notification, storage and networking, autoscaling, access control, GPU support, etc.**, as well as **multi-cluster management, Network Policy, registry management, security** in upcoming releases. KubeSphere is going to be a **distributed operating system with cloud native stack** based on Kubernetes, will be very well architected for **plug-and-play integration with its ecosystem** as well. +[KubeSphere](https://kubesphere.io/) is a multi-tenant enterprise-grade container platform built on [Kubernetes](http://kubernetes.io), with full-stack automated IT operation and streamlined DevOps workflows. KubeSphere provides developer-friendly wizard web UI, helping enterprises to build out a more robust and feature-rich platform, which includes most common functionalities needed for enterprise Kubernetes strategy, such as the **Kubernetes resource management, DevOps (CI/CD), application lifecycle management, monitoring, logging, Service Mesh (Istio-based), multi-tenancy, alerting and notification, storage and networking, autoscaling, access control, GPU support, etc.**, as well as **multi-cluster management, Network Policy, registry management, more security enhancements** in upcoming releases. KubeSphere is a **distributed operating system with cloud native stack** with Kubernetes as its kernel, and will be very well architected for **plug-and-play integration for third-party applications to boost its ecosystem**. -KubeSphere provides a complete user experience around Kubernetes that incorporates a rich set of cloud native ecosystem tools, allows developers and DevOps teams use their favorite tools in a single front-end interface. KubeSphere delivers **consolidated views while integrating a wide breadth of ecosystem tools** upon Kubernetes and offer **consistent user experience** to reduce complexity. Most importantly, these functionalities are loosely coupled with the platform since they are pluggable and optional based on your demands, will not impact the flexibilty of Kubernetes. +KubeSphere provides a complete user experience around Kubernetes that incorporates a set of cloud native ecosystem tools, allowing developers and DevOps teams use their favorite tools in a unified console. KubeSphere delivers **consolidated views while integrating a wide breadth of ecosystem tools** around Kubernetes and offers consistent user experience to reduce complexity. Most importantly, these functionalities are loosely coupled with the platform since they are pluggable and optional at your will. Last but not least, it does not change Kubernetes itself anything. In another word, KubeSphere can be deployed on any existing version-compatible Kubernetes cluster. ![](docs/images/kubesphere-platform-overview.png) @@ -41,36 +41,29 @@ KubeSphere provides a complete user experience around Kubernetes that incorporat -## Video on Youtube - -[![KubeSphere](https://pek3b.qingstor.com/kubesphere-docs/png/20191112093503.png)](https://youtu.be/u5lQvhi_Xlc) - ## Demo Environment -Using the account `demo1 / Demo123` to log in the [demo environment](https://demo.kubesphere.io/). Please note the account is granted viewer access. - -## Features - -KubeSphere provides an easy-to-use console with awesome user experience that allows you to quickly get started with a container management platform. KubeSphere provides and supports the following major features: +Using the account `demo1 / Demo123` to log in the [demo environment](https://demo.kubesphere.io/). Please note the account is granted viewer access. You can also have a quick view of [KubeSphere Demo Video](https://youtu.be/u5lQvhi_Xlc). -- Workload management -- Service mesh (Istio-based) -- DevOps (CI/CD Pipeline) -- Source to Image, Binary to Image -- Multi-tenant management -- Multi-dimensional and multi-tenant monitoring, logging, alerting, notification -- Service and network management -- Application store and application lifecycle management -- Node and storage class management, image registry management -- Integrated Harbor, GitLab, SonarQube -- LB controller for Kubernetes on bare metal ([Porter](https://github.com/kubesphere/porter)), [cloud LB plugin](https://github.com/yunify/qingcloud-cloud-controller-manager) -- Support GPU node, support [vGPU](https://github.com/virtaitech/orion) +## Features +|Feature|Description| +|---|---| +| Provisioning Kubernetes Cluster|Support deploy Kubernetes on your infrastructure out of box, including online and air gapped installation| +| Kubernetes Resource Management | Provide web console for creating and managing Kubernetes resources, with powerful observability including monitoring, logging, events, alerting and notification | +| DevOps System | Provide out-of-box CI/CD based on Jenkins, and offers automated workflow tools including binary-to-image (B2I) and source-to-image (S2I) | +| Application Store | Provide application store for Helm-based applications, and offers application lifecycle management | +| Service Mesh (Istio-based) | Provide fine-grained traffic management, observability and tracing for distributed microservice applications, provides visualization for traffic topology | +| Rich Observability | Provide multi-dimensional monitoring metrics, and provides multi-tenant log query and collection, support alerting and notification for both application and infrastructure | +| Multi-tenant Management | Provide unified authentication with fine-grained roles and three-tier authorization system, supports AD/LDAP authentication | +| Infrastructure Management | Support node management and monitoring, and supports adding new nodes for Kubernetes cluster | +| Storage Support | Support GlusterFS, CephRBD, NFS, Local (default) etc. open source storage solutions, provide CSI plugins to consume storage from cloud providers | +| Network Support | Support Calico, Flannel, etc. open source network solutions, provides load balancer plug-in [Porter](https://github.com/kubesphere/porter) for Kubernetes installed on physical machines | +| GPU Support | Support add GPU node, support vGPU, enables running ML applications on Kubernetes, e.g. TensorFlow | -It also supports a variety of open source storage solutions and cloud storage products as the persistent storage services, as well as supports multiple open source network plugins. -> Note: See this [document](https://kubesphere.io/docs/v2.1/en/introduction/features/) which elaborates on the KubeSphere features and services. +> Note: See this [Feature and Benefits](https://kubesphere.io/docs/v2.1/en/introduction/features/) for further information. ---- @@ -81,35 +74,42 @@ KubeSphere uses a loosely-coupled architecture that separates the [frontend](htt ## Latest Release -KubeSphere 2.1.0 was released on **November 12nd, 2019**. Check the [Release Notes For 2.1.0](https://kubesphere.io/docs/v2.1/zh-CN/release/release-v210/) for the updates. +KubeSphere 2.1.1 was released on **February 23th, 2019**. See the [Release Notes For 2.1.1](https://kubesphere.io/docs/v2.1/en/release/release-v211/) for the updates. ## Installation KubeSphere can run anywhere from on-premise datacenter to any cloud to edge. In addition, it can be deployed on any Kubernetes distribution. -> Attention: The following section is only used for minimal installation by default, see [Complete Installation Guide](https://kubesphere.io/docs/v2.1/en/installation/intro/) for details. - ### Deploy on Existing Kubernetes **Prerequisites** -> - `Kubernetes version`: `1.13.0 ≤ K8s version < 1.16`; -> - `Helm version`: `2.10.0 ≤ Helm ＜ 3.0.0`，(will support Helm v3 in KubeSphere v3.0) see [Install and Configure Helm in Kubernetes](https://devopscube.com/install-configure-helm-kubernetes/); -> - CPU > 1 Core，Memory > 2 G; -> - An existing Storage Class in your Kubernetes clusters, use `kubectl get sc` to verify it. +> - `Kubernetes version`： `1.15.x, 1.16.x, 1.17.x` +> - `Helm version` >= `2.10.0`，see [Install and Configure Helm in Kubernetes](https://devopscube.com/install-configure-helm-kubernetes/), (Helm v3 will be supported in KubeSphere 3.0.0) +> - An existing Storage Class in your Kubernetes cluster, use `kubectl get sc` to verify it +> - The CSR signing feature is activated in kube-apiserver, see [RKE installation issue](https://github.com/kubesphere/kubesphere/issues/1925#issuecomment-591698309). + +Install KubeSphere using kubectl. -Run the following command. When all Pods of KubeSphere are running, it means the installation is successsful. Then you can use `http://:30880` to access the dashboard with default account `admin/P@88w0rd`. +- If there are 1 Core and 2 GB RAM available in your cluster, use the command below to set up a default minimal installation only: -```yaml -$ kubectl apply -f https://raw.githubusercontent.com/kubesphere/ks-installer/master/kubesphere-minimal.yaml +```bash +kubectl apply -f https://raw.githubusercontent.com/kubesphere/ks-installer/master/kubesphere-minimal.yaml ``` +You can enable other components after installation, see [Pluggable components Installation](https://kubesphere.io/docs/v2.1/en/installation/pluggable-components/). + +- If there are 8 Cores and 16 GB RAM available in your cluster, use the command below to install a complete KubeSphere, i.e. with all components enabled: + +```bash +kubectl apply -f https://raw.githubusercontent.com/kubesphere/ks-installer/master/kubesphere-complete-setup.yaml +``` ### Deploy on Linux -KubeSphere Installer can help you to install KubeSphere and Kubernetes on your linux machines. It provides [All-in-One](https://kubesphere.com.cn/docs/v2.1/en/installation/all-in-one/) and [Multi-Node](https://kubesphere.com.cn/docs/v2.1/en/installation/multi-node/) installation options. +KubeSphere Installer can help you to install KubeSphere and Kubernetes on your linux machines. It provides [All-in-One](https://kubesphere.io/docs/v2.1/en/installation/all-in-one/) and [Multi-Node](https://kubesphere.io/docs/v2.1/en/installation/multi-node/) installation options. -**Prerequisites** +**Minimum Requirements** - Operating Systems - CentOS 7.5 (64 bit) @@ -119,44 +119,33 @@ KubeSphere Installer can help you to install KubeSphere and Kubernetes on your l - Hardware - CPU：2 Core, Memory：4 G, Disk Space：100 G -##### All-in-One - -For those who are new to KubeSphere and looking for the easiest way to install and experience the dashboard. Execute the following commands to download and install KubeSphere in a single node. +##### All-in-One (QuickStart) ```bash -$ curl -L https://kubesphere.io/download/stable/v2.1.0 > installer.tar.gz \ -&& tar -zxf installer.tar.gz && cd kubesphere-all-v2.1.0/scripts +curl -L https://kubesphere.io/download/stable/latest > installer.tar.gz \ +&& tar -zxf installer.tar.gz && cd kubesphere-all-v2.1.1/scripts $ ./install.sh ``` -Choose `"1) All-in-one"` to start the installation without changing any configuration. - -> Note: In a development or production environment, it's highly recommended to install Multi-Node KubeSphere. +Choose `"1) All-in-one"` to start the default minimal installation. +> Note: It's highly recommended to install [multi-node](https://kubesphere.io/docs/v2.1/en/installation/multi-node/) in production environment. -## To start using KubeSphere +You can enable other components after installation, see [Pluggable Components Installation](https://kubesphere.io/docs/v2.1/en/installation/pluggable-components/). -### Quick Start -KubeSphere provides 12 quick-start tutorials to walk you through the platform. - -- [Get Started - En](https://kubesphere.io/docs/v2.1/en/quick-start/admin-quick-start/) -- [Get Started - 中](https://kubesphere.io/docs/v2.1/zh-CN/quick-start/admin-quick-start/) - - -### Documentation +## To start using KubeSphere - KubeSphere Documentation ([En](https://kubesphere.io/docs/en/)/[中](https://kubesphere.io/docs/zh-CN/)） - [API Documentation](https://kubesphere.io/docs/v2.1/en/api-reference/api-docs/) - ## To start developing KubeSphere The [development guide](CONTRIBUTING.md) hosts all information about building KubeSphere from source, git workflow, how to contribute code and how to test. ## RoadMap -Currently, KubeSphere has released the following 4 major editions. The future releases will include Multicluster, Big data, AI, SDN, etc. See [Plans for 2.1.1 and 3.0.0](https://github.com/kubesphere/kubesphere/issues/1368) for more details. +Currently, KubeSphere has released the following 5 major editions. The future releases include multicluster, big data, AI, SDN, etc. See [Plans for 2.1.1 and 3.0.0](https://github.com/kubesphere/kubesphere/issues/1368) for more details. **Express Edition** => **v1.0.x** => **v2.0.x** => **v2.1.0** => **v2.1.1** => **v3.0.0** diff --git a/README_zh.md b/README_zh.md index d58d55c697..56ef30a445 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,7 +1,7 @@ -# KubeSphere +# KubeSphere 容器平台 [![License](http://img.shields.io/badge/license-apache%20v2-blue.svg)](https://github.com/KubeSphere/KubeSphere/blob/master/LICENSE) [![Build Status](https://travis-ci.org/kubesphere/kubesphere.svg?branch=master)](https://travis-ci.org/kubesphere/kubesphere) -[![KubeSphere release](https://img.shields.io/github/release/kubesphere/kubesphere.svg?color=release&label=release&logo=release&logoColor=release)](https://github.com/kubesphere/kubesphere/releases/tag/v2.1.0) +[![KubeSphere release](https://img.shields.io/github/release/kubesphere/kubesphere.svg?color=release&label=release&logo=release&logoColor=release)](https://github.com/kubesphere/kubesphere/releases/tag/v2.1.1) ![logo](docs/images/kubesphere-logo.png) @@ -20,7 +20,7 @@ KubeSphere 作为一个**全栈的容器平台**，不仅支持**安装和纳管 KubeSphere 可以运行在任何私有或托管的 Kubernetes、私有云、公有云、VM 或物理环境之上。已大规模服务于社区用户，广泛地应用在以容器为中心的开发测试及生产环境，大量服务平稳地运行在 KubeSphere 之上。 -> 说明：KubeSphere 目前最新的版本为 2.1.0，并且所有版本 100% 开源，关于 KubeSphere 更详细的介绍与说明请参阅 [什么是 KubeSphere](https://kubesphere.com.cn/docs/v2.1/zh-CN/introduction/intro/)。 +> 说明：KubeSphere 目前最新的版本为 2.1.1，并且所有版本 100% 开源，关于 KubeSphere 更详细的介绍与说明请参阅 [什么是 KubeSphere](https://kubesphere.com.cn/docs/v2.1/zh-CN/introduction/intro/)。 点击 [KubeSphere 快览](docs/en/guides/screenshots.md) 快速查看 KubeSphere UI； @@ -44,31 +44,28 @@ KubeSphere 可以运行在任何私有或托管的 Kubernetes、私有云、公 -## Video on Youtube +## 快速体验 -[![KubeSphere](https://pek3b.qingstor.com/kubesphere-docs/png/20191112093503.png)](https://youtu.be/u5lQvhi_Xlc) - -## 体验环境 - -使用体验账号 `demo1 / Demo123` 登录 [Demo 环境](https://demo.kubesphere.io/)，该账号仅授予了 viewer 权限，建议自行安装体验完整的管理功能。 +使用体验账号 `demo1 / Demo123` 登录 [Demo 环境](https://demo.kubesphere.io/)，该账号仅授予了 viewer 权限，建议自行安装体验完整的管理功能。您还可以访问 Youtube 查看 [KubeSphere Demo 视频](https://youtu.be/u5lQvhi_Xlc)。 ## 核心功能 -- Kubernetes 资源管理：纳管多种类型的 K8s 资源，提供易用友好的向导式 UI -- 应用编排与管理：包括**一键部署应用**、**Helm Chart 可视化管理**、**应用生命周期管理**，后续将支持计量计费 -- 微服务治理：基于 Istio 提供可视化无代码侵入的**灰度发布、熔断、流量管控、Tracing**，兼容**Spring Cloud & Dubbo** -- 一站式 DevOps：提供**可视化编辑 CI/CD 流水线**，包括从开发测试到持续部署上线的**全流程管理**，提供 [S2i](https://kubesphere.com.cn/docs/v2.1/zh-CN/quick-start/source-to-image/)、[B2i](https://kubesphere.io/docs/v2.1/zh-CN/quick-start/b2i-war/) -- 多租户管理：提供基于角色的细粒度 [多租户统一认证](https://kubesphere.io/docs/v2.1/zh-CN/multi-tenant/intro/)，支持**对接企业 LDAP/AD**，提供多层级的权限管理满足多组织架构的企业用户 -- 日志查询与收集：提供基于多租户和多维度的 [日志查询](https://kubesphere.io/docs/v2.1/zh-CN/toolbox/log-search/)，并支持快速对接多种日志收集平台 -- 多维度监控：提供集群与应用级别多项监控指标，提供按节点、企业空间、项目等资源用量的排行 -- 多租户告警系统：支持基于多租户、多维度的告警，提供丰富的监控告警指标，可自定义告警策略，支持邮件通知 -- 基础设施管理：提供主机管理、存储类型管理、CPU 与内存等资源配额管理 -- 支持多种网络方案：支持 Calico、Flannel，提供面向物理环境部署 Kubernetes 的 LoadBalancer 插件 [Porter](https://github.com/kubesphere/porter) 和云上[负载均衡器插件](https://github.com/yunify/qingcloud-cloud-controller-manager) -- 支持多种存储：支持 GlusterFS、CephRBD、NFS、LocalPV，支持 [企业级分布式存储 NeonSAN](https://www.qingcloud.com/products/qingstor-neonsan/) 和 [QingCloud 云平台块存储](https://docs.qingcloud.com/product/storage/volume/) -- 支持 GPU 节点，支持 [vGPU](https://github.com/virtaitech/orion) +|功能 |介绍 | +| --- | ---| +| Kubernetes 集群搭建与运维 | 支持在线 & 离线安装、升级与扩容 K8s 集群，支持安装 “云原生全家桶” | +| Kubernetes 资源可视化管理 | 可视化纳管原生 Kubernetes 资源，支持向导式创建与管理 K8s 资源 | +| 基于 Jenkins 的 DevOps 系统 | 支持图形化与脚本两种方式构建 CI/CD 流水线，内置 Source to Image（B2I）和 Binary to Image（B2I）等 CD 工具 | +| 应用商店与应用生命周期管理 | 提供应用商店，内置 Redis、MySQL 等九个常用应用，支持应用的生命周期管理 | +| 基于 Istio 的微服务治理 (Service Mesh) | 提供可视化无代码侵入的 **灰度发布、熔断、流量治理与流量拓扑、分布式 Tracing** | +| 多租户管理 | 提供基于角色的细粒度多租户统一认证，支持 **对接企业 LDAP/AD**，提供多层级的权限管理 | +| 丰富的可观察性功能 | 提供集群/工作负载/Pod/容器等多维度的监控，提供基于多租户的日志查询与日志收集，支持节点与应用层级的告警与通知 | +|基础设施管理|支持 Kubernetes 节点管理，支持节点扩容与集群升级，提供基于节点的多项监控指标与告警规则 | +| 存储管理 | 支持对接 Ceph、GlusterFS、NFS、Local PV，支持可视化管理 PVC、PV、StorageClass，提供 CSI 插件对接云平台存储 | +| 网络管理 | 支持 Calico、Flannel，提供 Porter LB 插件用于暴露物理环境 K8s 集群的 LoadBalancer 服务 | +| GPU support | 集群支持添加 GPU 与 vGPU，可运行 TensorFlow 等 ML 框架 | -> 更多详细的功能解读与说明，请查阅 [产品功能](https://kubesphere.io/docs/v2.1/zh-CN/introduction/features/)。 +> 以上功能说明详见 [产品功能](https://kubesphere.io/docs/v2.1/zh-CN/introduction/features/)。 ---- @@ -79,7 +76,7 @@ KubeSphere 采用了前后端分离的架构设计，后端的各个功能组件 ## 最新发布 -KubeSphere 2.1.0 已于 2019 年 11 月 12 日 正式发布，点击 [Release Notes For 2.1.0](https://kubesphere.io/docs/v2.1/zh-CN/release/release-v210/) 查看 2.1.0 版本的更新详情。 +KubeSphere 2.1.1 已于 2020 年 02 月 23 日 正式发布，点击 [Release Notes For 2.1.1](https://kubesphere.io/docs/v2.1/zh-CN/release/release-v211/) 查看 2.1.1 版本的更新详情。 ## 快速安装 @@ -95,59 +92,61 @@ KubeSphere 2.1.0 已于 2019 年 11 月 12 日 正式发布，点击 [Release No #### All-in-One -[All-in-One](https://kubesphere.io/docs/v2.1/zh-CN/installation/all-in-one/): 对于首次接触 KubeSphere 高级版的用户，想寻找一个最快安装和体验 KubeSphere 高级版核心功能的方式，All-in-one 模式支持一键安装 KubeSphere 至一台目标机器，建议使用干净的机器安装。 +执行以下命令下载 Installer，请关闭防火墙或 [开放指定的端口](https://kubesphere.com.cn/docs/v2.1/zh-CN/installation/port-firewall/)，建议使用干净的机器并使用 `root` 用户安装： ```bash -$ curl -L https://kubesphere.io/download/stable/v2.1.0 > installer.tar.gz \ -&& tar -zxf installer.tar.gz && cd kubesphere-all-v2.1.0/scripts -$ ./install.sh +curl -L https://kubesphere.io/download/stable/latest > installer.tar.gz \ +&& tar -zxf installer.tar.gz && cd kubesphere-all-v2.1.1/scripts + +./install.sh ``` -直接选择 `"1) All-in-one"` 即可开始快速安装。 +直接选择 `"1) All-in-one"` 即可开始快速安装。默认仅开启最小安装，请参考 [开启可插拔功能功能组件](https://kubesphere.com.cn/docs/v2.1/zh-CN/installation/pluggable-components/) 按需开启其它功能组件。 + +> 注意：All-in-One 仅适用于**测试环境**，**正式环境** 安装和使用请参考 [安装说明](https://kubesphere.com.cn/docs/v2.1/zh-CN/installation/intro/)。 -> 注意：All-in-One 仅适用于**测试体验**，**正式环境** 安装和使用请参考 [安装说明](https://kubesphere.io/docs/v2.1/zh-CN/installation/intro/#%E6%AD%A3%E5%BC%8F%E7%8E%AF%E5%A2%83%E5%AE%89%E8%A3%85)。 ### 部署在 Kubernetes -**前提条件** +可参考 [前提条件](https://kubesphere.io/docs/v2.1/zh-CN/installation/prerequisites/) 验证是否满足以下条件： + +> - `Kubernetes` 版本： `1.15.x、1.16.x、1.17.x`； +> - `Helm`版本： `2.10.0 ≤ Helm Version ＜ 3.0.0`（不支持 helm 2.16.0 [#6894](https://github.com/helm/helm/issues/6894)），且已安装了 Tiller，参考 [如何安装与配置 Helm](https://devopscube.com/install-configure-helm-kubernetes/) （预计 3.0 支持 Helm v3）； +> - 集群已有默认的存储类型（StorageClass），若还没有准备存储请参考 [安装 OpenEBS 创建 LocalPV 存储类型](../../appendix/install-openebs) 用作开发测试环境。 -> - `Kubernetes 版本` ： `1.13.0 ≤ K8s version < 1.16`； -> - `Helm 版本`: `2.10.0 ≤ Helm ＜ 3.0.0`，且已安装了 Tiller（预计 v3.0 支持 Helm v3）；参考 [如何安装与配置 Helm](https://devopscube.com/install-configure-helm-kubernetes/)； -> - 集群的可用 CPU > 1 C，可用内存 > 2 G；且集群能够访问外网 -> - 集群已有存储类型（StorageClass）； -可参考 [前提条件](https://kubesphere.io/docs/v2.1/zh-CN/installation/prerequisites/) 验证，若待安装的环境满足以上条件则可以开始部署 KubeSphere，当 KubeSphere 的所有 Pod 都为 RRunning 则说明安装成功。使用 `http://IP:30880` 访问 Dashboard，默认账号为 `admin/P@88w0rd`。 +- 若您的集群可用的资源符合 CPU > 1 Core，可用内存 > 2 G，可参考以下命令开启 KubeSphere 最小化安装： ```yaml -$ kubectl apply -f https://raw.githubusercontent.com/kubesphere/ks-installer/master/kubesphere-minimal.yaml +kubectl apply -f https://raw.githubusercontent.com/kubesphere/ks-installer/master/kubesphere-minimal.yaml ``` -注意，以上两种安装方式默认是 **最小化安装**，由于 2.1.0 已对大部分功能组件解耦，实现了功能组件的可插拔，因此可在 **安装完成后** 执行以下命令开启可插拔功能组件的安装，开启安装前确认您的机器资源已符合 [资源最低要求](https://kubesphere.io/docs/v2.1/zh-CN/installation/intro/#%E5%8F%AF%E6%8F%92%E6%8B%94%E5%8A%9F%E8%83%BD%E7%BB%84%E4%BB%B6%E5%88%97%E8%A1%A8)。 +请参考 [开启可插拔功能功能组件](https://kubesphere.com.cn/docs/v2.1/zh-CN/installation/pluggable-components/) 按需开启其它功能组件。 -``` -$ kubectl edit cm -n kubesphere-system ks-installer -``` +- 若您的集群可用的资源符合 CPU ≥ 8 Core，可用内存 ≥ 16 G，建议参考以下命令开启 KubeSphere 完整安装，即开启所有功能组件的安装： -## 开始使用 KubeSphere +```yaml +kubectl apply -f https://raw.githubusercontent.com/kubesphere/ks-installer/master/kubesphere-complete-setup.yaml +``` -### 快速入门 +查看滚动刷新的安装日志，请耐心等待安装成功。当看到 `"Successful"` 的日志与登录信息提示，则说明 KubeSphere 安装成功，请使用日志提示的管理员账号登陆控制台。 -[KubeSphere 快速入门](https://kubesphere.io/docs/v2.1/zh-CN/quick-start/quick-start-guide/) 通过 14 个 Step-by-Step 的快速入门的示例教程帮助您了解 KubeSphere 容器平台的基本使用流程，带您快速上手 KubeSphere。 +```bash +kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f +``` -### 文档 +## 开始使用 KubeSphere - [KubeSphere 文档中心 (En/中) ](https://kubesphere.io/docs/) - [API 文档](https://kubesphere.com.cn/docs/v2.1/zh-CN/api-reference/api-docs/) - ## 开发 KubeSphere [开发指南](CONTRIBUTING.md) 详细说明了如何从源码编译、KubeSphere 的 GitHub 工作流、如何贡献代码以及如何测试等。 - ## 路线图 -目前，KubeSphere 已发布了 4 个大版本和 3 个小版本，所有版本都是完全开源的，为 KubeSphere 社区用户提供服务。参考 [Plans for 2.1.1 and 3.0.0](https://github.com/kubesphere/kubesphere/issues/1368) 了解后续版本的规划。 +目前，KubeSphere 已发布了 4 个大版本和 4 个小版本，所有版本都是完全开源的，参考 [Plans for 2.1.1 and 3.0.0](https://github.com/kubesphere/kubesphere/issues/1368) 了解后续版本的规划，欢迎在 GitHub issue 中提交需求。 **Express Edition** => **v1.0.x** => **v2.0.x** => **v2.1.0** => **v2.1.1** => **v3.0.0** @@ -164,13 +163,17 @@ KubeSphere 是 CNCF 基金会成员并且通过了 diff --git a/docs/en/guides/Development-workflow.md b/docs/en/guides/Development-workflow.md index bf04d6d7cc..d545f6c47f 100644 --- a/docs/en/guides/Development-workflow.md +++ b/docs/en/guides/Development-workflow.md @@ -1,6 +1,6 @@ # Development Workflow -![ks-workflow](docs/images/ks-workflow.png) +![ks-workflow](/docs/images/ks-workflow.png) ## 1 Fork in the cloud @@ -107,4 +107,3 @@ $ git push -f ${your_remote_name} myfeature - Visit your fork at https://github.com/$user/kubesphere - Click the` Compare & Pull Request` button next to your myfeature branch. - Check out the [pull request process](pull-request.md) for more details and advice. -